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


Microsoft.EventGrid eventSubscriptions 2024-06-01-preview

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

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

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

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

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2024-06-01-preview' = {
  scope: resourceSymbolicName or scope
  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'
  }
}

Объекты 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'
  ]
}

Объекты DeliveryAttributeMapping

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

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

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

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

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

Объекты 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'
  }
}

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

{
  endpointType: 'MonitorAlert'
  properties: {
    actionGroups: [
      'string'
    ]
    description: 'string'
    severity: 'string'
  }
}

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

{
  endpointType: 'NamespaceTopic'
  properties: {
    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
    minimumTlsVersionAllowed: 'string'
    preferredBatchSizeInKilobytes: int
  }
}

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

Microsoft.EventGrid/eventSubscriptions

Имя Описание Ценность
имя имя ресурса. строка (обязательно)
свойства Свойства подписки на события. Свойства EventSubscriptionProperties
охват Используется при создании ресурса в области, отличной от области развертывания. Задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения.

Расширенный фильтр

Имя Описание Ценность
ключ Поле или свойство в событии, на основе которого требуется отфильтровать. струна
operatorType Задайте значение BoolEquals для типа BoolEqualsAdvancedFilter. Установите значение IsNotNull для типа IsNotNullAdvancedFilter. Задайте значение IsNullOrUndefined для типа IsNullOrUndefinedAdvancedFilter. Задайте значение NumberGreaterThan для типа NumberGreaterThanAdvancedFilter. Задайте значение NumberGreaterThanOrEquals для типа NumberGreaterThanOrEqualsAdvancedFilter. Задайте значение NumberIn для типа NumberInAdvancedFilter. Задайте значение NumberInRange для типа NumberInRangeAdvancedFilter. Задайте значение NumberLessThan для типа NumberLessThanAdvancedFilter. Задайте значение NumberLessThanOrEquals для типа NumberLessThanOrEqualsAdvancedFilter. Задайте значение NumberNotIn для типа NumberNotInAdvancedFilter. Задайте значение NumberNotInRange для типа NumberNotInRangeAdvancedFilter. Задайте значение StringBeginsWith для типа StringBeginsWithAdvancedFilter. Задайте значение StringContains для типа StringContainsAdvancedFilter. Задайте значение StringEndsWith для типа StringEndsWithAdvancedFilter. Задайте значение StringIn для типа StringInAdvancedFilter. Задайте значение StringNotBeginsWith для типа StringNotBeginsWithAdvancedFilter. Задайте значение StringNotContains для типа StringNotContainsAdvancedFilter. Задайте значение StringNotEndsWith для типа StringNotEndsWithAdvancedFilter. Задайте значение StringNotIn для типа StringNotInAdvancedFilter. BoolEquals
'IsNotNull'
'IsNullOrUndefined'
"NumberGreaterThan"
"NumberGreaterThanOrEquals"
"NumberIn"
"NumberInRange"
"NumberLessThan"
"NumberLessThanOrEquals"
"NumberNotIn"
"NumberNotInRange"
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (обязательно)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

Адресат: Недоставленное письмо

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

DeadLetterWithResourceIdentity

Имя Описание Ценность
deadLetterDestination Сведения о назначении, в котором должны быть доставлены события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время недоставки.
Адресат: Недоставленное письмо
идентичность Удостоверение, используемое при недоставленных событиях. Идентификация EventSubscriptionIdentity

DeliveryAttributeMapping

Имя Описание Ценность
имя Имя атрибута доставки или заголовка. струна
тип Задайте для типа DynamicDeliveryAttributeMapping значение DynamicDeliveryAttributeMapping. Задайте для типа StaticDeliveryAttributeMapping значение StaticDeliveryAttributeMapping. Dynamic
"Static" (обязательный)

DeliveryWithResourceIdentity (DeliveryWithResourceIdentity)

Имя Описание Ценность
пункт назначения Сведения о назначении, в котором должны быть доставлены события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки.
EventSubscriptionDestination (СобытиеПодпискаНаправление)
идентичность Удостоверение, используемое при доставке событий. Идентификация EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination (СобытиеПодпискаПодпискаDestination)

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

