Прочитать на английском

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


Microsoft.EventGrid domains/topics/eventSubscriptions 2021-10-15-preview

Выбор языка развертывания

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

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

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

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

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

resource symbolicname 'Microsoft.EventGrid/domains/topics/eventSubscriptions@2021-10-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    eventDeliverySchema: 'string'
    expirationTimeUtc: 'string'
    filter: {
      advancedFilters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see AdvancedFilter objects
        }
      ]
      enableAdvancedFilteringOnArrays: bool
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
    retryPolicy: {
      eventTimeToLiveInMinutes: int
      maxDeliveryAttempts: int
    }
  }
}

Объекты DeadLetterDestination

Задайте свойство endpointType , чтобы указать тип объекта .

Для StorageBlob используйте:

  endpointType: 'StorageBlob'
  properties: {
    blobContainerName: 'string'
    resourceId: 'string'
  }

Объекты EventSubscriptionDestination

Задайте свойство endpointType , чтобы указать тип объекта .

Для AzureFunction используйте:

  endpointType: 'AzureFunction'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }

Для EventHub используйте:

  endpointType: 'EventHub'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

Для HybridConnection используйте:

  endpointType: 'HybridConnection'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

Для PartnerDestination используйте:

  endpointType: 'PartnerDestination'
  properties: {
    resourceId: 'string'
  }

Для ServiceBusQueue используйте:

  endpointType: 'ServiceBusQueue'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

Для ServiceBusTopic используйте:

  endpointType: 'ServiceBusTopic'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }

Для StorageQueue используйте:

  endpointType: 'StorageQueue'
  properties: {
    queueMessageTimeToLiveInSeconds: int
    queueName: 'string'
    resourceId: 'string'
  }

Для веб-перехватчика используйте:

  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl: 'string'
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
  }

Объекты DeliveryAttributeMapping

Задайте свойство type , чтобы указать тип объекта .

Для dynamic используйте:

  type: 'Dynamic'
  properties: {
    sourceField: 'string'
  }

Для static используйте:

  type: 'Static'
  properties: {
    isSecret: bool
    value: 'string'
  }

Объекты AdvancedFilter

Задайте свойство operatorType , чтобы указать тип объекта .

Для BoolEquals используйте:

  operatorType: 'BoolEquals'
  value: bool

Для IsNotNull используйте:

  operatorType: 'IsNotNull'

Для Параметра IsNullOrUndefined используйте:

  operatorType: 'IsNullOrUndefined'

Для NumberGreaterThan используйте:

  operatorType: 'NumberGreaterThan'
  value: int

Для NumberGreaterThanOrEquals используйте:

  operatorType: 'NumberGreaterThanOrEquals'
  value: int

Для NumberIn используйте:

  operatorType: 'NumberIn'
  values: [
    int
  ]

Для NumberInRange используйте:

  operatorType: 'NumberInRange'
  values: [
    [
      int
    ]
  ]

Для NumberLessThan используйте:

  operatorType: 'NumberLessThan'
  value: int

Для NumberLessThanOrEquals используйте:

  operatorType: 'NumberLessThanOrEquals'
  value: int

Для NumberNotIn используйте:

  operatorType: 'NumberNotIn'
  values: [
    int
  ]

Для NumberNotInRange используйте:

  operatorType: 'NumberNotInRange'
  values: [
    [
      int
    ]
  ]

Для StringBeginsWith используйте:

  operatorType: 'StringBeginsWith'
  values: [
    'string'
  ]

Для StringContains используйте:

  operatorType: 'StringContains'
  values: [
    'string'
  ]

Для StringEndsWith используйте:

  operatorType: 'StringEndsWith'
  values: [
    'string'
  ]

Для StringIn используйте:

  operatorType: 'StringIn'
  values: [
    'string'
  ]

Для StringNotBeginsWith используйте:

  operatorType: 'StringNotBeginsWith'
  values: [
    'string'
  ]

Для StringNotContains используйте:

  operatorType: 'StringNotContains'
  values: [
    'string'
  ]

Для StringNotEndsWith используйте:

  operatorType: 'StringNotEndsWith'
  values: [
    'string'
  ]

Для StringNotIn используйте:

  operatorType: 'StringNotIn'
  values: [
    'string'
  ]

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

domains/topics/eventSubscriptions

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.
строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: темы
properties Свойства подписки на события. EventSubscriptionProperties

EventSubscriptionProperties

Имя Описание Значение
deadLetterDestination Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения , отправляется в место назначения недоставленных сообщений.
Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeadLetterDestination
deadLetterWithResourceIdentity Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения , отправляется в место назначения недоставленных сообщений.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Сведения о назначении, куда должны доставляться события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeliveryWithResourceIdentity
ресурс destination Сведения о назначении, куда должны доставляться события для подписки на события.
Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
EventSubscriptionDestination
eventDeliverySchema Схема доставки событий для подписки на события. "CloudEventSchemaV1_0"
CustomInputSchema
EventGridSchema
expirationTimeUtc Срок действия подписки на события. строка
фильтр Сведения о фильтре для подписки на события. EventSubscriptionFilter
метки; Список пользовательских меток. string[]
retryPolicy Политика повтора для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. RetryPolicy

