Поделиться через


Домены Microsoft.EventGrid 2020-04-01-preview

Определение ресурсов Bicep

Тип ресурса доменов можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.EventGrid/domains, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.EventGrid/domains@2020-04-01-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'
      }
    ]
    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'
  }
  tags: {
    {customized property}: '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'
    }
  }
}

Значения свойств

Microsoft.EventGrid/домены

Имя Описание Ценность
тождество Сведения об удостоверениях ресурса. Идентификационная информация
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Свойства домена. Свойства домена
SKU Ценовая категория SKU для домена. РесурсSku
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

ConnectionState (Соединение)

Имя Описание Ценность
действияОбязательные Необходимые действия (если таковые есть). струна
описание Описание состояния подключения. струна
статус Состояние подключения. "Утверждено"
"Отключено"
"Ожидание"
"Отклонено"

Свойства домена

Имя Описание Ценность
inboundIpRules Это можно использовать для ограничения трафика с определенных IP-адресов вместо всех IP-адресов. Примечание. Они считаются только в том случае, если включена функция PublicNetworkAccess. Правило входящего IP-адреса[]
inputSchema Это определяет формат, который сетка событий должна ожидать для входящих событий, опубликованных в домене. "CloudEventSchemaV1_0"
CustomEventSchema
EventGridSchema
inputSchemaMapping Сведения о InputSchemaMapping, задается сведения о полезных данных события сопоставления. InputSchemaMapping (Ввод схемы)
privateEndpointConnections Список подключений к частной конечной точке. PrivateEndpointConnection[]
доступ к публичной сети Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.
Вы можете дополнительно ограничить определенные IP-адреса, настроив <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />
"Отключено"
"Включено"

Идентификационная информация

Имя Описание Ценность
идентификатор принципала Идентификатор субъекта удостоверения ресурса. струна
идентификатор арендатора Идентификатор клиента ресурса. струна
тип Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" удаляет любое удостоверение. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Это свойство в настоящее время не используется и зарезервировано для будущего использования.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Имя Описание Ценность

Правило входящего IP-адреса

Имя Описание Ценность
действие Действие для выполнения на основе совпадения или отсутствия соответствия IpMask. "Разрешить"
Маска ipMask IP-адрес в нотации CIDR, например 10.0.0.0/8. струна

InputSchemaMapping (Ввод схемы)

Имя Описание Ценность
inputSchemaMappingType Установите значение Json для типа JsonInputSchemaMapping. Json (обязательно)

ДжонФилд

Имя Описание Ценность
исходное поле Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. струна

JsonFieldWithDefault

Имя Описание Ценность
значение по умолчанию Значение по умолчанию, используемое для сопоставления, если sourceField не указан или нет свойства с указанным именем в опубликованной полезных данных события JSON. струна
исходное поле Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. струна

JsonInputSchemaMapping

Имя Описание Ценность
inputSchemaMappingType Тип настраиваемого сопоставления Json (обязательно)
свойства Свойства JSON для сопоставления входной схемы JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Имя Описание Ценность
версия данных Сведения о сопоставлении свойства DataVersion события сетки событий. JsonFieldWithDefault
время события Сведения о сопоставлении свойства EventTime события события сетки событий. ДжонФилд
Тип события Сведения о сопоставлении свойства EventType события сетки событий. JsonFieldWithDefault
идентификатор Сведения о сопоставлении свойства идентификатора события сетки событий. ДжонФилд
Тема Сведения о сопоставлении свойства Subject события сетки событий. JsonFieldWithDefault
тема Сведения о сопоставлении свойства "Раздел" события сетки событий. ДжонФилд

Частная конечная точка

Имя Описание Ценность
идентификатор Идентификатор ARM для частной конечной точки. струна

PrivateEndpointConnection

Имя Описание Ценность
свойства Свойства PrivateEndpointConnection. PrivateEndpointConnectionProperties (Свойства PrivateEndpointConnection)

PrivateEndpointConnectionProperties (Свойства PrivateEndpointConnection)

Имя Описание Ценность
идентификаторы групп GroupIds из ресурса службы приватного канала. строка[]
privateEndpoint Ресурс частной конечной точки для этого подключения. Частная конечная точка
privateLinkServiceConnectionState Сведения о состоянии подключения. ConnectionState (Соединение)
Состояние обеспечения Состояние подготовки подключения к частной конечной точке. "Отменено"
Создание
Удаление
"Не удалось"
"Успешно"
"Обновление"

РесурсSku

Имя Описание Ценность
имя Имя SKU ресурса. Возможные значения: "Базовый" или "Премиум". "Базовый"
"Премиум"

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Свойства UserIdentity

Имя Описание Ценность
clientId Идентификатор клиента назначаемого пользователем удостоверения. струна
идентификатор принципала Идентификатор субъекта назначаемого пользователем удостоверения. струна

Примеры использования

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Модуль Описание
домена сетки событий Модуль ресурсов AVM для домена сетки событий

Определение ресурса шаблона ARM