Свойства EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination (СобытиеПодпискаНаправление)

Имя Описание Ценность
endpointType Установите значение "AzureFunction" для типа AzureFunctionEventSubscriptionDestination. Задайте для типа EventHubEventSubscriptionDestination значение EventHubEventSubscriptionDestination. Установите значение HybridConnection для типа HybridConnectionEventSubscriptionDestination. Установите значение MonitorAlert для типа MonitorAlertEventSubscriptionDestination. Задайте значение NamespaceTopic для типа NamespaceTopicEventSubscriptionDestination. Установите значение PartnerDestination для типа PartnerEventSubscriptionDestination. Задайте значение ServiceBusQueue для типа ServiceBusQueueEventSubscriptionDestination. Задайте значение ServiceBusTopic для типа ServiceBusTopicEventSubscriptionDestination. Установите значение StorageQueue для типа StorageQueueEventSubscriptionDestination. Задайте значение WebHook для типа WebHookEventSubscriptionDestination. AzureFunction
EventHub
"HybridConnection"
MonitorAlert
"NamespaceTopic"
"PartnerDestination"
ServiceBusQueue
ServiceBusTopic
StorageQueue
WebHook (обязательный)

Фильтр EventSubscriptionFilter

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

Идентификация EventSubscriptionIdentity

Имя Описание Ценность
тип Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. SystemAssigned
UserAssigned
ИдентификацияПользователя Удостоверение пользователя, связанное с ресурсом. струна

Свойства EventSubscriptionProperties

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

HybridConnectionEventSubscriptionDestination (Гибридное соединениеСобытиеПодпискаНаправление)

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter (Фильтр NotNullAdvancedFilter)

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

IsNullOrUndefinedAdvancedFilter

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

MonitorAlertEventSubscriptionDestination (Контрольное устройство)

Имя Описание Ценность
endpointType Тип конечной точки для назначения подписки на события. MonitorAlert (обязательно)
свойства Отслеживайте свойства оповещений назначения подписки на события. Свойства MonitorAlertEventSubscriptionDestinationProperties

Свойства MonitorAlertEventSubscriptionDestinationProperties

Имя Описание Ценность
Группы действий Список идентификаторов ARM групп действий, которые будут активироваться при каждом оповещении, запущенном с помощью этой подписки на событие.
Каждый идентификатор RESOURCE ARM должен соответствовать этому шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
строка[]
описание Описание, которое будет присоединено к каждому оповещению, запущенному через эту подписку на событие. струна
суровость Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на события.
Это поле должно быть предоставлено.
'Сев0'
'Сев1'
«Сев2»
'Сев3'
'Сев4'

NamespaceTopicEventSubscriptionDestination

Имя Описание Ценность
endpointType Тип конечной точки для назначения подписки на события. NamespaceTopic (обязательно)
свойства Свойства раздела пространства имен назначения подписки на события. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Имя Описание Ценность
идентификатор ресурса Идентификатор ресурса Azure, представляющий конечную точку назначения пространства имен сетки событий подписки на событие.
Это поле необходимо, и ресурс раздела пространства имен уже должен существовать.
Идентификатор RESOURCE ARM должен соответствовать этому шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topic/{TopicName}.
струна

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter (ЧислоВДополнительном Фильтре)

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter (ЧислоМеньшеЧемДополнительногоФильтра)

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination (Партнерское мероприятиеПодпискаНаправление)

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

PartnerEventSubscriptionDestinationProperties

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

Политика повтора

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationProperties

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

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationProperties

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

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

Имя Описание Ценность
blobИмяКонтейнера Имя контейнера BLOB-объектов хранилища, который является назначением событий недоставки струна
идентификатор ресурса Идентификатор ресурса Azure учетной записи хранения, которая является назначением событий недоставки струна

StorageQueueEventSubscriptionDestination (Место назначения)

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

StorageQueueEventSubscriptionDestinationProperties

Имя Описание Ценность
queueMessageTimeToLiveInSeconds Время ожидания сообщения очереди хранилища в секундах. Это значение не может быть нулевым или отрицательным, за исключением использования -1, чтобы указать, что время жизни сообщения бесконечно. инт
название очереди Имя очереди хранилища в учетной записи хранения, которая является назначением подписки на событие. струна
идентификатор ресурса Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является назначением подписки на событие. струна