DeadLetterDestination

Имя Описание Значение
endpointType Установка типа объекта StorageBlob (обязательно)

StorageBlobDeadLetterDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения недоставленных сообщений StorageBlob (обязательно)
properties Свойства назначения недоставки на основе BLOB-объектов хранилища StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Имя Описание Значение
blobContainerName Имя контейнера BLOB-объектов хранилища, который является местом назначения событий недоставки. строка
resourceId Идентификатор ресурса Azure учетной записи хранения, которая является местом назначения событий недоставки строка

DeadLetterWithResourceIdentity

Имя Описание Значение
deadLetterDestination Сведения о назначении, куда должны быть доставлены события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки сообщений.
DeadLetterDestination
удостоверение Удостоверение, используемое при недоставленных событиях. EventSubscriptionIdentity

EventSubscriptionIdentity

Имя Описание Значение
тип Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор назначаемых пользователем удостоверений. Тип None приведет к удалению всех удостоверений. SystemAssigned
UserAssigned
userAssignedIdentity Удостоверение пользователя, связанное с ресурсом. строка

DeliveryWithResourceIdentity

Имя Описание Значение
ресурс destination Сведения о назначении, куда должны быть доставлены события для подписки на события.
Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
EventSubscriptionDestination
удостоверение Удостоверение, используемое при доставке событий. EventSubscriptionIdentity

EventSubscriptionDestination

Имя Описание Значение
endpointType Установка типа объекта AzureFunction
EventHub
HybridConnection
PartnerDestination
ServiceBusQueue
ServiceBusTopic
StorageQueue
Веб-перехватчик (обязательно)

AzureFunctionEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. AzureFunction (обязательно)
properties Свойства функции Azure назначения подписки на события. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
maxEventsPerBatch Максимальное количество событий на пакет. INT
preferredBatchSizeInKilobytes Предпочтительный размер пакета в килобайтах. INT
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на события. строка

DeliveryAttributeMapping

Имя Описание Значение
name Имя атрибута или заголовка доставки. строка
type Установка типа объекта динамически;
Static (обязательно)

DynamicDeliveryAttributeMapping

Имя Описание Значение
тип Тип атрибута доставки или имени заголовка. Dynamic (обязательно)
properties Свойства сопоставления атрибутов динамической доставки. DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

Имя Описание Значение
sourceField Путь JSON в событии, которое содержит значение атрибута. строка

StaticDeliveryAttributeMapping

Имя Описание Значение
тип Тип атрибута доставки или имени заголовка. Static (обязательный)
properties Свойства сопоставления атрибутов статической доставки. StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

Имя Описание Значение
isSecret Логический флаг, который указывает, содержит ли атрибут конфиденциальную информацию. bool
значение Значение атрибута доставки. строка

EventHubEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. EventHub (обязательно)
properties Свойства концентратора событий назначения подписки на события. EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения концентратора событий подписки на события. строка

HybridConnectionEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. HybridConnection (обязательно)
properties Свойства гибридного подключения назначения подписки на события. HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. строка

PartnerEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. PartnerDestination (обязательно)
properties Назначение партнера. Свойства назначения подписки на события. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Имя Описание Значение
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения партнера подписки на события. строка

ServiceBusQueueEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. ServiceBusQueue (обязательно)
properties Свойства служебной шины назначения подписки на события. ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения служебной шины подписки на события. строка

ServiceBusTopicEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. ServiceBusTopic (обязательно)
properties Свойства раздела служебной шины назначения подписки на события. ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения раздела служебной шины подписки на события. строка

StorageQueueEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. StorageQueue (обязательно)
properties Свойства очереди хранилища назначения подписки на события. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Имя Описание Значение
queueMessageTimeToLiveInSeconds Время жизни сообщения очереди хранилища в секундах. INT
queueName Имя очереди хранилища в учетной записи хранения, которая является местом назначения подписки на события. строка
resourceId Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является местом назначения подписки на события. строка

WebHookEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. WebHook (обязательно)
properties Свойства веб-перехватчика назначения подписки на события. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Имя Описание Значение
azureActiveDirectoryApplicationIdOrUri Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в запросы на доставку в качестве маркера носителя. строка
azureActiveDirectoryTenantId Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в запросы на доставку в качестве маркера носителя. строка
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
endpointUrl URL-адрес, представляющий конечную точку назначения подписки на события. строка

Ограничения:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
maxEventsPerBatch Максимальное число событий в пакете. INT
preferredBatchSizeInKilobytes Предпочтительный размер пакета в килобайтах. INT

EventSubscriptionFilter