Тип ресурса доменов можно развернуть с помощью операций, предназначенных для следующих целей:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.EventGrid/domains, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.EventGrid/domains",
  "apiVersion": "2020-04-01-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"
      }
    ],
    "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"
  },
  "tags": {
    "{customized property}": "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"
    }
  }
}

Значения свойств

Microsoft.EventGrid/домены

Имя Описание Ценность
apiVersion Версия API «2020-04-01-превью»
тождество Сведения об удостоверениях ресурса. Идентификационная информация
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Свойства домена. Свойства домена
SKU Ценовая категория SKU для домена. РесурсSku
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.EventGrid/domains"

ConnectionState (Соединение)

Имя Описание Ценность
действияОбязательные Необходимые действия (если таковые есть). струна
описание Описание состояния подключения. струна
статус Состояние подключения. "Утверждено"
"Отключено"
"Ожидание"
"Отклонено"

Свойства домена

Имя Описание Ценность
inboundIpRules Это можно использовать для ограничения трафика с определенных IP-адресов вместо всех IP-адресов. Примечание. Они считаются только в том случае, если включена функция PublicNetworkAccess. Правило входящего IP-адреса[]
inputSchema Это определяет формат, который сетка событий должна ожидать для входящих событий, опубликованных в домене. "CloudEventSchemaV1_0"
CustomEventSchema
EventGridSchema
inputSchemaMapping Сведения о InputSchemaMapping, задается сведения о полезных данных события сопоставления. InputSchemaMapping (Ввод схемы)
privateEndpointConnections Список подключений к частной конечной точке. PrivateEndpointConnection[]
доступ к публичной сети Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.
Вы можете дополнительно ограничить определенные IP-адреса, настроив <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />
"Отключено"
"Включено"

Идентификационная информация

Имя Описание Ценность
идентификатор принципала Идентификатор субъекта удостоверения ресурса. струна
идентификатор арендатора Идентификатор клиента ресурса. струна
тип Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" удаляет любое удостоверение. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Это свойство в настоящее время не используется и зарезервировано для будущего использования.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Имя Описание Ценность

Правило входящего IP-адреса

Имя Описание Ценность
действие Действие для выполнения на основе совпадения или отсутствия соответствия IpMask. "Разрешить"
Маска ipMask IP-адрес в нотации CIDR, например 10.0.0.0/8. струна

InputSchemaMapping (Ввод схемы)

Имя Описание Ценность
inputSchemaMappingType Установите значение Json для типа JsonInputSchemaMapping. Json (обязательно)

ДжонФилд

Имя Описание Ценность
исходное поле Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. струна

JsonFieldWithDefault

Имя Описание Ценность
значение по умолчанию Значение по умолчанию, используемое для сопоставления, если sourceField не указан или нет свойства с указанным именем в опубликованной полезных данных события JSON. струна
исходное поле Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. струна

JsonInputSchemaMapping

Имя Описание Ценность
inputSchemaMappingType Тип настраиваемого сопоставления Json (обязательно)
свойства Свойства JSON для сопоставления входной схемы JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Имя Описание Ценность
версия данных Сведения о сопоставлении свойства DataVersion события сетки событий. JsonFieldWithDefault
время события Сведения о сопоставлении свойства EventTime события события сетки событий. ДжонФилд
Тип события Сведения о сопоставлении свойства EventType события сетки событий. JsonFieldWithDefault
идентификатор Сведения о сопоставлении свойства идентификатора события сетки событий. ДжонФилд
Тема Сведения о сопоставлении свойства Subject события сетки событий. JsonFieldWithDefault
тема Сведения о сопоставлении свойства "Раздел" события сетки событий. ДжонФилд

Частная конечная точка

Имя Описание Ценность
идентификатор Идентификатор ARM для частной конечной точки. струна

PrivateEndpointConnection

Имя Описание Ценность
свойства Свойства PrivateEndpointConnection. PrivateEndpointConnectionProperties (Свойства PrivateEndpointConnection)

PrivateEndpointConnectionProperties (Свойства PrivateEndpointConnection)

Имя Описание Ценность
идентификаторы групп GroupIds из ресурса службы приватного канала. строка[]
privateEndpoint Ресурс частной конечной точки для этого подключения. Частная конечная точка
privateLinkServiceConnectionState Сведения о состоянии подключения. ConnectionState (Соединение)
Состояние обеспечения Состояние подготовки подключения к частной конечной точке. "Отменено"
Создание
Удаление
"Не удалось"
"Успешно"
"Обновление"

РесурсSku

Имя Описание Ценность
имя Имя SKU ресурса. Возможные значения: "Базовый" или "Премиум". "Базовый"
"Премиум"

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Свойства UserIdentity

Имя Описание Ценность
clientId Идентификатор клиента назначаемого пользователем удостоверения. струна
идентификатор принципала Идентификатор субъекта назначаемого пользователем удостоверения. струна

Примеры использования

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса доменов можно развернуть с помощью операций, предназначенных для следующих целей:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.EventGrid/domains, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/domains@2020-04-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      inboundIpRules = [
        {
          action = "string"
          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"
    }
  }
}