СтрокаНачинаетсяСРасширеннымФильтром

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

СтрокаСодержитРасширенныйФильтр

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

StringEndsWithAdvancedFilter (СтрокаЗаканчивается с AdvancedFilter)

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

СтрокаВДополнительном Фильтре

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter (СтрокаNotEndsWithAdvancedFilter)

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

StringNotInAdvancedFilter (СтрокаNotInAdvancedFilter)

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
maxEventsPerBatch Максимальное количество событий в пакете. инт
minimumTlsVersionAllowed Минимальная версия TLS, которая должна поддерживаться конечной точкой веб-перехватчика '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Предпочтительный размер пакета в Килобайтах. инт

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

Примеры быстрого запуска Azure

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

Bicep-файл Описание
создание настраиваемой темы сетки событий Azure и подписки на очередь Создает настраиваемый раздел Сетки событий Azure и подписку очереди служебной шины. Шаблон первоначально создан Маркусом Мейером.
создание настраиваемого раздела и подписки в Сетк е событий Azure Создает настраиваемый раздел Сетки событий Azure и подписку веб-перехватчика. Шаблон первоначально создан Джоном Дауном.

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

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

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

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

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2024-06-01-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"
  }
}

Объекты 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" ]
}

Объекты DeliveryAttributeMapping

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

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

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

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

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

Объекты 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"
  }
}

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

{
  "endpointType": "MonitorAlert",
  "properties": {
    "actionGroups": [ "string" ],
    "description": "string",
    "severity": "string"
  }
}

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

{
  "endpointType": "NamespaceTopic",
  "properties": {
    "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",
    "minimumTlsVersionAllowed": "string",
    "preferredBatchSizeInKilobytes": "int"
  }
}

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

Microsoft.EventGrid/eventSubscriptions

Имя Описание Ценность
apiVersion Версия API «2024-06-01-превью»
имя имя ресурса. строка (обязательно)
свойства Свойства подписки на события. Свойства EventSubscriptionProperties
тип Тип ресурса "Microsoft.EventGrid/eventSubscriptions"

Расширенный фильтр

Имя Описание Ценность
ключ Поле или свойство в событии, на основе которого требуется отфильтровать. струна
operatorType Задайте значение BoolEquals для типа BoolEqualsAdvancedFilter. Установите значение IsNotNull для типа IsNotNullAdvancedFilter. Задайте значение IsNullOrUndefined для типа IsNullOrUndefinedAdvancedFilter. Задайте значение NumberGreaterThan для типа NumberGreaterThanAdvancedFilter. Задайте значение NumberGreaterThanOrEquals для типа NumberGreaterThanOrEqualsAdvancedFilter. Задайте значение NumberIn для типа NumberInAdvancedFilter. Задайте значение NumberInRange для типа NumberInRangeAdvancedFilter. Задайте значение NumberLessThan для типа NumberLessThanAdvancedFilter. Задайте значение NumberLessThanOrEquals для типа NumberLessThanOrEqualsAdvancedFilter. Задайте значение NumberNotIn для типа NumberNotInAdvancedFilter. Задайте значение NumberNotInRange для типа NumberNotInRangeAdvancedFilter. Задайте значение StringBeginsWith для типа StringBeginsWithAdvancedFilter. Задайте значение StringContains для типа StringContainsAdvancedFilter. Задайте значение StringEndsWith для типа StringEndsWithAdvancedFilter. Задайте значение StringIn для типа StringInAdvancedFilter. Задайте значение StringNotBeginsWith для типа StringNotBeginsWithAdvancedFilter. Задайте значение StringNotContains для типа StringNotContainsAdvancedFilter. Задайте значение StringNotEndsWith для типа StringNotEndsWithAdvancedFilter. Задайте значение StringNotIn для типа StringNotInAdvancedFilter. BoolEquals
'IsNotNull'
'IsNullOrUndefined'
"NumberGreaterThan"
"NumberGreaterThanOrEquals"
"NumberIn"
"NumberInRange"
"NumberLessThan"
"NumberLessThanOrEquals"
"NumberNotIn"
"NumberNotInRange"
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (обязательно)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