Имя Описание Значение
advancedFilters Массив расширенных фильтров, используемых для фильтрации подписок на события. AdvancedFilter[]
enableAdvancedFilteringOnArrays Позволяет вычислять расширенные фильтры по массиву значений, а не ожидать единственного значения. bool
includedEventTypes Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий по умолчанию, присвойте параметру IncludedEventTypes значение NULL. string[]
isSubjectCaseSensitive Указывает, если свойства SubjectBeginsWith и SubjectEndsWith фильтра
следует сравнивать с учетом регистра.
bool
subjectBeginsWith Необязательная строка для фильтрации событий для подписки на события на основе префикса пути к ресурсу.
Формат зависит от издателя событий.
Подстановочные знаки не поддерживаются в этом пути.
строка
subjectEndsWith Необязательная строка для фильтрации событий для подписки на события на основе суффикса пути к ресурсу.
Подстановочные знаки не поддерживаются в этом пути.
строка

AdvancedFilter

Имя Описание Значение
key Поле или свойство в событии, по которому требуется отфильтровать. строка
operatorType Установка типа объекта BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan;
NumberGreaterThanOrEquals;
NumberIn;
NumberInRange
NumberLessThan;
NumberGreaterThanOrEquals;
NumberNotIn.
NumberNotInRange
StringBeginsWith;
StringContains;
StringEndsWith;
StringIn;
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (обязательно)

BoolEqualsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. BoolEquals (обязательно)
значение Значение логического фильтра. bool

IsNotNullAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. IsNotNull (обязательно)

IsNullOrUndefinedAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. IsNullOrUndefined (обязательно)

NumberGreaterThanAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberGreaterThan (обязательно)
значение Значение фильтра. INT

NumberGreaterThanOrEqualsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberGreaterThanOrEquals (обязательно)
значение Значение фильтра. INT

NumberInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberIn" (обязательно)
значения Набор значений фильтра. int[]

NumberInRangeAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberInRange (обязательно)
значения Набор значений фильтра. int[][]

NumberLessThanAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberLessThan (обязательно)
значение Значение фильтра. INT

NumberLessThanOrEqualsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberLessThanOrEquals (обязательно)
значение Значение фильтра. INT

NumberNotInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberNotIn (обязательно)
значения Набор значений фильтра. int[]

NumberNotInRangeAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberNotInRange (обязательно)
значения Набор значений фильтра. int[][]

StringBeginsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringBeginsWith (обязательно)
значения Набор значений фильтра. string[]

StringContainsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringContains (обязательно)
значения Набор значений фильтра. string[]

StringEndsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringEndsWith (обязательно)
значения Набор значений фильтра. string[]

StringInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringIn (обязательно)
значения Набор значений фильтра. string[]

StringNotBeginsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotBeginsWith (обязательно)
значения Набор значений фильтра. string[]

StringNotContainsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotContains (обязательно)
значения Набор значений фильтра. string[]

StringNotEndsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotEndsWith (обязательно)
значения Набор значений фильтра. string[]

StringNotInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotIn (обязательно)
значения Набор значений фильтра. string[]

политика RetryPolicy

Имя Описание Значение
eventTimeToLiveInMinutes Время жизни (в минутах) для событий. INT
maxDeliveryAttempts Максимальное число повторных попыток доставки для событий. INT

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

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

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

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

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

{
  "type": "Microsoft.EventGrid/domains/topics/eventSubscriptions",
  "apiVersion": "2021-10-15-preview",
  "name": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "deadLetterWithResourceIdentity": {
      "deadLetterDestination": {
        "endpointType": "string"
        // For remaining properties, see DeadLetterDestination objects
      },
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "deliveryWithResourceIdentity": {
      "destination": {
        "endpointType": "string"
        // For remaining properties, see EventSubscriptionDestination objects
      },
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "eventDeliverySchema": "string",
    "expirationTimeUtc": "string",
    "filter": {
      "advancedFilters": [
        {
          "key": "string",
          "operatorType": "string"
          // For remaining properties, see AdvancedFilter objects
        }
      ],
      "enableAdvancedFilteringOnArrays": "bool",
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ],
    "retryPolicy": {
      "eventTimeToLiveInMinutes": "int",
      "maxDeliveryAttempts": "int"
    }
  }
}

Объекты DeadLetterDestination

Задайте свойство endpointType , чтобы указать тип объекта .

Для StorageBlob используйте:

  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "string"
  }

Объекты EventSubscriptionDestination

Задайте свойство endpointType , чтобы указать тип объекта .

Для AzureFunction используйте:

  "endpointType": "AzureFunction",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "maxEventsPerBatch": "int",
    "preferredBatchSizeInKilobytes": "int",
    "resourceId": "string"
  }

Для EventHub используйте:

  "endpointType": "EventHub",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

Для HybridConnection используйте:

  "endpointType": "HybridConnection",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

Для PartnerDestination используйте:

  "endpointType": "PartnerDestination",
  "properties": {
    "resourceId": "string"
  }

Для ServiceBusQueue используйте:

  "endpointType": "ServiceBusQueue",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

Для ServiceBusTopic используйте:

  "endpointType": "ServiceBusTopic",
  "properties": {
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "resourceId": "string"
  }

Для StorageQueue используйте:

  "endpointType": "StorageQueue",
  "properties": {
    "queueMessageTimeToLiveInSeconds": "int",
    "queueName": "string",
    "resourceId": "string"
  }

