Домены Microsoft.EventGrid 2020-04-01-preview
Определение ресурса Bicep
Тип ресурса доменов можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.EventGrid/domains, добавьте в шаблон следующий код Bicep.
resource symbolicname 'Microsoft.EventGrid/domains@2020-04-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
sku: {
name: 'string'
}
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
properties: {
inboundIpRules: [
{
action: 'Allow'
ipMask: 'string'
}
]
inputSchema: 'string'
inputSchemaMapping: {
inputSchemaMappingType: 'string'
// For remaining properties, see InputSchemaMapping objects
}
privateEndpointConnections: [
{
properties: {
groupIds: [
'string'
]
privateEndpoint: {
id: 'string'
}
privateLinkServiceConnectionState: {
actionsRequired: 'string'
description: 'string'
status: 'string'
}
provisioningState: 'string'
}
}
]
publicNetworkAccess: 'string'
}
}
Объекты InputSchemaMapping
Задайте свойство inputSchemaMappingType , чтобы указать тип объекта .
Для Json используйте:
inputSchemaMappingType: 'Json'
properties: {
dataVersion: {
defaultValue: 'string'
sourceField: 'string'
}
eventTime: {
sourceField: 'string'
}
eventType: {
defaultValue: 'string'
sourceField: 'string'
}
id: {
sourceField: 'string'
}
subject: {
defaultValue: 'string'
sourceField: 'string'
}
topic: {
sourceField: 'string'
}
}
Значения свойств
domains
Имя | Описание | Значение |
---|---|---|
name | имя ресурса. | строка (обязательно) Ограничение символов: 3–50 Допустимые символы: Буквенно-цифровые символы и дефисы. |
location | Расположение ресурса. | строка (обязательно) |
tags | Теги ресурса. | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
sku | Ценовая категория SKU для домена. | ResourceSku |
удостоверение | Сведения об удостоверениях для ресурса. | IdentityInfo |
properties | Свойства домена. | DomainProperties |
IdentityInfo
Имя | Описание | Значение |
---|---|---|
principalId | Идентификатор субъекта удостоверения ресурса. | строка |
tenantId | Идентификатор клиента ресурса. | строка |
type | Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None приведет к удалению всех удостоверений. | "Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned |
userAssignedIdentities | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Это свойство в настоящее время не используется и зарезервировано для использования в будущем. |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
Имя | Описание | Значение |
---|---|---|
{настроенное свойство} | UserIdentityProperties |
UserIdentityProperties
Имя | Описание | Значение |
---|---|---|
clientid | Идентификатор клиента удостоверения, назначаемого пользователем. | строка |
principalId | Идентификатор субъекта удостоверения, назначаемого пользователем. | строка |
DomainProperties
Имя | Описание | Значение |
---|---|---|
inboundIpRules | Его можно использовать для ограничения трафика с определенных IP-адресов, а не со всех IP-адресов. Примечание. Они учитываются только в том случае, если включена функция PublicNetworkAccess. | InboundIpRule[] |
inputSchema | Это определяет формат, который сетка событий должна ожидать для входящих событий, опубликованных в домене. | 'CloudEventSchemaV1_0' CustomEventSchema EventGridSchema |
inputSchemaMapping | Сведения о InputSchemaMapping, в котором указаны сведения о полезных данных события сопоставления. | InputSchemaMapping |
privateEndpointConnections | Список подключений к частной конечной точке. | PrivateEndpointConnection[] |
publicNetworkAccess | Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Вы можете дополнительно ограничить определенные IP-адреса, настроив {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /} |
"Отключено" "Включено" |
InboundIpRule
Имя | Описание | Значение |
---|---|---|
action | Действие для выполнения на основе соответствия или отсутствия совпадения IpMask. | "Разрешить" |
ipMask | IP-адрес в нотации CIDR, например 10.0.0.0/8. | строка |
InputSchemaMapping
Имя | Описание | Значение |
---|---|---|
inputSchemaMappingType | Установка типа объекта | Json (обязательно) |
JsonInputSchemaMapping
Имя | Описание | Значение |
---|---|---|
inputSchemaMappingType | Тип настраиваемого сопоставления | "Json" (обязательно) |
properties | Свойства JSON для сопоставления входной схемы | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
Имя | Описание | Значение |
---|---|---|
dataVersion | Сведения о сопоставлении для свойства DataVersion события Сетки событий. | JsonFieldWithDefault |
eventTime | Сведения о сопоставлении для свойства EventTime события Сетки событий. | JsonField |
eventType | Сведения о сопоставлении для свойства EventType события Сетки событий. | JsonFieldWithDefault |
идентификатор | Сведения о сопоставлении для свойства Id события Сетки событий. | JsonField |
subject | Сведения о сопоставлении для свойства Subject события Сетки событий. | JsonFieldWithDefault |
Раздел | Сведения о сопоставлении для свойства Topic события Сетки событий. | JsonField |
JsonFieldWithDefault
Имя | Описание | Значение |
---|---|---|
defaultValue | Значение по умолчанию, используемое для сопоставления, если SourceField не предоставлен или если в полезных данных опубликованного события JSON нет свойства с указанным именем. | строка |
sourceField | Имя поля в схеме входных событий, которое будет использоваться в качестве источника сопоставления. | строка |
JsonField
Имя | Описание | Значение |
---|---|---|
sourceField | Имя поля в схеме входных событий, которое будет использоваться в качестве источника сопоставления. | строка |
PrivateEndpointConnection
Имя | Описание | Значение |
---|---|---|
properties | Свойства PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Имя | Описание | Значение |
---|---|---|
groupIds | GroupIds из ресурса службы приватного канала. | string[] |
privateEndpoint | Ресурс частной конечной точки для этого подключения. | PrivateEndpoint |
privateLinkServiceConnectionState | Сведения о состоянии подключения. | ConnectionState |
provisioningState | Состояние подготовки подключения к частной конечной точке. | "Отменено" "Создание" Удаление "Сбой" "Успешно" "Обновление" |
PrivateEndpoint
Имя | Описание | Значение |
---|---|---|
идентификатор | Идентификатор ARM для частной конечной точки. | строка |
ConnectionState
Имя | Описание | Значение |
---|---|---|
ActionsRequired | Требуются действия (если таковые есть). | строка |
description | Описание состояния подключения. | строка |
status | Состояние подключения. | "Утверждено" "Отключено" "Ожидание" 'Rejected' |
ResourceSku
Имя | Описание | Значение |
---|---|---|
name | Имя SKU ресурса. Возможные значения: Basic или Premium. | "Базовый" "Премиум" |
Определение ресурса шаблона ARM
Тип ресурса доменов можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.EventGrid/domains, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.EventGrid/domains",
"apiVersion": "2020-04-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"sku": {
"name": "string"
},
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"properties": {
"inboundIpRules": [
{
"action": "Allow",
"ipMask": "string"
}
],
"inputSchema": "string",
"inputSchemaMapping": {
"inputSchemaMappingType": "string"
// For remaining properties, see InputSchemaMapping objects
},
"privateEndpointConnections": [
{
"properties": {
"groupIds": [ "string" ],
"privateEndpoint": {
"id": "string"
},
"privateLinkServiceConnectionState": {
"actionsRequired": "string",
"description": "string",
"status": "string"
},
"provisioningState": "string"
}
}
],
"publicNetworkAccess": "string"
}
}
Объекты InputSchemaMapping
Задайте свойство inputSchemaMappingType , чтобы указать тип объекта .
Для Json используйте:
"inputSchemaMappingType": "Json",
"properties": {
"dataVersion": {
"defaultValue": "string",
"sourceField": "string"
},
"eventTime": {
"sourceField": "string"
},
"eventType": {
"defaultValue": "string",
"sourceField": "string"
},
"id": {
"sourceField": "string"
},
"subject": {
"defaultValue": "string",
"sourceField": "string"
},
"topic": {
"sourceField": "string"
}
}
Значения свойств
domains
Имя | Описание | Значение |
---|---|---|
тип | Тип ресурса | Microsoft.EventGrid/domains |
версия_API | Версия API ресурсов | '2020-04-01-preview' |
name | имя ресурса. | строка (обязательно) Ограничение символов: 3–50 Допустимые символы: Буквенно-цифровые символы и дефисы. |
location | Расположение ресурса. | строка (обязательно) |
tags | Теги ресурса. | Словарь имен и значений тегов. См . раздел Теги в шаблонах |
sku | Ценовая категория SKU для домена. | ResourceSku |
удостоверение | Сведения об удостоверениях для ресурса. | IdentityInfo |
properties | Свойства домена. | DomainProperties |
IdentityInfo
Имя | Описание | Значение |
---|---|---|
principalId | Идентификатор субъекта удостоверения ресурса. | строка |
tenantId | Идентификатор клиента ресурса. | строка |
type | Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None приведет к удалению всех удостоверений. | "Нет" SystemAssigned SystemAssigned, UserAssigned UserAssigned |
userAssignedIdentities | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Это свойство в настоящее время не используется и зарезервировано для использования в будущем. |
IdentityInfoUserAssignedIdentities |
IdentityInfoUserAssignedIdentities
Имя | Описание | Значение |
---|---|---|
{настроенное свойство} | UserIdentityProperties |
UserIdentityProperties
Имя | Описание | Значение |
---|---|---|
clientid | Идентификатор клиента удостоверения, назначаемого пользователем. | строка |
principalId | Идентификатор субъекта удостоверения, назначаемого пользователем. | строка |
DomainProperties
Имя | Описание | Значение |
---|---|---|
inboundIpRules | Его можно использовать для ограничения трафика с определенных IP-адресов, а не со всех IP-адресов. Примечание. Они учитываются только в том случае, если включена функция PublicNetworkAccess. | InboundIpRule[] |
inputSchema | Это определяет формат, который сетка событий должна ожидать для входящих событий, опубликованных в домене. | "CloudEventSchemaV1_0" CustomEventSchema EventGridSchema |
inputSchemaMapping | Сведения о InputSchemaMapping, в котором указаны сведения о полезных данных события сопоставления. | InputSchemaMapping |
privateEndpointConnections | Список подключений к частной конечной точке. | PrivateEndpointConnection[] |
publicNetworkAccess | Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Вы можете дополнительно ограничить определенные IP-адреса, настроив {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /} |
"Отключено" "Включено" |
InboundIpRule
Имя | Описание | Значение |
---|---|---|
action | Действие для выполнения на основе совпадения или отсутствия совпадения IpMask. | "Разрешить" |
ipMask | IP-адрес в нотации CIDR, например 10.0.0.0/8. | строка |
InputSchemaMapping
Имя | Описание | Значение |
---|---|---|
inputSchemaMappingType | Установка типа объекта | Json (обязательно) |
JsonInputSchemaMapping
Имя | Описание | Значение |
---|---|---|
inputSchemaMappingType | Тип настраиваемого сопоставления | Json (обязательно) |
properties | Свойства JSON для сопоставления входной схемы | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
Имя | Описание | Значение |
---|---|---|
dataVersion | Сведения о сопоставлении для свойства DataVersion события Сетки событий. | JsonFieldWithDefault |
eventTime | Сведения о сопоставлении для свойства EventTime события Сетки событий. | JsonField |
eventType | Сведения о сопоставлении для свойства EventType события Сетки событий. | JsonFieldWithDefault |
идентификатор | Сведения о сопоставлении для свойства Id события Сетки событий. | JsonField |
subject | Сведения о сопоставлении для свойства Subject события Сетки событий. | JsonFieldWithDefault |
Раздел | Сведения о сопоставлении для свойства Topic события Сетки событий. | JsonField |
JsonFieldWithDefault
Имя | Описание | Значение |
---|---|---|
defaultValue | Значение по умолчанию, используемое для сопоставления, если SourceField не предоставлен или если в полезных данных опубликованного события JSON нет свойства с указанным именем. | строка |
sourceField | Имя поля в схеме входных событий, которое будет использоваться в качестве источника сопоставления. | строка |
JsonField
Имя | Описание | Значение |
---|---|---|
sourceField | Имя поля в схеме входных событий, которое будет использоваться в качестве источника сопоставления. | строка |
PrivateEndpointConnection
Имя | Описание | Значение |
---|---|---|
properties | Свойства PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Имя | Описание | Значение |
---|---|---|
groupIds | GroupIds из ресурса службы приватного канала. | string[] |
privateEndpoint | Ресурс частной конечной точки для этого подключения. | PrivateEndpoint |
privateLinkServiceConnectionState | Сведения о состоянии подключения. | ConnectionState |
provisioningState | Состояние подготовки подключения к частной конечной точке. | "Отменено" "Создание" "Удаление" "Сбой" "Успешно" "Обновление" |
PrivateEndpoint
Имя | Описание | Значение |
---|---|---|
идентификатор | Идентификатор ARM для частной конечной точки. | строка |
ConnectionState
Имя | Описание | Значение |
---|---|---|
actionsRequired | Необходимые действия (если таковые есть). | строка |
description | Описание состояния подключения. | строка |
status | Состояние подключения. | "Утверждено" "Отключено" "Ожидание" 'Rejected' |
ResourceSku
Имя | Описание | Значение |
---|---|---|
name | Имя SKU ресурса. Возможные значения: Базовый или Премиум. | "Базовый" "Премиум" |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса доменов можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.EventGrid/domains, добавьте следующую terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/domains@2020-04-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
identity_ids = []
}
body = jsonencode({
properties = {
inboundIpRules = [
{
action = "Allow"
ipMask = "string"
}
]
inputSchema = "string"
inputSchemaMapping = {
inputSchemaMappingType = "string"
// For remaining properties, see InputSchemaMapping objects
}
privateEndpointConnections = [
{
properties = {
groupIds = [
"string"
]
privateEndpoint = {
id = "string"
}
privateLinkServiceConnectionState = {
actionsRequired = "string"
description = "string"
status = "string"
}
provisioningState = "string"
}
}
]
publicNetworkAccess = "string"
}
sku = {
name = "string"
}
})
}
Объекты InputSchemaMapping
Задайте свойство inputSchemaMappingType , чтобы указать тип объекта.
Для Json используйте:
inputSchemaMappingType = "Json"
properties = {
dataVersion = {
defaultValue = "string"
sourceField = "string"
}
eventTime = {
sourceField = "string"
}
eventType = {
defaultValue = "string"
sourceField = "string"
}
id = {
sourceField = "string"
}
subject = {
defaultValue = "string"
sourceField = "string"
}
topic = {
sourceField = "string"
}
}
Значения свойств
domains
Имя | Описание | Значение |
---|---|---|
тип | Тип ресурса | "Microsoft.EventGrid/domains@2020-04-01-preview" |
name | имя ресурса. | string (обязательно) Ограничение символов: 3-50 Допустимые символы: Буквенно-цифровые символы и дефисы. |
location | Расположение ресурса. | string (обязательно) |
parent_id | Для развертывания в группе ресурсов используйте идентификатор этой группы ресурсов. | string (обязательно) |
tags | Теги ресурса. | Словарь имен и значений тегов. |
sku | Ценовая категория SKU для домена. | ResourceSku |
удостоверение | Сведения об удостоверениях ресурса. | IdentityInfo |
properties | Свойства домена. | Свойства домена |
IdentityInfo
Имя | Описание | Значение |
---|---|---|
тип | Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор назначаемых пользователем удостоверений. Тип None приведет к удалению всех удостоверений. | "SystemAssigned" "SystemAssigned, UserAssigned" UserAssigned |
identity_ids | Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключи словаря удостоверений пользователей будут иметь идентификаторы ресурсов ARM в форме: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". Это свойство в настоящее время не используется и зарезервировано для использования в будущем. |
Массив идентификаторов удостоверений пользователей. |
IdentityInfoUserAssignedIdentities
Имя | Описание | Значение |
---|---|---|
{настраиваемое свойство} | UserIdentityProperties |
UserIdentityProperties
Имя | Описание | Значение |
---|---|---|
clientid | Идентификатор клиента удостоверения, назначаемого пользователем. | строка |
principalId | Идентификатор субъекта удостоверения, назначаемого пользователем. | строка |
Свойства домена
Имя | Описание | Значение |
---|---|---|
inboundIpRules | Это можно использовать для ограничения трафика с определенных IP-адресов, а не со всех IP-адресов. Примечание. Они учитываются только в том случае, если включена функция PublicNetworkAccess. | InboundIpRule[] |
inputSchema | Это определяет формат, который сетка событий должна ожидать для входящих событий, опубликованных в домене. | "CloudEventSchemaV1_0" CustomEventSchema "EventGridSchema" |
inputSchemaMapping | Сведения о InputSchemaMapping, в котором указаны сведения о полезных данных события сопоставления. | InputSchemaMapping |
privateEndpointConnections | Список подключений к частной конечной точке. | PrivateEndpointConnection[] |
publicNetworkAccess | Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Вы можете дополнительно ограничить определенные IP-адреса, настроив {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" /} |
"Отключено" "Включено" |
InboundIpRule
Имя | Описание | Значение |
---|---|---|
action | Действие для выполнения на основе соответствия или отсутствия совпадения IpMask. | "Разрешить" |
ipMask | IP-адрес в нотации CIDR, например 10.0.0.0/8. | строка |
InputSchemaMapping
Имя | Описание | Значение |
---|---|---|
inputSchemaMappingType | Установка типа объекта | Json (обязательно) |
JsonInputSchemaMapping
Имя | Описание | Значение |
---|---|---|
inputSchemaMappingType | Тип настраиваемого сопоставления | "Json" (обязательно) |
properties | Свойства JSON для сопоставления входной схемы | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
Имя | Описание | Значение |
---|---|---|
dataVersion | Сведения о сопоставлении для свойства DataVersion события Сетки событий. | JsonFieldWithDefault |
eventTime | Сведения о сопоставлении для свойства EventTime события Сетки событий. | JsonField |
eventType | Сведения о сопоставлении для свойства EventType события Сетки событий. | JsonFieldWithDefault |
идентификатор | Сведения о сопоставлении для свойства Id события Сетки событий. | JsonField |
subject | Сведения о сопоставлении для свойства Subject события Сетки событий. | JsonFieldWithDefault |
Раздел | Сведения о сопоставлении для свойства Topic события Сетки событий. | JsonField |
JsonFieldWithDefault
Имя | Описание | Значение |
---|---|---|
defaultValue | Значение по умолчанию, используемое для сопоставления, если SourceField не предоставлен или если в полезных данных опубликованного события JSON нет свойства с указанным именем. | строка |
sourceField | Имя поля в схеме входных событий, которое будет использоваться в качестве источника сопоставления. | строка |
JsonField
Имя | Описание | Значение |
---|---|---|
sourceField | Имя поля в схеме входных событий, которое будет использоваться в качестве источника сопоставления. | строка |
PrivateEndpointConnection
Имя | Описание | Значение |
---|---|---|
properties | Свойства PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Имя | Описание | Значение |
---|---|---|
groupIds | GroupIds из ресурса службы приватного канала. | string[] |
privateEndpoint | Ресурс частной конечной точки для этого подключения. | PrivateEndpoint |
privateLinkServiceConnectionState | Сведения о состоянии подключения. | ConnectionState |
provisioningState | Состояние подготовки подключения к частной конечной точке. | "Отменено" "Создание" "Удаление" "Сбой" "Выполнено" "Обновление" |
PrivateEndpoint
Имя | Описание | Значение |
---|---|---|
идентификатор | Идентификатор ARM для частной конечной точки. | строка |
ConnectionState
Имя | Описание | Значение |
---|---|---|
actionsRequired | Необходимые действия (если таковые есть). | строка |
description | Описание состояния подключения. | строка |
status | Состояние подключения. | "Утверждено" "Отключено" "Ожидание" "Отклонено" |
ResourceSku
Имя | Описание | Значение |
---|---|---|
name | Имя SKU ресурса. Возможные значения: Базовый или Премиум. | "Basic" "Премиум" |