Разделы Microsoft.EventGrid 2021-12-01

• Актуальная
• 15.12.2023
• 2023-06-01-preview
• 2022-06-15
• 2021-12-01
• 15.10.2021
• 2021-06-01-preview
• 2020-10-15-preview
• 2020-06-01
• 2020-04-01-preview
• 01.01.2020
• 2019-06-01
• 01.02.2019
• 01.01.2019
• 15.09.2018
• 2018-05-01-preview
• 2018-01-01
• 15.09.2017
• 15.06.2017 г.

Определение ресурса Bicep

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

• Группы ресурсов — см. команды развертывания групп ресурсов.

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

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

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

resource symbolicname 'Microsoft.EventGrid/topics@2021-12-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    principalId: 'string'
    tenantId: 'string'
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  properties: {
    disableLocalAuth: bool
    inboundIpRules: [
      {
        action: 'Allow'
        ipMask: 'string'
      }
    ]
    inputSchema: 'string'
    inputSchemaMapping: {
      inputSchemaMappingType: 'string'
      // For remaining properties, see InputSchemaMapping objects
    }
    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'
    }
  }

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

topics

Имя	Описание	Значение
name	имя ресурса.	string (обязательно) Ограничение символов: 3-50 Допустимые символы: Буквенно-цифровые символы и дефисы.
location	Расположение ресурса.	string (обязательно)
tags	Теги ресурса.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
удостоверение	Сведения об удостоверениях ресурса.	IdentityInfo
properties	Свойства раздела.	Свойства раздела

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	Идентификатор субъекта удостоверения, назначаемого пользователем.	строка

Свойства раздела

Имя	Описание	Значение
disableLocalAuth	Это логическое значение используется для включения или отключения локальной проверки подлинности. Значение по умолчанию — false. Если свойству присвоено значение true, для проверки подлинности будет использоваться только маркер AAD, если пользователю разрешено публиковать в разделе.	bool
inboundIpRules	Его можно использовать для ограничения трафика с определенных IP-адресов, а не со всех IP-адресов. Примечание. Они учитываются только в том случае, если включена функция PublicNetworkAccess.	InboundIpRule[]
inputSchema	Это определяет формат, который сетка событий должна ожидать для входящих событий, опубликованных в разделе.	"CloudEventSchemaV1_0" CustomEventSchema EventGridSchema
inputSchemaMapping	Это позволяет публиковать с помощью пользовательских схем событий. InputSchemaMapping можно указать для сопоставления различных свойств исходной схемы с различными обязательными свойствами схемы EventGridEvent.	InputSchemaMapping
publicNetworkAccess	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Вы можете дополнительно ограничить определенные IP-адреса, настроив {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.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	Имя поля во входной схеме событий, которое будет использоваться в качестве источника сопоставления.	строка

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
Создание пользовательского раздела и подписки Сетка событий Azure	Создает Сетка событий Azure пользовательский раздел и подписку веб-перехватчика. Шаблон первоначально автор Джон Даусс.
Раздел или подписка пользовательского Сетка событий Azure с помощью CloudEvents	Создает пользовательский Сетка событий Azure раздел, подписку веб-перехватчика со схемой CloudEvents и приложение логики в качестве обработчика событий. Шаблон первоначально автор Джастин Йо.
Создание пользовательского раздела и обработчика концентратора событий Сетки событий	Создает Сетка событий Azure настраиваемый раздел и концентратор событий для обработки событий.
Создание Сетка событий Azure настраиваемой подписки на раздел и очередь	Создает Сетка событий Azure настраиваемый раздел и подписку очереди служебной шины. Шаблон, автор : Маркус Мейер.
Создание подписки Сетка событий Azure пользовательских разделов	Создает Сетка событий Azure пользовательский раздел и подписку на раздел служебной шины. Шаблон, автор : Маркус Мейер.

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

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

• Группы ресурсов — см. команды развертывания группы ресурсов.

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

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

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

{
  "type": "Microsoft.EventGrid/topics",
  "apiVersion": "2021-12-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "principalId": "string",
    "tenantId": "string",
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "properties": {
    "disableLocalAuth": "bool",
    "inboundIpRules": [
      {
        "action": "Allow",
        "ipMask": "string"
      }
    ],
    "inputSchema": "string",
    "inputSchemaMapping": {
      "inputSchemaMappingType": "string"
      // For remaining properties, see InputSchemaMapping objects
    },
    "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"
    }
  }

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

topics

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.EventGrid/topics
версия_API	Версия API ресурсов	'2021-12-01'
name	имя ресурса.	строка (обязательно) Ограничение символов: 3–50 Допустимые символы: Буквенно-цифровые символы и дефисы.
location	Расположение ресурса.	строка (обязательно)
tags	Теги ресурса.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
удостоверение	Сведения об удостоверениях для ресурса.	IdentityInfo
properties	Свойства раздела.	Свойства раздела

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	Идентификатор субъекта удостоверения, назначаемого пользователем.	строка

Свойства раздела

Имя	Описание	Значение
disableLocalAuth	Это логическое значение используется для включения или отключения локальной проверки подлинности. Значение по умолчанию — false. Если свойству присвоено значение true, для проверки подлинности будет использоваться только маркер AAD, если пользователю разрешено публиковать в разделе.	bool
inboundIpRules	Его можно использовать для ограничения трафика с определенных IP-адресов, а не со всех IP-адресов. Примечание. Они учитываются только в том случае, если включена функция PublicNetworkAccess.	InboundIpRule[]
inputSchema	Это определяет формат, который сетка событий должна ожидать для входящих событий, опубликованных в разделе.	"CloudEventSchemaV1_0" CustomEventSchema EventGridSchema
inputSchemaMapping	Это позволяет публиковать с помощью пользовательских схем событий. InputSchemaMapping можно указать для сопоставления различных свойств исходной схемы с различными обязательными свойствами схемы EventGridEvent.	InputSchemaMapping
publicNetworkAccess	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Вы можете дополнительно ограничить определенные IP-адреса, настроив {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.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	Имя поля во входной схеме событий, которое будет использоваться в качестве источника сопоставления.	строка

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон	Описание
Создание пользовательского раздела и подписки Сетка событий Azure	Создает Сетка событий Azure пользовательский раздел и подписку веб-перехватчика. Шаблон первоначально автор Джон Даусс.
Раздел или подписка пользовательского Сетка событий Azure с помощью CloudEvents	Создает пользовательский Сетка событий Azure раздел, подписку веб-перехватчика со схемой CloudEvents и приложение логики в качестве обработчика событий. Шаблон первоначально автор Джастин Йо.
Создание пользовательского раздела и обработчика концентратора событий Сетки событий	Создает Сетка событий Azure настраиваемый раздел и концентратор событий для обработки событий.
Создание Сетка событий Azure настраиваемой подписки на раздел и очередь	Создает Сетка событий Azure настраиваемый раздел и подписку очереди служебной шины. Шаблон, автор : Маркус Мейер.
Создание Сетка событий Azure настраиваемой подписки на раздел	Создает Сетка событий Azure настраиваемый раздел и подписку на раздел служебной шины. Шаблон, автор : Маркус Мейер.

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

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

• Группы ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/topics@2021-12-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      disableLocalAuth = bool
      inboundIpRules = [
        {
          action = "Allow"
          ipMask = "string"
        }
      ]
      inputSchema = "string"
      inputSchemaMapping = {
        inputSchemaMappingType = "string"
        // For remaining properties, see InputSchemaMapping objects
      }
      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"
    }
  }

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