Для веб-перехватчика используйте:

  "endpointType": "WebHook",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string",
    "deliveryAttributeMappings": [
      {
        "name": "string",
        "type": "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ],
    "endpointUrl": "string",
    "maxEventsPerBatch": "int",
    "preferredBatchSizeInKilobytes": "int"
  }

Объекты DeliveryAttributeMapping

Задайте свойство type , чтобы указать тип объекта .

Для dynamic используйте:

  "type": "Dynamic",
  "properties": {
    "sourceField": "string"
  }

Для static используйте:

  "type": "Static",
  "properties": {
    "isSecret": "bool",
    "value": "string"
  }

Объекты AdvancedFilter

Задайте свойство operatorType , чтобы указать тип объекта .

Для BoolEquals используйте:

  "operatorType": "BoolEquals",
  "value": "bool"

Для IsNotNull используйте:

  "operatorType": "IsNotNull"

Для Параметра IsNullOrUndefined используйте:

  "operatorType": "IsNullOrUndefined"

Для NumberGreaterThan используйте:

  "operatorType": "NumberGreaterThan",
  "value": "int"

Для NumberGreaterThanOrEquals используйте:

  "operatorType": "NumberGreaterThanOrEquals",
  "value": "int"

Для NumberIn используйте:

  "operatorType": "NumberIn",
  "values": [ "int" ]

Для NumberInRange используйте:

  "operatorType": "NumberInRange",
  "values": [ [ "int" ] ]

Для NumberLessThan используйте:

  "operatorType": "NumberLessThan",
  "value": "int"

Для NumberLessThanOrEquals используйте:

  "operatorType": "NumberLessThanOrEquals",
  "value": "int"

Для NumberNotIn используйте:

  "operatorType": "NumberNotIn",
  "values": [ "int" ]

Для NumberNotInRange используйте:

  "operatorType": "NumberNotInRange",
  "values": [ [ "int" ] ]

Для StringBeginsWith используйте:

  "operatorType": "StringBeginsWith",
  "values": [ "string" ]

Для StringContains используйте:

  "operatorType": "StringContains",
  "values": [ "string" ]

Для StringEndsWith используйте:

  "operatorType": "StringEndsWith",
  "values": [ "string" ]

Для StringIn используйте:

  "operatorType": "StringIn",
  "values": [ "string" ]

Для StringNotBeginsWith используйте:

  "operatorType": "StringNotBeginsWith",
  "values": [ "string" ]

Для StringNotContains используйте:

  "operatorType": "StringNotContains",
  "values": [ "string" ]

Для StringNotEndsWith используйте:

  "operatorType": "StringNotEndsWith",
  "values": [ "string" ]

Для StringNotIn используйте:

  "operatorType": "StringNotIn",
  "values": [ "string" ]

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

domains/topics/eventSubscriptions

Имя Описание Значение
тип Тип ресурса Microsoft.EventGrid/domains/topics/eventSubscriptions
версия_API Версия API ресурсов '2021-10-15-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.
строка (обязательно)
properties Свойства подписки на события. EventSubscriptionProperties

EventSubscriptionProperties

Имя Описание Значение
deadLetterDestination Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения , отправляется в место назначения недоставленных сообщений.
Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeadLetterDestination
deadLetterWithResourceIdentity Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения , отправляется в место назначения недоставленных сообщений.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Сведения о назначении, куда должны доставляться события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeliveryWithResourceIdentity
ресурс destination Сведения о назначении, куда должны доставляться события для подписки на события.
Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
EventSubscriptionDestination
eventDeliverySchema Схема доставки событий для подписки на события. "CloudEventSchemaV1_0"
CustomInputSchema
EventGridSchema
expirationTimeUtc Срок действия подписки на события. строка
фильтр Сведения о фильтре для подписки на события. EventSubscriptionFilter
метки; Список пользовательских меток. string[]
retryPolicy Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. RetryPolicy

DeadLetterDestination

Имя Описание Значение
endpointType Установка типа объекта StorageBlob (обязательно)

StorageBlobDeadLetterDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения недоставленных сообщений StorageBlob (обязательно)
properties Свойства назначения недоставленных сообщений на основе BLOB-объектов хранилища StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Имя Описание Значение
blobContainerName Имя контейнера больших двоичных объектов хранилища, который является местом назначения событий недоставленных сообщений. строка
resourceId Идентификатор ресурса Azure учетной записи хранения, которая является местом назначения событий недоставленных сообщений. строка

DeadLetterWithResourceIdentity

Имя Описание Значение
deadLetterDestination Сведения о назначении, куда должны доставляться события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeadLetterDestination
удостоверение Удостоверение, используемое при недоставленных событиях. EventSubscriptionIdentity

EventSubscriptionIdentity

Имя Описание Значение
тип Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор назначаемых пользователем удостоверений. Тип None приведет к удалению всех удостоверений. SystemAssigned
UserAssigned
userAssignedIdentity Удостоверение пользователя, связанное с ресурсом. строка

DeliveryWithResourceIdentity

Имя Описание Значение
ресурс destination Сведения о назначении, куда должны быть доставлены события для подписки на события.
Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
EventSubscriptionDestination
удостоверение Удостоверение, используемое при доставке событий. EventSubscriptionIdentity

EventSubscriptionDestination

Имя Описание Значение
endpointType Установка типа объекта AzureFunction
EventHub
HybridConnection
PartnerDestination
ServiceBusQueue
ServiceBusTopic
StorageQueue
Веб-перехватчик (обязательно)

AzureFunctionEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. AzureFunction (обязательно)
properties Свойства функции Azure назначения подписки на события. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
maxEventsPerBatch Максимальное число событий в пакете. INT
preferredBatchSizeInKilobytes Предпочтительный размер пакета в килобайтах. INT
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на события. строка

DeliveryAttributeMapping

Имя Описание Значение
name Имя атрибута доставки или заголовка. строка
type Установка типа объекта динамически;
Static (обязательно)

DynamicDeliveryAttributeMapping

Имя Описание Значение
тип Тип атрибута доставки или имени заголовка. Dynamic (обязательно)
properties Свойства сопоставления атрибутов динамической доставки. DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

Имя Описание Значение
sourceField Путь JSON в событии, которое содержит значение атрибута. строка

StaticDeliveryAttributeMapping

Имя Описание Значение
тип Тип атрибута доставки или имени заголовка. Static (обязательный)
properties Свойства сопоставления атрибутов статической доставки. StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

Имя Описание Значение
isSecret Логический флаг, который указывает, содержит ли атрибут конфиденциальную информацию. bool
значение Значение атрибута доставки. строка

EventHubEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. EventHub (обязательно)
properties Свойства концентратора событий назначения подписки на события. EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения концентратора событий подписки на события. строка

HybridConnectionEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. HybridConnection (обязательно)
properties Свойства гибридного подключения назначения подписки на события. HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. строка

PartnerEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. PartnerDestination (обязательно)
properties Назначение партнера. Свойства назначения подписки на события. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Имя Описание Значение
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения партнера подписки на события. строка

ServiceBusQueueEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. ServiceBusQueue (обязательно)
properties Свойства служебной шины назначения подписки на события. ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения служебной шины подписки на события. строка

ServiceBusTopicEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. ServiceBusTopic (обязательно)
properties Свойства раздела служебной шины назначения подписки на события. ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения раздела служебной шины подписки на события. строка

StorageQueueEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. StorageQueue (обязательно)
properties Свойства очереди хранилища назначения подписки на события. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Имя Описание Значение
queueMessageTimeToLiveInSeconds Время жизни сообщения очереди хранилища в секундах. INT
queueName Имя очереди хранилища в учетной записи хранения, которая является местом назначения подписки на события. строка
resourceId Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является местом назначения подписки на события. строка

WebHookEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. WebHook (обязательно)
properties Свойства веб-перехватчика назначения подписки на события. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Имя Описание Значение
azureActiveDirectoryApplicationIdOrUri Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в запросы на доставку в качестве маркера носителя. строка
azureActiveDirectoryTenantId Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в запросы на доставку в качестве маркера носителя. строка
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
endpointUrl URL-адрес, представляющий конечную точку назначения подписки на события. строка

Ограничения:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
maxEventsPerBatch Максимальное количество событий на пакет. INT
preferredBatchSizeInKilobytes Предпочтительный размер пакета в килобайтах. INT

EventSubscriptionFilter

Имя Описание Значение
advancedFilters Массив расширенных фильтров, используемых для фильтрации подписок на события. AdvancedFilter[]
enableAdvancedFilteringOnArrays Позволяет оценивать расширенные фильтры по массиву значений, а не ожидать единственного значения. bool
includedEventTypes Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. string[]
isSubjectCaseSensitive Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра.
следует сравнивать с учетом регистра.
bool
subjectBeginsWith Необязательная строка для фильтрации событий для подписки на события на основе префикса пути к ресурсу.
Формат зависит от издателя событий.
Подстановочные знаки не поддерживаются в этом пути.
строка
subjectEndsWith Необязательная строка для фильтрации событий для подписки на события на основе суффикса пути к ресурсу.
Подстановочные знаки не поддерживаются в этом пути.
строка

AdvancedFilter

Имя Описание Значение
key Поле или свойство в событии в зависимости от того, по которому требуется выполнить фильтрацию. строка
operatorType Установка типа объекта BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan;
NumberGreaterThanOrEquals;
NumberIn;
NumberInRange
NumberLessThan;
NumberGreaterThanOrEquals;
NumberNotIn.
NumberNotInRange
StringBeginsWith;
StringContains;
StringEndsWith;
StringIn;
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (обязательно)

BoolEqualsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. BoolEquals (обязательно)
значение Значение логического фильтра. bool

IsNotNullAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. IsNotNull (обязательно)

IsNullOrUndefinedAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. IsNullOrUndefined (обязательно)

NumberGreaterThanAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberGreaterThan (обязательно)
значение Значение фильтра. INT

NumberGreaterThanOrEqualsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberGreaterThanOrEquals (обязательно)
значение Значение фильтра. INT

NumberInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberIn" (обязательно)
значения Набор значений фильтра. int[]

NumberInRangeAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberInRange (обязательно)
значения Набор значений фильтра. int[][]

NumberLessThanAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberLessThan (обязательно)
значение Значение фильтра. INT

NumberLessThanOrEqualsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberLessThanOrEquals (обязательно)
значение Значение фильтра. INT

NumberNotInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberNotIn (обязательно)
значения Набор значений фильтра. int[]

NumberNotInRangeAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberNotInRange (обязательно)
значения Набор значений фильтра. int[][]

StringBeginsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringBeginsWith (обязательно)
значения Набор значений фильтра. string[]

StringContainsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringContains (обязательно)
значения Набор значений фильтра. string[]

StringEndsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringEndsWith (обязательно)
значения Набор значений фильтра. string[]

StringInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringIn (обязательно)
значения Набор значений фильтра. string[]

StringNotBeginsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotBeginsWith (обязательно)
значения Набор значений фильтра. string[]

StringNotContainsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotContains (обязательно)
значения Набор значений фильтра. string[]

StringNotEndsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotEndsWith (обязательно)
значения Набор значений фильтра. string[]

StringNotInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotIn (обязательно)
значения Набор значений фильтра. string[]

политика RetryPolicy

Имя Описание Значение
eventTimeToLiveInMinutes Время жизни (в минутах) для событий. INT
maxDeliveryAttempts Максимальное количество повторных попыток доставки для событий. INT

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/domains/topics/eventSubscriptions@2021-10-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      deadLetterWithResourceIdentity = {
        deadLetterDestination = {
          endpointType = "string"
          // For remaining properties, see DeadLetterDestination objects
        }
        identity = {
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      deliveryWithResourceIdentity = {
        destination = {
          endpointType = "string"
          // For remaining properties, see EventSubscriptionDestination objects
        }
        identity = {
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      destination = {
        endpointType = "string"
        // For remaining properties, see EventSubscriptionDestination objects
      }
      eventDeliverySchema = "string"
      expirationTimeUtc = "string"
      filter = {
        advancedFilters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see AdvancedFilter objects
          }
        ]
        enableAdvancedFilteringOnArrays = bool
        includedEventTypes = [
          "string"
        ]
        isSubjectCaseSensitive = bool
        subjectBeginsWith = "string"
        subjectEndsWith = "string"
      }
      labels = [
        "string"
      ]
      retryPolicy = {
        eventTimeToLiveInMinutes = int
        maxDeliveryAttempts = int
      }
    }
  })
}