Значения свойств

Microsoft.EventGrid/домены

Имя Описание Ценность
тождество Сведения об удостоверениях ресурса. Идентификационная информация
местоположение Расположение ресурса. строка (обязательно)
имя Имя ресурса строка (обязательно)
свойства Свойства домена. Свойства домена
SKU Ценовая категория SKU для домена. РесурсSku
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.EventGrid/domains@2020-04-01-preview"

ConnectionState (Соединение)

Имя Описание Ценность
действияОбязательные Необходимые действия (если таковые есть). струна
описание Описание состояния подключения. струна
статус Состояние подключения. "Утверждено"
"Отключено"
"Ожидание"
"Отклонено"

Свойства домена

Имя Описание Ценность
inboundIpRules Это можно использовать для ограничения трафика с определенных IP-адресов вместо всех IP-адресов. Примечание. Они считаются только в том случае, если включена функция PublicNetworkAccess. Правило входящего IP-адреса[]
inputSchema Это определяет формат, который сетка событий должна ожидать для входящих событий, опубликованных в домене. "CloudEventSchemaV1_0"
CustomEventSchema
EventGridSchema
inputSchemaMapping Сведения о InputSchemaMapping, задается сведения о полезных данных события сопоставления. InputSchemaMapping (Ввод схемы)
privateEndpointConnections Список подключений к частной конечной точке. PrivateEndpointConnection[]
доступ к публичной сети Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию она включена.
Вы можете дополнительно ограничить определенные IP-адреса, настроив <seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.DomainProperties.InboundIpRules" />
"Отключено"
"Включено"

Идентификационная информация

Имя Описание Ценность
идентификатор принципала Идентификатор субъекта удостоверения ресурса. струна
идентификатор арендатора Идентификатор клиента ресурса. струна
тип Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" удаляет любое удостоверение. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме:
'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.
Это свойство в настоящее время не используется и зарезервировано для будущего использования.
IdentityInfoUserAssignedIdentities

IdentityInfoUserAssignedIdentities

Имя Описание Ценность

Правило входящего IP-адреса

Имя Описание Ценность
действие Действие для выполнения на основе совпадения или отсутствия соответствия IpMask. "Разрешить"
Маска ipMask IP-адрес в нотации CIDR, например 10.0.0.0/8. струна

InputSchemaMapping (Ввод схемы)

Имя Описание Ценность
inputSchemaMappingType Установите значение Json для типа JsonInputSchemaMapping. Json (обязательно)

ДжонФилд

Имя Описание Ценность
исходное поле Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. струна

JsonFieldWithDefault

Имя Описание Ценность
значение по умолчанию Значение по умолчанию, используемое для сопоставления, если sourceField не указан или нет свойства с указанным именем в опубликованной полезных данных события JSON. струна
исходное поле Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. струна

JsonInputSchemaMapping

Имя Описание Ценность
inputSchemaMappingType Тип настраиваемого сопоставления Json (обязательно)
свойства Свойства JSON для сопоставления входной схемы JsonInputSchemaMappingProperties

JsonInputSchemaMappingProperties

Имя Описание Ценность
версия данных Сведения о сопоставлении свойства DataVersion события сетки событий. JsonFieldWithDefault
время события Сведения о сопоставлении свойства EventTime события события сетки событий. ДжонФилд
Тип события Сведения о сопоставлении свойства EventType события сетки событий. JsonFieldWithDefault
идентификатор Сведения о сопоставлении свойства идентификатора события сетки событий. ДжонФилд
Тема Сведения о сопоставлении свойства Subject события сетки событий. JsonFieldWithDefault
тема Сведения о сопоставлении свойства "Раздел" события сетки событий. ДжонФилд

Частная конечная точка

Имя Описание Ценность
идентификатор Идентификатор ARM для частной конечной точки. струна

PrivateEndpointConnection

Имя Описание Ценность
свойства Свойства PrivateEndpointConnection. PrivateEndpointConnectionProperties (Свойства PrivateEndpointConnection)

PrivateEndpointConnectionProperties (Свойства PrivateEndpointConnection)

Имя Описание Ценность
идентификаторы групп GroupIds из ресурса службы приватного канала. строка[]
privateEndpoint Ресурс частной конечной точки для этого подключения. Частная конечная точка
privateLinkServiceConnectionState Сведения о состоянии подключения. ConnectionState (Соединение)
Состояние обеспечения Состояние подготовки подключения к частной конечной точке. "Отменено"
Создание
Удаление
"Не удалось"
"Успешно"
"Обновление"

РесурсSku

Имя Описание Ценность
имя Имя SKU ресурса. Возможные значения: "Базовый" или "Премиум". "Базовый"
"Премиум"

Отслеживаемые Ресурсные Теги

Имя Описание Ценность

Свойства UserIdentity

Имя Описание Ценность
clientId Идентификатор клиента назначаемого пользователем удостоверения. струна
идентификатор принципала Идентификатор субъекта назначаемого пользователем удостоверения. струна