Адресат: Недоставленное письмо

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

DeadLetterWithResourceIdentity

Имя Описание Ценность
deadLetterDestination Сведения о назначении, в котором должны быть доставлены события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время недоставки.
Адресат: Недоставленное письмо
идентичность Удостоверение, используемое при недоставленных событиях. Идентификация EventSubscriptionIdentity

DeliveryAttributeMapping

Имя Описание Ценность
имя Имя атрибута доставки или заголовка. струна
тип Задайте для типа DynamicDeliveryAttributeMapping значение DynamicDeliveryAttributeMapping. Задайте для типа StaticDeliveryAttributeMapping значение StaticDeliveryAttributeMapping. Dynamic
"Static" (обязательный)

DeliveryWithResourceIdentity (DeliveryWithResourceIdentity)

Имя Описание Ценность
пункт назначения Сведения о назначении, в котором должны быть доставлены события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки.
EventSubscriptionDestination (СобытиеПодпискаНаправление)
идентичность Удостоверение, используемое при доставке событий. Идентификация EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination (СобытиеПодпискаПодпискаDestination)

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

Свойства EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination (СобытиеПодпискаНаправление)

Имя Описание Ценность
endpointType Установите значение "AzureFunction" для типа AzureFunctionEventSubscriptionDestination. Задайте для типа EventHubEventSubscriptionDestination значение EventHubEventSubscriptionDestination. Установите значение HybridConnection для типа HybridConnectionEventSubscriptionDestination. Установите значение MonitorAlert для типа MonitorAlertEventSubscriptionDestination. Задайте значение NamespaceTopic для типа NamespaceTopicEventSubscriptionDestination. Установите значение PartnerDestination для типа PartnerEventSubscriptionDestination. Задайте значение ServiceBusQueue для типа ServiceBusQueueEventSubscriptionDestination. Задайте значение ServiceBusTopic для типа ServiceBusTopicEventSubscriptionDestination. Установите значение StorageQueue для типа StorageQueueEventSubscriptionDestination. Задайте значение WebHook для типа WebHookEventSubscriptionDestination. AzureFunction
EventHub
"HybridConnection"
MonitorAlert
"NamespaceTopic"
"PartnerDestination"
ServiceBusQueue
ServiceBusTopic
StorageQueue
WebHook (обязательный)

Фильтр EventSubscriptionFilter

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

Идентификация EventSubscriptionIdentity

Имя Описание Ценность
тип Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. SystemAssigned
UserAssigned
ИдентификацияПользователя Удостоверение пользователя, связанное с ресурсом. струна

Свойства EventSubscriptionProperties

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

HybridConnectionEventSubscriptionDestination (Гибридное соединениеСобытиеПодпискаНаправление)

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter (Фильтр NotNullAdvancedFilter)

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

IsNullOrUndefinedAdvancedFilter

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

MonitorAlertEventSubscriptionDestination (Контрольное устройство)

Имя Описание Ценность
endpointType Тип конечной точки для назначения подписки на события. MonitorAlert (обязательно)
свойства Отслеживайте свойства оповещений назначения подписки на события. Свойства MonitorAlertEventSubscriptionDestinationProperties

Свойства MonitorAlertEventSubscriptionDestinationProperties

Имя Описание Ценность
Группы действий Список идентификаторов ARM групп действий, которые будут активироваться при каждом оповещении, запущенном с помощью этой подписки на событие.
Каждый идентификатор RESOURCE ARM должен соответствовать этому шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
строка[]
описание Описание, которое будет присоединено к каждому оповещению, запущенному через эту подписку на событие. струна
суровость Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на события.
Это поле должно быть предоставлено.
'Сев0'
'Сев1'
«Сев2»
'Сев3'
'Сев4'

NamespaceTopicEventSubscriptionDestination