Объекты DeadLetterDestination

Задайте свойство endpointType , чтобы указать тип объекта.

Для StorageBlob используйте:

  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "string"
  }

Объекты EventSubscriptionDestination

Задайте свойство endpointType , чтобы указать тип объекта.

Для AzureFunction используйте:

  endpointType = "AzureFunction"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch = int
    preferredBatchSizeInKilobytes = int
    resourceId = "string"
  }

Для EventHub используйте:

  endpointType = "EventHub"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

Для HybridConnection используйте:

  endpointType = "HybridConnection"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

Для PartnerDestination используйте:

  endpointType = "PartnerDestination"
  properties = {
    resourceId = "string"
  }

Для ServiceBusQueue используйте:

  endpointType = "ServiceBusQueue"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

Для ServiceBusTopic используйте:

  endpointType = "ServiceBusTopic"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }

Для StorageQueue используйте:

  endpointType = "StorageQueue"
  properties = {
    queueMessageTimeToLiveInSeconds = int
    queueName = "string"
    resourceId = "string"
  }

Для веб-перехватчика используйте:

  endpointType = "WebHook"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl = "string"
    maxEventsPerBatch = int
    preferredBatchSizeInKilobytes = int
  }

Объекты DeliveryAttributeMapping

Задайте свойство type , чтобы указать тип объекта .

