Разделы Microsoft.EventGrid 2021-12-01
- последние
- 2024-12-15-preview
- 2024-06-01-preview
- 2023-12-15-preview
- 2023-06-01-preview
- 2022-06-15
- 2021-12-01
- 2021-10-15-preview
- 2021-06-01-preview
- 2020-10-15-preview
- 2020-06-01
- 2020-04-01-preview
- 2020-01-01-preview
- 2019-06-01
- 2019-02-01-preview
- 2019-01-01
- 2018-09-15-preview
- 2018-05-01-preview
- 2018-01-01
- 2017-09-15-preview
- 2017-06-15-preview
Определение ресурсов Bicep
Тип ресурса тем можно развернуть с помощью операций, предназначенных для следующих целей:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.EventGrid/topics, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.EventGrid/topics@2021-12-01' = {
identity: {
principalId: 'string'
tenantId: 'string'
type: 'string'
userAssignedIdentities: {
{customized property}: {
clientId: 'string'
principalId: 'string'
}
}
}
location: 'string'
name: 'string'
properties: {
disableLocalAuth: bool
inboundIpRules: [
{
action: 'string'
ipMask: 'string'
}
]
inputSchema: 'string'
inputSchemaMapping: {
inputSchemaMappingType: 'string'
// For remaining properties, see InputSchemaMapping objects
}
publicNetworkAccess: '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'
}
}
}
Значения свойств
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. | струна |
InputSchemaMapping
| Имя | Описание | Ценность |
|---|---|---|
| inputSchemaMappingType | Установите значение Json для типа JsonInputSchemaMapping. | Json (обязательно) |
JsonField
| Имя | Описание | Ценность |
|---|---|---|
| sourceField | Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. | струна |
JsonFieldWithDefault
| Имя | Описание | Ценность |
|---|---|---|
| defaultValue | Значение по умолчанию, используемое для сопоставления, если sourceField не указан или нет свойства с указанным именем в опубликованной полезных данных события JSON. | струна |
| sourceField | Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. | струна |
JsonInputSchemaMapping
| Имя | Описание | Ценность |
|---|---|---|
| inputSchemaMappingType | Тип настраиваемого сопоставления | Json (обязательно) |
| свойства | Свойства JSON для сопоставления входной схемы | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
| Имя | Описание | Ценность |
|---|---|---|
| dataVersion | Сведения о сопоставлении свойства DataVersion события сетки событий. | JsonFieldWithDefault |
| eventTime | Сведения о сопоставлении свойства EventTime события события сетки событий. | JsonField |
| eventType | Сведения о сопоставлении свойства EventType события сетки событий. | JsonFieldWithDefault |
| идентификатор | Сведения о сопоставлении свойства идентификатора события сетки событий. | JsonField |
| Тема | Сведения о сопоставлении свойства Subject события сетки событий. | JsonFieldWithDefault |
| тема | Сведения о сопоставлении свойства "Раздел" события сетки событий. | JsonField |
Microsoft.EventGrid/темы
| Имя | Описание | Ценность |
|---|---|---|
| тождество | Сведения об удостоверениях ресурса. | IdentityInfo |
| местоположение | Расположение ресурса. | строка (обязательно) |
| имя | Имя ресурса | строка (обязательно) |
| свойства | Свойства раздела. | TopicProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
TopicProperties
| Имя | Описание | Ценность |
|---|---|---|
| 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" /> |
"Отключено" "Включено" |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
UserIdentityProperties
| Имя | Описание | Ценность |
|---|---|---|
| clientId | Идентификатор клиента назначаемого пользователем удостоверения. | струна |
| principalId | Идентификатор субъекта назначаемого пользователем удостоверения. | струна |
Примеры краткого руководства
Следующие примеры краткого руководства по развертыванию этого типа ресурса.
| Bicep-файл | Описание |
|---|---|
| создание настраиваемой темы сетки событий Azure и подписки на очередь | Создает настраиваемый раздел Сетки событий Azure и подписку очереди служебной шины. Шаблон первоначально создан Маркусом Мейером. |
| создание настраиваемого раздела и подписки в Сетк е событий Azure | Создает настраиваемый раздел Сетки событий Azure и подписку веб-перехватчика. Шаблон первоначально создан Джоном Дауном. |
Определение ресурса шаблона ARM
Тип ресурса тем можно развернуть с помощью операций, предназначенных для следующих целей:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.EventGrid/topics, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.EventGrid/topics",
"apiVersion": "2021-12-01",
"name": "string",
"identity": {
"principalId": "string",
"tenantId": "string",
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
"clientId": "string",
"principalId": "string"
}
}
},
"location": "string",
"properties": {
"disableLocalAuth": "bool",
"inboundIpRules": [
{
"action": "string",
"ipMask": "string"
}
],
"inputSchema": "string",
"inputSchemaMapping": {
"inputSchemaMappingType": "string"
// For remaining properties, see InputSchemaMapping objects
},
"publicNetworkAccess": "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"
}
}
}
Значения свойств
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. | струна |
InputSchemaMapping
| Имя | Описание | Ценность |
|---|---|---|
| inputSchemaMappingType | Установите значение Json для типа JsonInputSchemaMapping. | Json (обязательно) |
JsonField
| Имя | Описание | Ценность |
|---|---|---|
| sourceField | Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. | струна |
JsonFieldWithDefault
| Имя | Описание | Ценность |
|---|---|---|
| defaultValue | Значение по умолчанию, используемое для сопоставления, если sourceField не указан или нет свойства с указанным именем в опубликованной полезных данных события JSON. | струна |
| sourceField | Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. | струна |
JsonInputSchemaMapping
| Имя | Описание | Ценность |
|---|---|---|
| inputSchemaMappingType | Тип настраиваемого сопоставления | Json (обязательно) |
| свойства | Свойства JSON для сопоставления входной схемы | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
| Имя | Описание | Ценность |
|---|---|---|
| dataVersion | Сведения о сопоставлении свойства DataVersion события сетки событий. | JsonFieldWithDefault |
| eventTime | Сведения о сопоставлении свойства EventTime события события сетки событий. | JsonField |
| eventType | Сведения о сопоставлении свойства EventType события сетки событий. | JsonFieldWithDefault |
| идентификатор | Сведения о сопоставлении свойства идентификатора события сетки событий. | JsonField |
| Тема | Сведения о сопоставлении свойства Subject события сетки событий. | JsonFieldWithDefault |
| тема | Сведения о сопоставлении свойства "Раздел" события сетки событий. | JsonField |
Microsoft.EventGrid/темы
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2021-12-01' |
| тождество | Сведения об удостоверениях ресурса. | IdentityInfo |
| местоположение | Расположение ресурса. | строка (обязательно) |
| имя | Имя ресурса | строка (обязательно) |
| свойства | Свойства раздела. | TopicProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
| тип | Тип ресурса | "Microsoft.EventGrid/темы" |
TopicProperties
| Имя | Описание | Ценность |
|---|---|---|
| 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" /> |
"Отключено" "Включено" |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
UserIdentityProperties
| Имя | Описание | Ценность |
|---|---|---|
| clientId | Идентификатор клиента назначаемого пользователем удостоверения. | струна |
| principalId | Идентификатор субъекта назначаемого пользователем удостоверения. | струна |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
| Шаблон | Описание |
|---|---|
|
создание настраиваемой темы сетки событий Azure и подписки на очередь развертывание  |
Создает настраиваемый раздел Сетки событий Azure и подписку очереди служебной шины. Шаблон первоначально создан Маркусом Мейером. |
|
создание настраиваемого раздела и подписки в Сетк е событий Azure развертывание |
Создает настраиваемый раздел Сетки событий Azure и подписку веб-перехватчика. Шаблон первоначально создан Джоном Дауном. |
|
создание настраиваемой подписки сетки событий Azure развертывание |
Создает настраиваемый раздел Сетки событий Azure и подписку на раздел служебной шины. Шаблон первоначально создан Маркусом Мейером. |
|
Создание настраиваемого раздела сетки событий и обработчика концентратора событий развертывание |
Создает настраиваемый раздел сетки событий Azure и концентратор событий для обработки событий. |
|
настраиваемый раздел сетки событий Azure или подписка с CloudEvents развертывание |
Создает пользовательский раздел Сетки событий Azure, подписку веб-перехватчика с схемой CloudEvents и приложение логики в качестве обработчика событий. Шаблон первоначально создан ДжастинОм Yoo. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса тем можно развернуть с помощью операций, предназначенных для следующих целей:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.EventGrid/topics, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/topics@2021-12-01"
name = "string"
identity = {
principalId = "string"
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
disableLocalAuth = bool
inboundIpRules = [
{
action = "string"
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"
}
}
}
Значения свойств
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. | струна |
InputSchemaMapping
| Имя | Описание | Ценность |
|---|---|---|
| inputSchemaMappingType | Установите значение Json для типа JsonInputSchemaMapping. | Json (обязательно) |
JsonField
| Имя | Описание | Ценность |
|---|---|---|
| sourceField | Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. | струна |
JsonFieldWithDefault
| Имя | Описание | Ценность |
|---|---|---|
| defaultValue | Значение по умолчанию, используемое для сопоставления, если sourceField не указан или нет свойства с указанным именем в опубликованной полезных данных события JSON. | струна |
| sourceField | Имя поля в схеме входных событий, которая будет использоваться в качестве источника сопоставления. | струна |
JsonInputSchemaMapping
| Имя | Описание | Ценность |
|---|---|---|
| inputSchemaMappingType | Тип настраиваемого сопоставления | Json (обязательно) |
| свойства | Свойства JSON для сопоставления входной схемы | JsonInputSchemaMappingProperties |
JsonInputSchemaMappingProperties
| Имя | Описание | Ценность |
|---|---|---|
| dataVersion | Сведения о сопоставлении свойства DataVersion события сетки событий. | JsonFieldWithDefault |
| eventTime | Сведения о сопоставлении свойства EventTime события события сетки событий. | JsonField |
| eventType | Сведения о сопоставлении свойства EventType события сетки событий. | JsonFieldWithDefault |
| идентификатор | Сведения о сопоставлении свойства идентификатора события сетки событий. | JsonField |
| Тема | Сведения о сопоставлении свойства Subject события сетки событий. | JsonFieldWithDefault |
| тема | Сведения о сопоставлении свойства "Раздел" события сетки событий. | JsonField |
Microsoft.EventGrid/темы
| Имя | Описание | Ценность |
|---|---|---|
| тождество | Сведения об удостоверениях ресурса. | IdentityInfo |
| местоположение | Расположение ресурса. | строка (обязательно) |
| имя | Имя ресурса | строка (обязательно) |
| свойства | Свойства раздела. | TopicProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. |
| тип | Тип ресурса | "Microsoft.EventGrid/topics@2021-12-01" |
TopicProperties
| Имя | Описание | Ценность |
|---|---|---|
| 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" /> |
"Отключено" "Включено" |
TrackedResourceTags
| Имя | Описание | Ценность |
|---|
UserIdentityProperties
| Имя | Описание | Ценность |
|---|---|---|
| clientId | Идентификатор клиента назначаемого пользователем удостоверения. | струна |
| principalId | Идентификатор субъекта назначаемого пользователем удостоверения. | струна |