Имя Описание Ценность
endpointType Тип конечной точки для назначения подписки на события. NamespaceTopic (обязательно)
свойства Свойства раздела пространства имен назначения подписки на события. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Имя Описание Ценность
идентификатор ресурса Идентификатор ресурса Azure, представляющий конечную точку назначения пространства имен сетки событий подписки на событие.
Это поле необходимо, и ресурс раздела пространства имен уже должен существовать.
Идентификатор RESOURCE ARM должен соответствовать этому шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topic/{TopicName}.
струна

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter (ЧислоВДополнительном Фильтре)

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter (ЧислоМеньшеЧемДополнительногоФильтра)

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination (Партнерское мероприятиеПодпискаНаправление)

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

PartnerEventSubscriptionDestinationProperties

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

Политика повтора

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationProperties

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

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationProperties

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

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

Имя Описание Ценность
blobИмяКонтейнера Имя контейнера BLOB-объектов хранилища, который является назначением событий недоставки струна
идентификатор ресурса Идентификатор ресурса Azure учетной записи хранения, которая является назначением событий недоставки струна

StorageQueueEventSubscriptionDestination (Место назначения)

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

StorageQueueEventSubscriptionDestinationProperties

Имя Описание Ценность
queueMessageTimeToLiveInSeconds Время ожидания сообщения очереди хранилища в секундах. Это значение не может быть нулевым или отрицательным, за исключением использования -1, чтобы указать, что время жизни сообщения бесконечно. инт
название очереди Имя очереди хранилища в учетной записи хранения, которая является назначением подписки на событие. струна
идентификатор ресурса Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является назначением подписки на событие. струна

СтрокаНачинаетсяСРасширеннымФильтром

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

СтрокаСодержитРасширенныйФильтр

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

StringEndsWithAdvancedFilter (СтрокаЗаканчивается с AdvancedFilter)

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

СтрокаВДополнительном Фильтре

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter (СтрокаNotEndsWithAdvancedFilter)

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

StringNotInAdvancedFilter (СтрокаNotInAdvancedFilter)

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
maxEventsPerBatch Максимальное количество событий в пакете. инт
minimumTlsVersionAllowed Минимальная версия TLS, которая должна поддерживаться конечной точкой веб-перехватчика '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Предпочтительный размер пакета в Килобайтах. инт

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

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

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

Шаблон Описание
создание настраиваемой темы сетки событий Azure и подписки на очередь

Развертывание в Azure
Создает настраиваемый раздел Сетки событий Azure и подписку очереди служебной шины. Шаблон первоначально создан Маркусом Мейером.
создание настраиваемого раздела и подписки в Сетк е событий Azure

Развертывание в Azure
Создает настраиваемый раздел Сетки событий Azure и подписку веб-перехватчика. Шаблон первоначально создан Джоном Дауном.
создание настраиваемой подписки сетки событий Azure

Развертывание в Azure
Создает настраиваемый раздел Сетки событий Azure и подписку на раздел служебной шины. Шаблон первоначально создан Маркусом Мейером.
Создание настраиваемого раздела сетки событий и обработчика концентратора событий

Развертывание в Azure
Создает настраиваемый раздел сетки событий Azure и концентратор событий для обработки событий.
Создание подписки сетки событий для событий ресурсов

Развертывание в Azure
Создает подписку сетки событий в группу ресурсов или подписку Azure.
настраиваемый раздел сетки событий Azure или подписка с CloudEvents

Развертывание в Azure
Создает пользовательский раздел Сетки событий Azure, подписку веб-перехватчика с схемой CloudEvents и приложение логики в качестве обработчика событий. Шаблон первоначально создан ДжастинОм Yoo.

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2024-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    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"
  }
}

Объекты 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"
  ]
}

Объекты DeliveryAttributeMapping

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

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

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

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

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

Объекты 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"
  }
}

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

{
  endpointType = "MonitorAlert"
  properties = {
    actionGroups = [
      "string"
    ]
    description = "string"
    severity = "string"
  }
}

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

{
  endpointType = "NamespaceTopic"
  properties = {
    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
    minimumTlsVersionAllowed = "string"
    preferredBatchSizeInKilobytes = int
  }
}

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

Microsoft.EventGrid/eventSubscriptions

Имя Описание Ценность
имя имя ресурса. строка (обязательно)
идентификатор_родителя Идентификатор ресурса для применения этого ресурса расширения. строка (обязательно)
свойства Свойства подписки на события. Свойства EventSubscriptionProperties
тип Тип ресурса "Microsoft.EventGrid/eventSubscriptions@2024-06-01-preview"