Для динамического использования используйте:

  type = "Dynamic"
  properties = {
    sourceField = "string"
  }

Для static используйте:

  type = "Static"
  properties = {
    isSecret = bool
    value = "string"
  }

Объекты AdvancedFilter

Задайте свойство operatorType , чтобы указать тип объекта .

Для BoolEquals используйте:

  operatorType = "BoolEquals"
  value = bool

Для IsNotNull используйте:

  operatorType = "IsNotNull"

Для IsNullOrUndefined используйте:

  operatorType = "IsNullOrUndefined"

Для NumberGreaterThan используйте:

  operatorType = "NumberGreaterThan"
  value = int

Для NumberGreaterThanOrEquals используйте:

  operatorType = "NumberGreaterThanOrEquals"
  value = int

Для NumberIn используйте:

  operatorType = "NumberIn"
  values = [
    int
  ]

Для NumberInRange используйте:

  operatorType = "NumberInRange"
  values = [
    [
      int
    ]
  ]

Для NumberLessThan используйте:

  operatorType = "NumberLessThan"
  value = int

Для NumberLessThanOrEquals используйте:

  operatorType = "NumberLessThanOrEquals"
  value = int

Для NumberNotIn используйте:

  operatorType = "NumberNotIn"
  values = [
    int
  ]

