Домены 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'
}
}
}
Значения свойств
ConnectionState
Имя | Описание | Ценность |
---|---|---|
actionsRequired | Необходимые действия (если таковые есть). | струна |
описание | Описание состояния подключения. | струна |
статус | Состояние подключения. | "Утверждено" "Отключено" "Ожидание" "Отклонено" |
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" /> |
"Отключено" "Включено" |
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/domains
Имя | Описание | Ценность |
---|---|---|
тождество | Сведения об удостоверениях ресурса. | IdentityInfo |
местоположение | Расположение ресурса. | строка (обязательно) |
имя | Имя ресурса | строка (обязательно) |
свойства | Свойства домена. | DomainProperties |
SKU | Ценовая категория SKU для домена. | ResourceSku |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
PrivateEndpoint
Имя | Описание | Ценность |
---|---|---|
идентификатор | Идентификатор ARM для частной конечной точки. | струна |
PrivateEndpointConnection
Имя | Описание | Ценность |
---|---|---|
свойства | Свойства PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Имя | Описание | Ценность |
---|---|---|
groupIds | GroupIds из ресурса службы приватного канала. | string[] |
privateEndpoint | Ресурс частной конечной точки для этого подключения. | PrivateEndpoint |
privateLinkServiceConnectionState | Сведения о состоянии подключения. | ConnectionState |
provisioningState | Состояние подготовки подключения к частной конечной точке. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
ResourceSku
Имя | Описание | Ценность |
---|---|---|
имя | Имя SKU ресурса. Возможные значения: "Базовый" или "Премиум". | "Базовый" "Премиум" |
TrackedResourceTags
Имя | Описание | Ценность |
---|
UserIdentityProperties
Имя | Описание | Ценность |
---|---|---|
clientId | Идентификатор клиента назначаемого пользователем удостоверения. | струна |
principalId | Идентификатор субъекта назначаемого пользователем удостоверения. | струна |
Определение ресурса шаблона 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"
}
}
}
Значения свойств
ConnectionState
Имя | Описание | Ценность |
---|---|---|
actionsRequired | Необходимые действия (если таковые есть). | струна |
описание | Описание состояния подключения. | струна |
статус | Состояние подключения. | "Утверждено" "Отключено" "Ожидание" "Отклонено" |
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" /> |
"Отключено" "Включено" |
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/domains
Имя | Описание | Ценность |
---|---|---|
apiVersion | Версия API | '2020-04-01-preview' |
тождество | Сведения об удостоверениях ресурса. | IdentityInfo |
местоположение | Расположение ресурса. | строка (обязательно) |
имя | Имя ресурса | строка (обязательно) |
свойства | Свойства домена. | DomainProperties |
SKU | Ценовая категория SKU для домена. | ResourceSku |
Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
тип | Тип ресурса | "Microsoft.EventGrid/domains" |
PrivateEndpoint
Имя | Описание | Ценность |
---|---|---|
идентификатор | Идентификатор ARM для частной конечной точки. | струна |
PrivateEndpointConnection
Имя | Описание | Ценность |
---|---|---|
свойства | Свойства PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Имя | Описание | Ценность |
---|---|---|
groupIds | GroupIds из ресурса службы приватного канала. | string[] |
privateEndpoint | Ресурс частной конечной точки для этого подключения. | PrivateEndpoint |
privateLinkServiceConnectionState | Сведения о состоянии подключения. | ConnectionState |
provisioningState | Состояние подготовки подключения к частной конечной точке. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
ResourceSku
Имя | Описание | Ценность |
---|---|---|
имя | Имя SKU ресурса. Возможные значения: "Базовый" или "Премиум". | "Базовый" "Премиум" |
TrackedResourceTags
Имя | Описание | Ценность |
---|
UserIdentityProperties
Имя | Описание | Ценность |
---|---|---|
clientId | Идентификатор клиента назначаемого пользователем удостоверения. | струна |
principalId | Идентификатор субъекта назначаемого пользователем удостоверения. | струна |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса доменов можно развернуть с помощью операций, предназначенных для следующих целей:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.EventGrid/domains, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/domains@2020-04-01-preview"
name = "string"
identity = {
principalId = "string"
tenantId = "string"
type = "string"
userAssignedIdentities = {
{customized property} = {
clientId = "string"
principalId = "string"
}
}
}
location = "string"
sku = {
name = "string"
}
tags = {
{customized property} = "string"
}
body = jsonencode({
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"
}
})
}
Объекты 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"
}
}
}
Значения свойств
ConnectionState
Имя | Описание | Ценность |
---|---|---|
actionsRequired | Необходимые действия (если таковые есть). | струна |
описание | Описание состояния подключения. | струна |
статус | Состояние подключения. | "Утверждено" "Отключено" "Ожидание" "Отклонено" |
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" /> |
"Отключено" "Включено" |
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/domains
Имя | Описание | Ценность |
---|---|---|
тождество | Сведения об удостоверениях ресурса. | IdentityInfo |
местоположение | Расположение ресурса. | строка (обязательно) |
имя | Имя ресурса | строка (обязательно) |
свойства | Свойства домена. | DomainProperties |
SKU | Ценовая категория SKU для домена. | ResourceSku |
Теги | Теги ресурсов | Словарь имен и значений тегов. |
тип | Тип ресурса | "Microsoft.EventGrid/domains@2020-04-01-preview" |
PrivateEndpoint
Имя | Описание | Ценность |
---|---|---|
идентификатор | Идентификатор ARM для частной конечной точки. | струна |
PrivateEndpointConnection
Имя | Описание | Ценность |
---|---|---|
свойства | Свойства PrivateEndpointConnection. | PrivateEndpointConnectionProperties |
PrivateEndpointConnectionProperties
Имя | Описание | Ценность |
---|---|---|
groupIds | GroupIds из ресурса службы приватного канала. | string[] |
privateEndpoint | Ресурс частной конечной точки для этого подключения. | PrivateEndpoint |
privateLinkServiceConnectionState | Сведения о состоянии подключения. | ConnectionState |
provisioningState | Состояние подготовки подключения к частной конечной точке. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
ResourceSku
Имя | Описание | Ценность |
---|---|---|
имя | Имя SKU ресурса. Возможные значения: "Базовый" или "Премиум". | "Базовый" "Премиум" |
TrackedResourceTags
Имя | Описание | Ценность |
---|
UserIdentityProperties
Имя | Описание | Ценность |
---|---|---|
clientId | Идентификатор клиента назначаемого пользователем удостоверения. | струна |
principalId | Идентификатор субъекта назначаемого пользователем удостоверения. | струна |