Расширенный фильтр

Имя Описание Ценность
ключ Поле или свойство в событии, на основе которого требуется отфильтровать. струна
operatorType Задайте значение BoolEquals для типа BoolEqualsAdvancedFilter. Установите значение IsNotNull для типа IsNotNullAdvancedFilter. Задайте значение IsNullOrUndefined для типа IsNullOrUndefinedAdvancedFilter. Задайте значение NumberGreaterThan для типа NumberGreaterThanAdvancedFilter. Задайте значение NumberGreaterThanOrEquals для типа NumberGreaterThanOrEqualsAdvancedFilter. Задайте значение NumberIn для типа NumberInAdvancedFilter. Задайте значение NumberInRange для типа NumberInRangeAdvancedFilter. Задайте значение NumberLessThan для типа NumberLessThanAdvancedFilter. Задайте значение NumberLessThanOrEquals для типа NumberLessThanOrEqualsAdvancedFilter. Задайте значение NumberNotIn для типа NumberNotInAdvancedFilter. Задайте значение NumberNotInRange для типа NumberNotInRangeAdvancedFilter. Задайте значение StringBeginsWith для типа StringBeginsWithAdvancedFilter. Задайте значение StringContains для типа StringContainsAdvancedFilter. Задайте значение StringEndsWith для типа StringEndsWithAdvancedFilter. Задайте значение StringIn для типа StringInAdvancedFilter. Задайте значение StringNotBeginsWith для типа StringNotBeginsWithAdvancedFilter. Задайте значение StringNotContains для типа StringNotContainsAdvancedFilter. Задайте значение StringNotEndsWith для типа StringNotEndsWithAdvancedFilter. Задайте значение StringNotIn для типа StringNotInAdvancedFilter. BoolEquals
'IsNotNull'
'IsNullOrUndefined'
"NumberGreaterThan"
"NumberGreaterThanOrEquals"
"NumberIn"
"NumberInRange"
"NumberLessThan"
"NumberLessThanOrEquals"
"NumberNotIn"
"NumberNotInRange"
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (обязательно)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

Адресат: Недоставленное письмо

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

DeadLetterWithResourceIdentity

Имя Описание Ценность
deadLetterDestination Сведения о назначении, в котором должны быть доставлены события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время недоставки.
Адресат: Недоставленное письмо
идентичность Удостоверение, используемое при недоставленных событиях. Идентификация EventSubscriptionIdentity

DeliveryAttributeMapping

Имя Описание Ценность
имя Имя атрибута доставки или заголовка. струна
тип Задайте для типа DynamicDeliveryAttributeMapping значение DynamicDeliveryAttributeMapping. Задайте для типа StaticDeliveryAttributeMapping значение StaticDeliveryAttributeMapping. Dynamic
"Static" (обязательный)

DeliveryWithResourceIdentity (DeliveryWithResourceIdentity)

Имя Описание Ценность
пункт назначения Сведения о назначении, в котором должны быть доставлены события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки.
EventSubscriptionDestination (СобытиеПодпискаНаправление)
идентичность Удостоверение, используемое при доставке событий. Идентификация EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination (СобытиеПодпискаПодпискаDestination)

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

Свойства EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination (СобытиеПодпискаНаправление)

Имя Описание Ценность
endpointType Установите значение "AzureFunction" для типа AzureFunctionEventSubscriptionDestination. Задайте для типа EventHubEventSubscriptionDestination значение EventHubEventSubscriptionDestination. Установите значение HybridConnection для типа HybridConnectionEventSubscriptionDestination. Установите значение MonitorAlert для типа MonitorAlertEventSubscriptionDestination. Задайте значение NamespaceTopic для типа NamespaceTopicEventSubscriptionDestination. Установите значение PartnerDestination для типа PartnerEventSubscriptionDestination. Задайте значение ServiceBusQueue для типа ServiceBusQueueEventSubscriptionDestination. Задайте значение ServiceBusTopic для типа ServiceBusTopicEventSubscriptionDestination. Установите значение StorageQueue для типа StorageQueueEventSubscriptionDestination. Задайте значение WebHook для типа WebHookEventSubscriptionDestination. AzureFunction
EventHub
"HybridConnection"
MonitorAlert
"NamespaceTopic"
"PartnerDestination"
ServiceBusQueue
ServiceBusTopic
StorageQueue
WebHook (обязательный)