Для NumberNotInRange используйте:

  operatorType = "NumberNotInRange"
  values = [
    [
      int
    ]
  ]

Для StringBeginsWith используйте:

  operatorType = "StringBeginsWith"
  values = [
    "string"
  ]

Для StringContains используйте:

  operatorType = "StringContains"
  values = [
    "string"
  ]

Для StringEndsWith используйте:

  operatorType = "StringEndsWith"
  values = [
    "string"
  ]

Для StringIn используйте:

  operatorType = "StringIn"
  values = [
    "string"
  ]

Для StringNotBeginsWith используйте:

  operatorType = "StringNotBeginsWith"
  values = [
    "string"
  ]

Для StringNotContains используйте:

  operatorType = "StringNotContains"
  values = [
    "string"
  ]

Для StringNotEndsWith используйте:

  operatorType = "StringNotEndsWith"
  values = [
    "string"
  ]

Для StringNotIn используйте:

  operatorType = "StringNotIn"
  values = [
    "string"
  ]

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

domains/topics/eventSubscriptions

Имя Описание Значение
тип Тип ресурса "Microsoft.EventGrid/domains/topics/eventSubscriptions@2021-10-15-preview"
name имя ресурса. string (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: темы
properties Свойства подписки на события. EventSubscriptionProperties

EventSubscriptionProperties

Имя Описание Значение
deadLetterDestination Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленных сообщений.
Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeadLetterDestination
deadLetterWithResourceIdentity Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленных сообщений.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки сообщений.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Сведения о назначении, куда должны быть доставлены события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки сообщений.
DeliveryWithResourceIdentity
ресурс destination Сведения о назначении, куда должны доставляться события для подписки на события.
Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
EventSubscriptionDestination
eventDeliverySchema Схема доставки событий для подписки на события. "CloudEventSchemaV1_0"
CustomInputSchema
"EventGridSchema"
expirationTimeUtc Срок действия подписки на события. строка
фильтр Сведения о фильтре для подписки на события. EventSubscriptionFilter
метки; Список пользовательских меток. string[]
retryPolicy Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. RetryPolicy

DeadLetterDestination

Имя Описание Значение
endpointType Установка типа объекта StorageBlob (обязательно)

StorageBlobDeadLetterDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения недоставленных сообщений StorageBlob (обязательно)
properties Свойства назначения недоставленных сообщений на основе BLOB-объектов хранилища StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Имя Описание Значение
blobContainerName Имя контейнера больших двоичных объектов хранилища, который является местом назначения событий недоставленных сообщений. строка
resourceId Идентификатор ресурса Azure учетной записи хранения, которая является местом назначения событий недоставленных сообщений. строка

DeadLetterWithResourceIdentity

Имя Описание Значение
deadLetterDestination Сведения о назначении, куда должны доставляться события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeadLetterDestination
удостоверение Удостоверение, используемое при недоставленных событиях. EventSubscriptionIdentity

EventSubscriptionIdentity

Имя Описание Значение
тип Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None приведет к удалению всех удостоверений. "SystemAssigned"
UserAssigned
userAssignedIdentity Удостоверение пользователя, связанное с ресурсом. строка

DeliveryWithResourceIdentity

Имя Описание Значение
ресурс destination Сведения о назначении, куда должны доставляться события для подписки на события.
Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
EventSubscriptionDestination
удостоверение Удостоверение, используемое при доставке событий. EventSubscriptionIdentity

EventSubscriptionDestination

Имя Описание Значение
endpointType Установка типа объекта AzureFunction
EventHub
Гибридное подключение
PartnerDestination
ServiceBusQueue
ServiceBusTopic
StorageQueue
Веб-перехватчик (обязательно)

AzureFunctionEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. AzureFunction (обязательно)
properties Свойства функции Azure назначения подписки на события. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
maxEventsPerBatch Максимальное количество событий на пакет. INT
preferredBatchSizeInKilobytes Предпочтительный размер пакета в килобайтах. INT
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на события. строка

DeliveryAttributeMapping

Имя Описание Значение
name Имя атрибута или заголовка доставки. строка
type Установка типа объекта динамически;
Static (обязательно)

DynamicDeliveryAttributeMapping

Имя Описание Значение
тип Тип атрибута доставки или имени заголовка. "Dynamic" (обязательно)
properties Свойства сопоставления атрибутов динамической доставки. DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

Имя Описание Значение
sourceField Путь JSON в событии, которое содержит значение атрибута. строка

StaticDeliveryAttributeMapping

Имя Описание Значение
тип Тип атрибута доставки или имени заголовка. "Static" (обязательно)
properties Свойства сопоставления атрибутов статической доставки. StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

Имя Описание Значение
isSecret Логический флаг, который указывает, содержит ли атрибут конфиденциальную информацию. bool
значение Значение атрибута доставки. строка

EventHubEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. "EventHub" (обязательно)
properties Свойства концентратора событий назначения подписки на события. EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения концентратора событий подписки на события. строка

HybridConnectionEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. HybridConnection (обязательно)
properties Свойства гибридного подключения назначения подписки на события. HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. строка

PartnerEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. PartnerDestination (обязательно)
properties Назначение партнера. Свойства назначения подписки на события. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Имя Описание Значение
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения партнера подписки на события. строка

ServiceBusQueueEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. ServiceBusQueue (обязательно)
properties Свойства служебной шины назначения подписки на события. ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения служебной шины подписки на события. строка

ServiceBusTopicEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. ServiceBusTopic (обязательно)
properties Свойства раздела служебной шины назначения подписки на события. ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

Имя Описание Значение
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения раздела служебной шины подписки на события. строка

StorageQueueEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. StorageQueue (обязательно)
properties Свойства очереди хранилища назначения подписки на события. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Имя Описание Значение
queueMessageTimeToLiveInSeconds Время жизни сообщения очереди хранилища в секундах. INT
queueName Имя очереди хранилища в учетной записи хранения, которая является местом назначения подписки на события. строка
resourceId Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является местом назначения подписки на события. строка

WebHookEventSubscriptionDestination

Имя Описание Значение
endpointType Тип конечной точки для назначения подписки на события. WebHook (обязательно)
properties Свойства веб-перехватчика назначения подписки на события. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Имя Описание Значение
azureActiveDirectoryApplicationIdOrUri Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в запросы на доставку в качестве маркера носителя. строка
azureActiveDirectoryTenantId Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в запросы на доставку в качестве маркера носителя. строка
deliveryAttributeMappings Сведения об атрибуте доставки. DeliveryAttributeMapping[]
endpointUrl URL-адрес, представляющий конечную точку назначения подписки на события. строка

Ограничения:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
maxEventsPerBatch Максимальное количество событий на пакет. INT
preferredBatchSizeInKilobytes Предпочтительный размер пакета в килобайтах. INT

EventSubscriptionFilter

Имя Описание Значение
advancedFilters Массив расширенных фильтров, используемых для фильтрации подписок на события. AdvancedFilter[]
enableAdvancedFilteringOnArrays Позволяет оценивать расширенные фильтры по массиву значений, а не ожидать единственного значения. bool
includedEventTypes Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. string[]
isSubjectCaseSensitive Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра.
следует сравнивать с учетом регистра.
bool
subjectBeginsWith Необязательная строка для фильтрации событий для подписки на события на основе префикса пути к ресурсу.
Формат зависит от издателя событий.
Подстановочные знаки не поддерживаются в этом пути.
строка
subjectEndsWith Необязательная строка для фильтрации событий для подписки на события на основе суффикса пути к ресурсу.
Подстановочные знаки не поддерживаются в этом пути.
строка

AdvancedFilter

Имя Описание Значение
key Поле или свойство в событии в зависимости от того, по которому требуется выполнить фильтрацию. строка
operatorType Установка типа объекта BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan;
NumberGreaterThanOrEquals;
NumberIn;
NumberInRange
NumberLessThan;
NumberGreaterThanOrEquals;
NumberNotIn.
NumberNotInRange
StringBeginsWith;
StringContains;
StringEndsWith;
StringIn;
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (обязательно)

BoolEqualsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. BoolEquals (обязательно)
значение Значение логического фильтра. bool

IsNotNullAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. IsNotNull (обязательно)

IsNullOrUndefinedAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "IsNullOrUndefined" (обязательно)

NumberGreaterThanAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberGreaterThan" (обязательно)
значение Значение фильтра. INT

NumberGreaterThanOrEqualsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberGreaterThanOrEquals" (обязательно)
значение Значение фильтра. INT

NumberInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberIn" (обязательно)
значения Набор значений фильтра. int[]

NumberInRangeAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberInRange" (обязательно)
значения Набор значений фильтра. int[][]

NumberLessThanAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberLessThan" (обязательно)
значение Значение фильтра. INT

NumberLessThanOrEqualsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberLessThanOrEquals" (обязательно)
значение Значение фильтра. INT

NumberNotInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberNotIn" (обязательно)
значения Набор значений фильтра. int[]

NumberNotInRangeAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberNotInRange" (обязательно)
значения Набор значений фильтра. int[][]

StringBeginsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringBeginsWith" (обязательно)
значения Набор значений фильтра. string[]

StringContainsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringContains" (обязательно)
значения Набор значений фильтра. string[]

StringEndsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringEndsWith" (обязательно)
значения Набор значений фильтра. string[]

StringInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringIn" (обязательно)
значения Набор значений фильтра. string[]

StringNotBeginsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringNotBeginsWith" (обязательно)
значения Набор значений фильтра. string[]

StringNotContainsAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringNotContains" (обязательно)
значения Набор значений фильтра. string[]

StringNotEndsWithAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringNotEndsWith" (обязательно)
значения Набор значений фильтра. string[]

StringNotInAdvancedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringNotIn" (обязательно)
значения Набор значений фильтра. string[]

политика RetryPolicy

Имя Описание Значение
eventTimeToLiveInMinutes Время жизни (в минутах) для событий. INT
maxDeliveryAttempts Максимальное число повторных попыток доставки для событий. INT