Пространства имен Microsoft.EventGrid 2024-12-15-preview
Определение ресурсов Bicep
Тип ресурса пространств имен можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.EventGrid/namespaces, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.EventGrid/namespaces@2024-12-15-preview' = {
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
location: 'string'
name: 'string'
properties: {
inboundIpRules: [
{
action: 'string'
ipMask: 'string'
}
]
isZoneRedundant: bool
minimumTlsVersionAllowed: 'string'
privateEndpointConnections: [
{
properties: {
groupIds: [
'string'
]
privateEndpoint: {
id: 'string'
}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
provisioningState: 'string'
}
}
]
publicNetworkAccess: 'string'
topicsConfiguration: {
customDomains: [
{
certificateUrl: 'string'
expectedTxtRecordName: 'string'
expectedTxtRecordValue: 'string'
fullyQualifiedDomainName: 'string'
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
validationState: 'string'
}
]
}
topicSpacesConfiguration: {
clientAuthentication: {
alternativeAuthenticationNameSources: [
'string'
]
customJwtAuthentication: {
encodedIssuerCertificates: [
{
encodedCertificate: 'string'
kid: 'string'
}
]
issuerCertificates: [
{
certificateUrl: 'string'
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
]
tokenIssuer: 'string'
}
}
customDomains: [
{
certificateUrl: 'string'
expectedTxtRecordName: 'string'
expectedTxtRecordValue: 'string'
fullyQualifiedDomainName: 'string'
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
validationState: 'string'
}
]
maximumClientSessionsPerAuthenticationName: int
maximumSessionExpiryInHours: int
routeTopicResourceId: 'string'
routingEnrichments: {
dynamic: [
{
key: 'string'
value: 'string'
}
]
static: [
{
key: 'string'
valueType: 'string'
// For remaining properties, see StaticRoutingEnrichment objects
}
]
}
routingIdentityInfo: {
type: 'string'
userAssignedIdentity: 'string'
}
state: 'string'
}
}
sku: {
capacity: int
name: 'string'
}
tags: {
{customized property}: 'string'
}
}
Объекты StaticRoutingEnrichment
Задайте свойство valueType, чтобы указать тип объекта.
Для stringиспользуйте:
{
value: 'string'
valueType: 'String'
}
Значения свойств
ClientAuthenticationSettings
Имя | Описание | Ценность |
---|---|---|
alternativeAuthenticationNameSources | Альтернативные источники имен проверки подлинности, связанные с параметрами проверки подлинности клиента для ресурса пространства имен. | Массив строк, содержащий любой из: ClientCertificateDns ClientCertificateEmail ClientCertificateIp ClientCertificateSubject ClientCertificateUri |
customJwtAuthentication | Пользовательские параметры проверки подлинности JWT для ресурса пространства имен. | CustomJwtAuthenticationSettings |
ConnectionState
Имя | Описание | Ценность |
---|---|---|
actionsRequired | Необходимые действия (если таковые есть). | струна |
описание | Описание состояния подключения. | струна |
статус | Состояние подключения. | "Утверждено" "Отключено" "Ожидание" "Отклонено" |
CustomDomainConfiguration
Имя | Описание | Ценность |
---|---|---|
certificateUrl | URL-адрес сертификата, который используется для публикации в пользовательском домене. Сейчас мы поддерживаем сертификаты, хранящиеся только в Azure Key Vault. Хотя URL-адрес сертификата может быть либо URL-адрес версии следующего формата https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, или неверсивный URL-адрес следующего формата (например, https://contosovault.vault.azure.net/certificates/contosocert, мы поддерживаем только URL-адрес неверсированного сертификата (например, https://contosovault.vault.azure.net/certificates/contosocert) |
струна |
expectedTxtRecordName | Ожидаемое имя записи DNS TXT. Сетка событий проверяет наличие записи TXT с таким именем в наборе записей DNS личного домена, чтобы подтвердить владение доменом. Значения в этой записи TXT должны содержать ожидаемое значение записи TXT. |
струна |
expectedTxtRecordValue | Ожидаемое значение записи DNS TXT. Сетка событий проверяет наличие записи TXT с этим значением в наборе записей DNS личного домена, чтобы подтвердить владение доменом. | струна |
полностьюqualifiedDomainName | Полное доменное имя для личного домена. | строка (обязательно) |
тождество | Сведения об удостоверениях для доступа к сертификату для личного домена. Эти сведения об удостоверениях должны соответствовать идентификатору, заданному в пространстве имен. | CustomDomainIdentity |
validationState | Состояние проверки для личного домена. Это свойство только для чтения и изначально задано значение "Ожидание" и будет обновлено до "Утверждено" сеткой событий только после успешной проверки владения доменным именем. | "Утверждено" "ErrorRetrievingDnsRecord" "Ожидание" |
CustomDomainIdentity
Имя | Описание | Ценность |
---|---|---|
тип | Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. | SystemAssigned UserAssigned |
userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | струна |
CustomJwtAuthenticationManagedIdentity
Имя | Описание | Ценность |
---|---|---|
тип | Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. | SystemAssigned UserAssigned (обязательно) |
userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | струна |
CustomJwtAuthenticationSettings
Имя | Описание | Ценность |
---|---|---|
encodedIssuerCertificates | Сведения о закодированных общедоступных сертификатах, используемых для пользовательской проверки подлинности. | EncodedIssuerCertificateInfo[] |
issuerCertificates | Сведения о сертификатах, используемых для проверки маркеров. В настоящее время мы поддерживаем не более 2 сертификатов. | IssuerCertificateInfo[] |
tokenIssuer | Ожидаемый издатель токена JWT. | струна |
DynamicRoutingEnrichment
Имя | Описание | Ценность |
---|---|---|
ключ | Ключ динамического обогащения маршрутизации. | струна |
ценность | Значение динамического обогащения маршрутизации. | струна |
EncodedIssuerCertificateInfo
Имя | Описание | Ценность |
---|---|---|
encodedCertificate | Сертификат в формате pem. | строка (обязательно) |
козлёнок | Идентификатор сертификата. | строка (обязательно) |
IdentityInfo
Имя | Описание | Ценность |
---|---|---|
principalId | Идентификатор субъекта удостоверения ресурса. | струна |
tenantId | Идентификатор клиента ресурса. | струна |
тип | Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" удаляет любое удостоверение. | "Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned |
userAssignedIdentities | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Это свойство в настоящее время не используется и зарезервировано для будущего использования. |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
Имя | Описание | Ценность |
---|
InboundIpRule
Имя | Описание | Ценность |
---|---|---|
действие | Действие для выполнения на основе совпадения или отсутствия соответствия IpMask. | "Разрешить" |
ipMask | IP-адрес в нотации CIDR, например 10.0.0.0/8. | струна |
IssuerCertificateInfo
Имя | Описание | Ценность |
---|---|---|
certificateUrl | URL-адрес сертификата Keyvault в формате https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. | строка (обязательно) |
тождество | Удостоверение, которое будет использоваться для доступа к сертификату. | CustomJwtAuthenticationManagedIdentity |
Пространства имен Microsoft.EventGrid/namespaces
Имя | Описание | Ценность |
---|---|---|
тождество | Сведения об удостоверениях ресурса пространства имен. | IdentityInfo |
местоположение | Расположение ресурса. | строка (обязательно) |
имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 50 Pattern = ^[a-zA-Z0-9-]*$ (обязательно) |
свойства | Свойства ресурса пространства имен. | NamespaceProperties |
SKU | Представляет доступные ценовые категории SKU. | NamespaceSku |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
NamespaceProperties
Имя | Описание | Ценность |
---|---|---|
inboundIpRules | Это можно использовать для ограничения трафика с определенных IP-адресов вместо всех IP-адресов. Примечание. Они считаются только в том случае, если включена функция PublicNetworkAccess. | InboundIpRule[] |
isZoneRedundant | Это необязательное свойство, и пользователь может указать, поддерживает ли ресурс пространства имен возможность избыточности зоны или нет. Если это свойство не указано явным образом пользователем, его значение по умолчанию зависит от следующих условий: a. Для регионов с включенными зонами доступности — значение свойства по умолчанию будет иметь значение true. b. Для регионов с поддержкой зон доступности значение свойства по умолчанию будет false. После указания этого свойства нельзя обновить. |
bool |
minimumTlsVersionAllowed | Минимальная версия TLS издателя, разрешенная для публикации в этом пространстве имен. Поддерживается только TLS версии 1.2. | '1.0' '1.1' '1.2' |
privateEndpointConnections | Список подключений к частной конечной точке. | PrivateEndpointConnection[] |
publicNetworkAccess | Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена. Вы можете дополнительно ограничить определенные IP-адреса, настроив <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" /> |
"Отключено" "Включено" 'SecuredByPerimeter' |
темыConfiguration | Сведения о конфигурации тем для ресурса пространства имен | ТемыConfiguration |
topicSpacesConfiguration | Сведения о конфигурации пространства имен для ресурса пространства имен | TopicSpacesConfiguration |
NamespaceSku
Имя | Описание | Ценность |
---|---|---|
способность | Указывает количество единиц пропускной способности, определяющих емкость пространства имен. Значение свойства по умолчанию 1, который обозначает 1 единицу пропускной способности = 1 МБ/с входящего трафика и 2 МБ/с для каждого пространства имен. Минимальная емкость составляет 1 и Максимальная допустимая емкость составляет 20. |
int |
имя | Имя номера SKU. | "Стандартный" |
PrivateEndpoint
Имя | Описание | Ценность |
---|---|---|
идентификатор | Идентификатор ARM для частной конечной точки. | струна |
PrivateEndpointConnection
Имя | Описание | Ценность |
---|---|---|
свойства | Свойства PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Имя | Описание | Ценность |
---|---|---|
groupIds | GroupIds из ресурса службы приватного канала. | string[] |
privateEndpoint | Ресурс частной конечной точки для этого подключения. | PrivateEndpoint |
privateLinkServiceConnectionState | Сведения о состоянии подключения. | ConnectionState |
provisioningState | Состояние подготовки подключения к частной конечной точке. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
МаршрутизацияEnrichments
Имя | Описание | Ценность |
---|---|---|
динамический | DynamicRoutingEnrichment[] | |
статический | StaticRoutingEnrichment[] |
RoutingIdentityInfo
Имя | Описание | Ценность |
---|---|---|
тип | Тип удостоверения маршрутизации для конфигурации пространств разделов. | "Нет" SystemAssigned UserAssigned |
userAssignedIdentity | струна |
StaticRoutingEnrichment
Имя | Описание | Ценность |
---|---|---|
ключ | Ключ обогащения статической маршрутизации. | струна |
valueType | Задайте значение String для типа StaticStringRoutingEnrichment. | String (обязательно) |
StaticStringRoutingEnrichment
Имя | Описание | Ценность |
---|---|---|
ценность | Значение обогащения типа строки. | струна |
valueType | Тип значения обогащения статической маршрутизации. Например, это значение свойства может быть "String". | String (обязательно) |
ТемыConfiguration
Имя | Описание | Ценность |
---|---|---|
customDomains | Список конфигураций личного домена для пространства имен. | CustomDomainConfiguration[] |
TopicSpacesConfiguration
Имя | Описание | Ценность |
---|---|---|
clientAuthentication | Параметры проверки подлинности клиента для конфигурации пространств разделов. | ClientAuthenticationSettings |
customDomains | Список конфигураций личного домена для пространства имен. | CustomDomainConfiguration[] |
maximumClientSessionsPerAuthenticationName | Максимальное количество сеансов на имя проверки подлинности. Значение свойства по умолчанию равно 1. Минимально допустимое значение равно 1, а максимально допустимое значение — 100. |
int |
maximumSessionExpiryInHours | Максимальное истечение срока действия сеанса в часах. Значение свойства по умолчанию — 1 час. Минимально допустимое значение равно 1 часу, а максимально допустимое значение — 8 часов. |
int |
routeTopicResourceId | Полный идентификатор ресурса Azure для раздела сетки событий, в который будут направляться события из TopicSpaces в пространстве имен. Это свойство должно быть в следующем формате :/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topic/{topicName}'. Этот раздел должен находиться в том же регионе, где находится пространство имен. |
струна |
маршрутизацияEnrichments | Маршрутизация обогащений для конфигурации пространств разделов | МаршрутизацияEnrichments |
routingIdentityInfo | Сведения об удостоверениях маршрутизации для конфигурации пространств разделов. | RoutingIdentityInfo |
государство | Укажите, включена ли конфигурация topic Spaces для пространства имен. Значение по умолчанию — "Отключено". | "Отключено" "Включено" |
TrackedResourceTags
Имя | Описание | Ценность |
---|
UserIdentityProperties
Имя | Описание | Ценность |
---|---|---|
clientId | Идентификатор клиента назначаемого пользователем удостоверения. | струна |
principalId | Идентификатор субъекта назначаемого пользователем удостоверения. | струна |
Определение ресурса шаблона ARM
Тип ресурса пространств имен можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.EventGrid/namespaces, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.EventGrid/namespaces",
"apiVersion": "2024-12-15-preview",
"name": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"inboundIpRules": [
{
"action": "string",
"ipMask": "string"
}
],
"isZoneRedundant": "bool",
"minimumTlsVersionAllowed": "string",
"privateEndpointConnections": [
{
"properties": {
"groupIds": [ "string" ],
"privateEndpoint": {
"id": "string"
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
},
"provisioningState": "string"
}
}
],
"publicNetworkAccess": "string",
"topicsConfiguration": {
"customDomains": [
{
"certificateUrl": "string",
"expectedTxtRecordName": "string",
"expectedTxtRecordValue": "string",
"fullyQualifiedDomainName": "string",
"identity": {
"type": "string",
"userAssignedIdentity": "string"
},
"validationState": "string"
}
]
},
"topicSpacesConfiguration": {
"clientAuthentication": {
"alternativeAuthenticationNameSources": [ "string" ],
"customJwtAuthentication": {
"encodedIssuerCertificates": [
{
"encodedCertificate": "string",
"kid": "string"
}
],
"issuerCertificates": [
{
"certificateUrl": "string",
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
}
],
"tokenIssuer": "string"
}
},
"customDomains": [
{
"certificateUrl": "string",
"expectedTxtRecordName": "string",
"expectedTxtRecordValue": "string",
"fullyQualifiedDomainName": "string",
"identity": {
"type": "string",
"userAssignedIdentity": "string"
},
"validationState": "string"
}
],
"maximumClientSessionsPerAuthenticationName": "int",
"maximumSessionExpiryInHours": "int",
"routeTopicResourceId": "string",
"routingEnrichments": {
"dynamic": [
{
"key": "string",
"value": "string"
}
],
"static": [ {
"key": "string",
"valueType": "string"
// For remaining properties, see StaticRoutingEnrichment objects
} ]
},
"routingIdentityInfo": {
"type": "string",
"userAssignedIdentity": "string"
},
"state": "string"
}
},
"sku": {
"capacity": "int",
"name": "string"
},
"tags": {
"{customized property}": "string"
}
}
Объекты StaticRoutingEnrichment
Задайте свойство valueType, чтобы указать тип объекта.
Для stringиспользуйте:
{
"value": "string",
"valueType": "String"
}
Значения свойств
ClientAuthenticationSettings
Имя | Описание | Ценность |
---|---|---|
alternativeAuthenticationNameSources | Альтернативные источники имен проверки подлинности, связанные с параметрами проверки подлинности клиента для ресурса пространства имен. | Массив строк, содержащий любой из: ClientCertificateDns ClientCertificateEmail ClientCertificateIp ClientCertificateSubject ClientCertificateUri |
customJwtAuthentication | Пользовательские параметры проверки подлинности JWT для ресурса пространства имен. | CustomJwtAuthenticationSettings |
ConnectionState
Имя | Описание | Ценность |
---|---|---|
actionsRequired | Необходимые действия (если таковые есть). | струна |
описание | Описание состояния подключения. | струна |
статус | Состояние подключения. | "Утверждено" "Отключено" "Ожидание" "Отклонено" |
CustomDomainConfiguration
Имя | Описание | Ценность |
---|---|---|
certificateUrl | URL-адрес сертификата, который используется для публикации в пользовательском домене. Сейчас мы поддерживаем сертификаты, хранящиеся только в Azure Key Vault. Хотя URL-адрес сертификата может быть либо URL-адрес версии следующего формата https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, или неверсивный URL-адрес следующего формата (например, https://contosovault.vault.azure.net/certificates/contosocert, мы поддерживаем только URL-адрес неверсированного сертификата (например, https://contosovault.vault.azure.net/certificates/contosocert) |
струна |
expectedTxtRecordName | Ожидаемое имя записи DNS TXT. Сетка событий проверяет наличие записи TXT с таким именем в наборе записей DNS личного домена, чтобы подтвердить владение доменом. Значения в этой записи TXT должны содержать ожидаемое значение записи TXT. |
струна |
expectedTxtRecordValue | Ожидаемое значение записи DNS TXT. Сетка событий проверяет наличие записи TXT с этим значением в наборе записей DNS личного домена, чтобы подтвердить владение доменом. | струна |
полностьюqualifiedDomainName | Полное доменное имя для личного домена. | строка (обязательно) |
тождество | Сведения об удостоверениях для доступа к сертификату для личного домена. Эти сведения об удостоверениях должны соответствовать идентификатору, заданному в пространстве имен. | CustomDomainIdentity |
validationState | Состояние проверки для личного домена. Это свойство только для чтения и изначально задано значение "Ожидание" и будет обновлено до "Утверждено" сеткой событий только после успешной проверки владения доменным именем. | "Утверждено" "ErrorRetrievingDnsRecord" "Ожидание" |
CustomDomainIdentity
Имя | Описание | Ценность |
---|---|---|
тип | Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. | SystemAssigned UserAssigned |
userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | струна |
CustomJwtAuthenticationManagedIdentity
Имя | Описание | Ценность |
---|---|---|
тип | Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. | SystemAssigned UserAssigned (обязательно) |
userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | струна |
CustomJwtAuthenticationSettings
Имя | Описание | Ценность |
---|---|---|
encodedIssuerCertificates | Сведения о закодированных общедоступных сертификатах, используемых для пользовательской проверки подлинности. | EncodedIssuerCertificateInfo[] |
issuerCertificates | Сведения о сертификатах, используемых для проверки маркеров. В настоящее время мы поддерживаем не более 2 сертификатов. | IssuerCertificateInfo[] |
tokenIssuer | Ожидаемый издатель токена JWT. | струна |
DynamicRoutingEnrichment
Имя | Описание | Ценность |
---|---|---|
ключ | Ключ динамического обогащения маршрутизации. | струна |
ценность | Значение динамического обогащения маршрутизации. | струна |
EncodedIssuerCertificateInfo
Имя | Описание | Ценность |
---|---|---|
encodedCertificate | Сертификат в формате pem. | строка (обязательно) |
козлёнок | Идентификатор сертификата. | строка (обязательно) |
IdentityInfo
Имя | Описание | Ценность |
---|---|---|
principalId | Идентификатор субъекта удостоверения ресурса. | струна |
tenantId | Идентификатор клиента ресурса. | струна |
тип | Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" удаляет любое удостоверение. | "Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned |
userAssignedIdentities | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Это свойство в настоящее время не используется и зарезервировано для будущего использования. |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
Имя | Описание | Ценность |
---|
InboundIpRule
Имя | Описание | Ценность |
---|---|---|
действие | Действие для выполнения на основе совпадения или отсутствия соответствия IpMask. | "Разрешить" |
ipMask | IP-адрес в нотации CIDR, например 10.0.0.0/8. | струна |
IssuerCertificateInfo
Имя | Описание | Ценность |
---|---|---|
certificateUrl | URL-адрес сертификата Keyvault в формате https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. | строка (обязательно) |
тождество | Удостоверение, которое будет использоваться для доступа к сертификату. | CustomJwtAuthenticationManagedIdentity |
Пространства имен Microsoft.EventGrid/namespaces
Имя | Описание | Ценность |
---|---|---|
apiVersion | Версия API | '2024-12-15-preview' |
тождество | Сведения об удостоверениях ресурса пространства имен. | IdentityInfo |
местоположение | Расположение ресурса. | строка (обязательно) |
имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 50 Pattern = ^[a-zA-Z0-9-]*$ (обязательно) |
свойства | Свойства ресурса пространства имен. | NamespaceProperties |
SKU | Представляет доступные ценовые категории SKU. | NamespaceSku |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
тип | Тип ресурса | "Microsoft.EventGrid/namespaces" |
NamespaceProperties
Имя | Описание | Ценность |
---|---|---|
inboundIpRules | Это можно использовать для ограничения трафика с определенных IP-адресов вместо всех IP-адресов. Примечание. Они считаются только в том случае, если включена функция PublicNetworkAccess. | InboundIpRule[] |
isZoneRedundant | Это необязательное свойство, и пользователь может указать, поддерживает ли ресурс пространства имен возможность избыточности зоны или нет. Если это свойство не указано явным образом пользователем, его значение по умолчанию зависит от следующих условий: a. Для регионов с включенными зонами доступности — значение свойства по умолчанию будет иметь значение true. b. Для регионов с поддержкой зон доступности значение свойства по умолчанию будет false. После указания этого свойства нельзя обновить. |
bool |
minimumTlsVersionAllowed | Минимальная версия TLS издателя, разрешенная для публикации в этом пространстве имен. Поддерживается только TLS версии 1.2. | '1.0' '1.1' '1.2' |
privateEndpointConnections | Список подключений к частной конечной точке. | PrivateEndpointConnection[] |
publicNetworkAccess | Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена. Вы можете дополнительно ограничить определенные IP-адреса, настроив <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" /> |
"Отключено" "Включено" 'SecuredByPerimeter' |
темыConfiguration | Сведения о конфигурации тем для ресурса пространства имен | ТемыConfiguration |
topicSpacesConfiguration | Сведения о конфигурации пространства имен для ресурса пространства имен | TopicSpacesConfiguration |
NamespaceSku
Имя | Описание | Ценность |
---|---|---|
способность | Указывает количество единиц пропускной способности, определяющих емкость пространства имен. Значение свойства по умолчанию 1, который обозначает 1 единицу пропускной способности = 1 МБ/с входящего трафика и 2 МБ/с для каждого пространства имен. Минимальная емкость составляет 1 и Максимальная допустимая емкость составляет 20. |
int |
имя | Имя номера SKU. | "Стандартный" |
PrivateEndpoint
Имя | Описание | Ценность |
---|---|---|
идентификатор | Идентификатор ARM для частной конечной точки. | струна |
PrivateEndpointConnection
Имя | Описание | Ценность |
---|---|---|
свойства | Свойства PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Имя | Описание | Ценность |
---|---|---|
groupIds | GroupIds из ресурса службы приватного канала. | string[] |
privateEndpoint | Ресурс частной конечной точки для этого подключения. | PrivateEndpoint |
privateLinkServiceConnectionState | Сведения о состоянии подключения. | ConnectionState |
provisioningState | Состояние подготовки подключения к частной конечной точке. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
МаршрутизацияEnrichments
Имя | Описание | Ценность |
---|---|---|
динамический | DynamicRoutingEnrichment[] | |
статический | StaticRoutingEnrichment[] |
RoutingIdentityInfo
Имя | Описание | Ценность |
---|---|---|
тип | Тип удостоверения маршрутизации для конфигурации пространств разделов. | "Нет" SystemAssigned UserAssigned |
userAssignedIdentity | струна |
StaticRoutingEnrichment
Имя | Описание | Ценность |
---|---|---|
ключ | Ключ обогащения статической маршрутизации. | струна |
valueType | Задайте значение String для типа StaticStringRoutingEnrichment. | String (обязательно) |
StaticStringRoutingEnrichment
Имя | Описание | Ценность |
---|---|---|
ценность | Значение обогащения типа строки. | струна |
valueType | Тип значения обогащения статической маршрутизации. Например, это значение свойства может быть "String". | String (обязательно) |
ТемыConfiguration
Имя | Описание | Ценность |
---|---|---|
customDomains | Список конфигураций личного домена для пространства имен. | CustomDomainConfiguration[] |
TopicSpacesConfiguration
Имя | Описание | Ценность |
---|---|---|
clientAuthentication | Параметры проверки подлинности клиента для конфигурации пространств разделов. | ClientAuthenticationSettings |
customDomains | Список конфигураций личного домена для пространства имен. | CustomDomainConfiguration[] |
maximumClientSessionsPerAuthenticationName | Максимальное количество сеансов на имя проверки подлинности. Значение свойства по умолчанию равно 1. Минимально допустимое значение равно 1, а максимально допустимое значение — 100. |
int |
maximumSessionExpiryInHours | Максимальное истечение срока действия сеанса в часах. Значение свойства по умолчанию — 1 час. Минимально допустимое значение равно 1 часу, а максимально допустимое значение — 8 часов. |
int |
routeTopicResourceId | Полный идентификатор ресурса Azure для раздела сетки событий, в который будут направляться события из TopicSpaces в пространстве имен. Это свойство должно быть в следующем формате :/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topic/{topicName}'. Этот раздел должен находиться в том же регионе, где находится пространство имен. |
струна |
маршрутизацияEnrichments | Маршрутизация обогащений для конфигурации пространств разделов | МаршрутизацияEnrichments |
routingIdentityInfo | Сведения об удостоверениях маршрутизации для конфигурации пространств разделов. | RoutingIdentityInfo |
государство | Укажите, включена ли конфигурация topic Spaces для пространства имен. Значение по умолчанию — "Отключено". | "Отключено" "Включено" |
TrackedResourceTags
Имя | Описание | Ценность |
---|
UserIdentityProperties
Имя | Описание | Ценность |
---|---|---|
clientId | Идентификатор клиента назначаемого пользователем удостоверения. | струна |
principalId | Идентификатор субъекта назначаемого пользователем удостоверения. | струна |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса пространств имен можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.EventGrid/namespaces, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/namespaces@2024-12-15-preview"
name = "string"
identity = {
principalId = "string"
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
sku = {
capacity = int
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
inboundIpRules = [
{
action = "string"
ipMask = "string"
}
]
isZoneRedundant = bool
minimumTlsVersionAllowed = "string"
privateEndpointConnections = [
{
properties = {
groupIds = [
"string"
]
privateEndpoint = {
id = "string"
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
provisioningState = "string"
}
}
]
publicNetworkAccess = "string"
topicsConfiguration = {
customDomains = [
{
certificateUrl = "string"
expectedTxtRecordName = "string"
expectedTxtRecordValue = "string"
fullyQualifiedDomainName = "string"
identity = {
type = "string"
userAssignedIdentity = "string"
}
validationState = "string"
}
]
}
topicSpacesConfiguration = {
clientAuthentication = {
alternativeAuthenticationNameSources = [
"string"
]
customJwtAuthentication = {
encodedIssuerCertificates = [
{
encodedCertificate = "string"
kid = "string"
}
]
issuerCertificates = [
{
certificateUrl = "string"
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
]
tokenIssuer = "string"
}
}
customDomains = [
{
certificateUrl = "string"
expectedTxtRecordName = "string"
expectedTxtRecordValue = "string"
fullyQualifiedDomainName = "string"
identity = {
type = "string"
userAssignedIdentity = "string"
}
validationState = "string"
}
]
maximumClientSessionsPerAuthenticationName = int
maximumSessionExpiryInHours = int
routeTopicResourceId = "string"
routingEnrichments = {
dynamic = [
{
key = "string"
value = "string"
}
]
static = [
{
key = "string"
valueType = "string"
// For remaining properties, see StaticRoutingEnrichment objects
}
]
}
routingIdentityInfo = {
type = "string"
userAssignedIdentity = "string"
}
state = "string"
}
}
})
}
Объекты StaticRoutingEnrichment
Задайте свойство valueType, чтобы указать тип объекта.
Для stringиспользуйте:
{
value = "string"
valueType = "String"
}
Значения свойств
ClientAuthenticationSettings
Имя | Описание | Ценность |
---|---|---|
alternativeAuthenticationNameSources | Альтернативные источники имен проверки подлинности, связанные с параметрами проверки подлинности клиента для ресурса пространства имен. | Массив строк, содержащий любой из: ClientCertificateDns ClientCertificateEmail ClientCertificateIp ClientCertificateSubject ClientCertificateUri |
customJwtAuthentication | Пользовательские параметры проверки подлинности JWT для ресурса пространства имен. | CustomJwtAuthenticationSettings |
ConnectionState
Имя | Описание | Ценность |
---|---|---|
actionsRequired | Необходимые действия (если таковые есть). | струна |
описание | Описание состояния подключения. | струна |
статус | Состояние подключения. | "Утверждено" "Отключено" "Ожидание" "Отклонено" |
CustomDomainConfiguration
Имя | Описание | Ценность |
---|---|---|
certificateUrl | URL-адрес сертификата, который используется для публикации в пользовательском домене. Сейчас мы поддерживаем сертификаты, хранящиеся только в Azure Key Vault. Хотя URL-адрес сертификата может быть либо URL-адрес версии следующего формата https://{key-vault-name}.vault.azure.net/certificates/{certificate-name}/{version-id}, или неверсивный URL-адрес следующего формата (например, https://contosovault.vault.azure.net/certificates/contosocert, мы поддерживаем только URL-адрес неверсированного сертификата (например, https://contosovault.vault.azure.net/certificates/contosocert) |
струна |
expectedTxtRecordName | Ожидаемое имя записи DNS TXT. Сетка событий проверяет наличие записи TXT с таким именем в наборе записей DNS личного домена, чтобы подтвердить владение доменом. Значения в этой записи TXT должны содержать ожидаемое значение записи TXT. |
струна |
expectedTxtRecordValue | Ожидаемое значение записи DNS TXT. Сетка событий проверяет наличие записи TXT с этим значением в наборе записей DNS личного домена, чтобы подтвердить владение доменом. | струна |
полностьюqualifiedDomainName | Полное доменное имя для личного домена. | строка (обязательно) |
тождество | Сведения об удостоверениях для доступа к сертификату для личного домена. Эти сведения об удостоверениях должны соответствовать идентификатору, заданному в пространстве имен. | CustomDomainIdentity |
validationState | Состояние проверки для личного домена. Это свойство только для чтения и изначально задано значение "Ожидание" и будет обновлено до "Утверждено" сеткой событий только после успешной проверки владения доменным именем. | "Утверждено" "ErrorRetrievingDnsRecord" "Ожидание" |
CustomDomainIdentity
Имя | Описание | Ценность |
---|---|---|
тип | Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. | SystemAssigned UserAssigned |
userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | струна |
CustomJwtAuthenticationManagedIdentity
Имя | Описание | Ценность |
---|---|---|
тип | Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. | SystemAssigned UserAssigned (обязательно) |
userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | струна |
CustomJwtAuthenticationSettings
Имя | Описание | Ценность |
---|---|---|
encodedIssuerCertificates | Сведения о закодированных общедоступных сертификатах, используемых для пользовательской проверки подлинности. | EncodedIssuerCertificateInfo[] |
issuerCertificates | Сведения о сертификатах, используемых для проверки маркеров. В настоящее время мы поддерживаем не более 2 сертификатов. | IssuerCertificateInfo[] |
tokenIssuer | Ожидаемый издатель токена JWT. | струна |
DynamicRoutingEnrichment
Имя | Описание | Ценность |
---|---|---|
ключ | Ключ динамического обогащения маршрутизации. | струна |
ценность | Значение динамического обогащения маршрутизации. | струна |
EncodedIssuerCertificateInfo
Имя | Описание | Ценность |
---|---|---|
encodedCertificate | Сертификат в формате pem. | строка (обязательно) |
козлёнок | Идентификатор сертификата. | строка (обязательно) |
IdentityInfo
Имя | Описание | Ценность |
---|---|---|
principalId | Идентификатор субъекта удостоверения ресурса. | струна |
tenantId | Идентификатор клиента ресурса. | струна |
тип | Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" удаляет любое удостоверение. | "Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned |
userAssignedIdentities | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Это свойство в настоящее время не используется и зарезервировано для будущего использования. |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
Имя | Описание | Ценность |
---|
InboundIpRule
Имя | Описание | Ценность |
---|---|---|
действие | Действие для выполнения на основе совпадения или отсутствия соответствия IpMask. | "Разрешить" |
ipMask | IP-адрес в нотации CIDR, например 10.0.0.0/8. | струна |
IssuerCertificateInfo
Имя | Описание | Ценность |
---|---|---|
certificateUrl | URL-адрес сертификата Keyvault в формате https://keyvaultname.vault.azure.net/certificates/certificateName/certificateVersion. | строка (обязательно) |
тождество | Удостоверение, которое будет использоваться для доступа к сертификату. | CustomJwtAuthenticationManagedIdentity |
Пространства имен Microsoft.EventGrid/namespaces
Имя | Описание | Ценность |
---|---|---|
тождество | Сведения об удостоверениях ресурса пространства имен. | IdentityInfo |
местоположение | Расположение ресурса. | строка (обязательно) |
имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 3 Максимальная длина = 50 Pattern = ^[a-zA-Z0-9-]*$ (обязательно) |
свойства | Свойства ресурса пространства имен. | NamespaceProperties |
SKU | Представляет доступные ценовые категории SKU. | NamespaceSku |
Теги | Теги ресурсов | Словарь имен и значений тегов. |
тип | Тип ресурса | "Microsoft.EventGrid/namespaces@2024-12-15-preview" |
NamespaceProperties
Имя | Описание | Ценность |
---|---|---|
inboundIpRules | Это можно использовать для ограничения трафика с определенных IP-адресов вместо всех IP-адресов. Примечание. Они считаются только в том случае, если включена функция PublicNetworkAccess. | InboundIpRule[] |
isZoneRedundant | Это необязательное свойство, и пользователь может указать, поддерживает ли ресурс пространства имен возможность избыточности зоны или нет. Если это свойство не указано явным образом пользователем, его значение по умолчанию зависит от следующих условий: a. Для регионов с включенными зонами доступности — значение свойства по умолчанию будет иметь значение true. b. Для регионов с поддержкой зон доступности значение свойства по умолчанию будет false. После указания этого свойства нельзя обновить. |
bool |
minimumTlsVersionAllowed | Минимальная версия TLS издателя, разрешенная для публикации в этом пространстве имен. Поддерживается только TLS версии 1.2. | '1.0' '1.1' '1.2' |
privateEndpointConnections | Список подключений к частной конечной точке. | PrivateEndpointConnection[] |
publicNetworkAccess | Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена. Вы можете дополнительно ограничить определенные IP-адреса, настроив <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.PubSub.NamespaceProperties.InboundIpRules" /> |
"Отключено" "Включено" 'SecuredByPerimeter' |
темыConfiguration | Сведения о конфигурации тем для ресурса пространства имен | ТемыConfiguration |
topicSpacesConfiguration | Сведения о конфигурации пространства имен для ресурса пространства имен | TopicSpacesConfiguration |
NamespaceSku
Имя | Описание | Ценность |
---|---|---|
способность | Указывает количество единиц пропускной способности, определяющих емкость пространства имен. Значение свойства по умолчанию 1, который обозначает 1 единицу пропускной способности = 1 МБ/с входящего трафика и 2 МБ/с для каждого пространства имен. Минимальная емкость составляет 1 и Максимальная допустимая емкость составляет 20. |
int |
имя | Имя номера SKU. | "Стандартный" |
PrivateEndpoint
Имя | Описание | Ценность |
---|---|---|
идентификатор | Идентификатор ARM для частной конечной точки. | струна |
PrivateEndpointConnection
Имя | Описание | Ценность |
---|---|---|
свойства | Свойства PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Имя | Описание | Ценность |
---|---|---|
groupIds | GroupIds из ресурса службы приватного канала. | string[] |
privateEndpoint | Ресурс частной конечной точки для этого подключения. | PrivateEndpoint |
privateLinkServiceConnectionState | Сведения о состоянии подключения. | ConnectionState |
provisioningState | Состояние подготовки подключения к частной конечной точке. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
МаршрутизацияEnrichments
Имя | Описание | Ценность |
---|---|---|
динамический | DynamicRoutingEnrichment[] | |
статический | StaticRoutingEnrichment[] |
RoutingIdentityInfo
Имя | Описание | Ценность |
---|---|---|
тип | Тип удостоверения маршрутизации для конфигурации пространств разделов. | "Нет" SystemAssigned UserAssigned |
userAssignedIdentity | струна |
StaticRoutingEnrichment
Имя | Описание | Ценность |
---|---|---|
ключ | Ключ обогащения статической маршрутизации. | струна |
valueType | Задайте значение String для типа StaticStringRoutingEnrichment. | String (обязательно) |
StaticStringRoutingEnrichment
Имя | Описание | Ценность |
---|---|---|
ценность | Значение обогащения типа строки. | струна |
valueType | Тип значения обогащения статической маршрутизации. Например, это значение свойства может быть "String". | String (обязательно) |
ТемыConfiguration
Имя | Описание | Ценность |
---|---|---|
customDomains | Список конфигураций личного домена для пространства имен. | CustomDomainConfiguration[] |
TopicSpacesConfiguration
Имя | Описание | Ценность |
---|---|---|
clientAuthentication | Параметры проверки подлинности клиента для конфигурации пространств разделов. | ClientAuthenticationSettings |
customDomains | Список конфигураций личного домена для пространства имен. | CustomDomainConfiguration[] |
maximumClientSessionsPerAuthenticationName | Максимальное количество сеансов на имя проверки подлинности. Значение свойства по умолчанию равно 1. Минимально допустимое значение равно 1, а максимально допустимое значение — 100. |
int |
maximumSessionExpiryInHours | Максимальное истечение срока действия сеанса в часах. Значение свойства по умолчанию — 1 час. Минимально допустимое значение равно 1 часу, а максимально допустимое значение — 8 часов. |
int |
routeTopicResourceId | Полный идентификатор ресурса Azure для раздела сетки событий, в который будут направляться события из TopicSpaces в пространстве имен. Это свойство должно быть в следующем формате :/subscriptions/{subId}/resourcegroups/{resourceGroupName}/providers/microsoft. EventGrid/topic/{topicName}'. Этот раздел должен находиться в том же регионе, где находится пространство имен. |
струна |
маршрутизацияEnrichments | Маршрутизация обогащений для конфигурации пространств разделов | МаршрутизацияEnrichments |
routingIdentityInfo | Сведения об удостоверениях маршрутизации для конфигурации пространств разделов. | RoutingIdentityInfo |
государство | Укажите, включена ли конфигурация topic Spaces для пространства имен. Значение по умолчанию — "Отключено". | "Отключено" "Включено" |
TrackedResourceTags
Имя | Описание | Ценность |
---|
UserIdentityProperties
Имя | Описание | Ценность |
---|---|---|
clientId | Идентификатор клиента назначаемого пользователем удостоверения. | струна |
principalId | Идентификатор субъекта назначаемого пользователем удостоверения. | струна |