Фильтр EventSubscriptionFilter

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

Идентификация EventSubscriptionIdentity

Имя Описание Ценность
тип Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. SystemAssigned
UserAssigned
ИдентификацияПользователя Удостоверение пользователя, связанное с ресурсом. струна

Свойства EventSubscriptionProperties

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

HybridConnectionEventSubscriptionDestination (Гибридное соединениеСобытиеПодпискаНаправление)

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter (Фильтр NotNullAdvancedFilter)

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

IsNullOrUndefinedAdvancedFilter

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

MonitorAlertEventSubscriptionDestination (Контрольное устройство)

Имя Описание Ценность
endpointType Тип конечной точки для назначения подписки на события. MonitorAlert (обязательно)
свойства Отслеживайте свойства оповещений назначения подписки на события. Свойства MonitorAlertEventSubscriptionDestinationProperties

Свойства MonitorAlertEventSubscriptionDestinationProperties

Имя Описание Ценность
Группы действий Список идентификаторов ARM групп действий, которые будут активироваться при каждом оповещении, запущенном с помощью этой подписки на событие.
Каждый идентификатор RESOURCE ARM должен соответствовать этому шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
строка[]
описание Описание, которое будет присоединено к каждому оповещению, запущенному через эту подписку на событие. струна
суровость Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на события.
Это поле должно быть предоставлено.
'Сев0'
'Сев1'
«Сев2»
'Сев3'
'Сев4'

NamespaceTopicEventSubscriptionDestination

Имя Описание Ценность
endpointType Тип конечной точки для назначения подписки на события. NamespaceTopic (обязательно)
свойства Свойства раздела пространства имен назначения подписки на события. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Имя Описание Ценность
идентификатор ресурса Идентификатор ресурса Azure, представляющий конечную точку назначения пространства имен сетки событий подписки на событие.
Это поле необходимо, и ресурс раздела пространства имен уже должен существовать.
Идентификатор RESOURCE ARM должен соответствовать этому шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topic/{TopicName}.
струна

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter (ЧислоВДополнительном Фильтре)

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter (ЧислоМеньшеЧемДополнительногоФильтра)

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination (Партнерское мероприятиеПодпискаНаправление)

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

PartnerEventSubscriptionDestinationProperties

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

Политика повтора

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationProperties

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

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationProperties

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

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

Имя Описание Ценность
blobИмяКонтейнера Имя контейнера BLOB-объектов хранилища, который является назначением событий недоставки струна
идентификатор ресурса Идентификатор ресурса Azure учетной записи хранения, которая является назначением событий недоставки струна

StorageQueueEventSubscriptionDestination (Место назначения)

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

StorageQueueEventSubscriptionDestinationProperties

Имя Описание Ценность
queueMessageTimeToLiveInSeconds Время ожидания сообщения очереди хранилища в секундах. Это значение не может быть нулевым или отрицательным, за исключением использования -1, чтобы указать, что время жизни сообщения бесконечно. инт
название очереди Имя очереди хранилища в учетной записи хранения, которая является назначением подписки на событие. струна
идентификатор ресурса Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является назначением подписки на событие. струна

СтрокаНачинаетсяСРасширеннымФильтром

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

СтрокаСодержитРасширенныйФильтр

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

StringEndsWithAdvancedFilter (СтрокаЗаканчивается с AdvancedFilter)

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

СтрокаВДополнительном Фильтре

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter (СтрокаNotEndsWithAdvancedFilter)

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

StringNotInAdvancedFilter (СтрокаNotInAdvancedFilter)

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
maxEventsPerBatch Максимальное количество событий в пакете. инт
minimumTlsVersionAllowed Минимальная версия TLS, которая должна поддерживаться конечной точкой веб-перехватчика '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Предпочтительный размер пакета в Килобайтах. инт