topics

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.EventGrid/topics@2021-12-01"
name	имя ресурса.	string (обязательно) Ограничение символов: 3-50 Допустимые символы: Буквенно-цифровые символы и дефисы.
location	Расположение ресурса.	string (обязательно)
parent_id	Для развертывания в группе ресурсов используйте идентификатор этой группы ресурсов.	string (обязательно)
tags	Теги ресурса.	Словарь имен и значений тегов.
удостоверение	Сведения об удостоверениях ресурса.	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	Идентификатор субъекта удостоверения, назначаемого пользователем.	строка

Свойства раздела

Имя	Описание	Значение
disableLocalAuth	Этот логический код используется для включения или отключения локальной проверки подлинности. Значение по умолчанию — false. Если свойству присвоено значение true, для проверки подлинности будет использоваться только маркер AAD, если пользователю разрешено публиковать в разделе.	bool
inboundIpRules	Это можно использовать для ограничения трафика с определенных IP-адресов, а не со всех IP-адресов. Примечание. Они учитываются только в том случае, если включена функция PublicNetworkAccess.	InboundIpRule[]
inputSchema	Это определяет формат, который сетка событий должна ожидать для входящих событий, опубликованных в разделе.	"CloudEventSchemaV1_0" CustomEventSchema "EventGridSchema"
inputSchemaMapping	Это позволяет публиковать с помощью пользовательских схем событий. InputSchemaMapping можно указать для сопоставления различных свойств исходной схемы с различными обязательными свойствами схемы EventGridEvent.	InputSchemaMapping
publicNetworkAccess	Это определяет, разрешен ли трафик через общедоступную сеть. По умолчанию он включен. Вы можете дополнительно ограничить определенные IP-адреса, настроив {seealso cref="P:Microsoft.Azure.Events.ResourceProvider.Common.Contracts.TopicProperties.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	Имя поля в схеме входных событий, которое будет использоваться в качестве источника сопоставления.	строка