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


События Microsoft.EventGrid eventSubscriptions

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

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

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

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

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2024-12-15-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: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        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'
  }
}

Объекты DeliveryAttributeMapping

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

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

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

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

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

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

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

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

AdvancedFilter

Имя Описание Ценность
ключ Поле или свойство в событии, на основе которого требуется отфильтровать. струна
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 Максимальное количество событий в пакете. int
preferredBatchSizeInKilobytes Предпочтительный размер пакета в Килобайтах. int
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на событие. струна

BoolEqualsAdvancedFilter

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

DeadLetterDestination

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

DeadLetterWithResourceIdentity

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

DeliveryAttributeMapping

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

DeliveryWithResourceIdentity

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

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

Имя Описание Ценность
endpointType Установите значение AzureFunction для типа AzureFunctionEventSubscriptionDestination. Установите значение EventHub для типа 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 Массив расширенных фильтров, используемых для фильтрации подписок на события. AdvancedFilter[]
enableAdvancedFilteringOnArrays Позволяет вычислять расширенные фильтры по массиву значений вместо ожидания сингулярного значения. bool
includedEventTypes Список применимых типов событий, которые должны быть частью подписки на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. string[]
isSubjectCaseSensitive Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра
следует сравнить с учетом регистра.
bool
subjectBeginsWith Необязательная строка для фильтрации событий подписки на основе префикса пути к ресурсу.
Формат этого зависит от издателя событий.
Подстановочные знаки не поддерживаются в этом пути.
струна
subjectEndsWith Необязательная строка для фильтрации событий подписки на основе суффикса пути к ресурсу.
Подстановочные знаки не поддерживаются в этом пути.
струна

EventSubscriptionIdentity

Имя Описание Ценность
federatedIdentityCredentialInfo Сведения о федеративных учетных данных удостоверениях (FIC), используемых при доставке ресурсов. FederatedIdentityCredentialInfo
тип Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. SystemAssigned
UserAssigned
userAssignedIdentity Удостоверение пользователя, связанное с ресурсом. струна

EventSubscriptionProperties

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

FederatedIdentityCredentialInfo

Имя Описание Ценность
федеративныйClientId Приложение AAD с несколькими клиентами, с которым связаны учетные данные федеративного удостоверения (FIC). струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (обязательно)

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

Microsoft.EventGrid/eventSubscriptions

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

MonitorAlertEventSubscriptionDestination

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

MonitorAlertEventSubscriptionDestinationProperties

Имя Описание Ценность
actionGroups Список идентификаторов ARM групп действий, которые будут активироваться при каждом оповещении, запущенном с помощью этой подписки на событие.
Каждый идентификатор RESOURCE ARM должен соответствовать этому шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
описание Описание, которое будет присоединено к каждому оповещению, запущенному через эту подписку на событие. струна
суровость Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на события.
Это поле должно быть предоставлено.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

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

NamespaceTopicEventSubscriptionDestinationProperties

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

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[][]

PartnerEventSubscriptionDestination

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

PartnerEventSubscriptionDestinationProperties

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

RetryPolicy

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationProperties

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

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationProperties

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

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

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[]

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

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

Примеры краткого руководства

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

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

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

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

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

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

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2024-12-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": {
        "federatedIdentityCredentialInfo": {
          "federatedClientId": "string"
        },
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "deliveryWithResourceIdentity": {
      "destination": {
        "endpointType": "string"
        // For remaining properties, see EventSubscriptionDestination objects
      },
      "identity": {
        "federatedIdentityCredentialInfo": {
          "federatedClientId": "string"
        },
        "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"
  }
}

Объекты DeliveryAttributeMapping

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

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

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

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

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

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

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

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

AdvancedFilter

Имя Описание Ценность
ключ Поле или свойство в событии, на основе которого требуется отфильтровать. струна
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 Максимальное количество событий в пакете. int
preferredBatchSizeInKilobytes Предпочтительный размер пакета в Килобайтах. int
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на событие. струна

BoolEqualsAdvancedFilter

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

DeadLetterDestination

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

DeadLetterWithResourceIdentity

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

DeliveryAttributeMapping

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

DeliveryWithResourceIdentity

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

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

Имя Описание Ценность
endpointType Установите значение AzureFunction для типа AzureFunctionEventSubscriptionDestination. Установите значение EventHub для типа 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 Массив расширенных фильтров, используемых для фильтрации подписок на события. AdvancedFilter[]
enableAdvancedFilteringOnArrays Позволяет вычислять расширенные фильтры по массиву значений вместо ожидания сингулярного значения. bool
includedEventTypes Список применимых типов событий, которые должны быть частью подписки на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. string[]
isSubjectCaseSensitive Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра
следует сравнить с учетом регистра.
bool
subjectBeginsWith Необязательная строка для фильтрации событий подписки на основе префикса пути к ресурсу.
Формат этого зависит от издателя событий.
Подстановочные знаки не поддерживаются в этом пути.
струна
subjectEndsWith Необязательная строка для фильтрации событий подписки на основе суффикса пути к ресурсу.
Подстановочные знаки не поддерживаются в этом пути.
струна

EventSubscriptionIdentity

Имя Описание Ценность
federatedIdentityCredentialInfo Сведения о федеративных учетных данных удостоверениях (FIC), используемых при доставке ресурсов. FederatedIdentityCredentialInfo
тип Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. SystemAssigned
UserAssigned
userAssignedIdentity Удостоверение пользователя, связанное с ресурсом. струна

EventSubscriptionProperties

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

FederatedIdentityCredentialInfo

Имя Описание Ценность
федеративныйClientId Приложение AAD с несколькими клиентами, с которым связаны учетные данные федеративного удостоверения (FIC). струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (обязательно)

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

Microsoft.EventGrid/eventSubscriptions

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

MonitorAlertEventSubscriptionDestination

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

MonitorAlertEventSubscriptionDestinationProperties

Имя Описание Ценность
actionGroups Список идентификаторов ARM групп действий, которые будут активироваться при каждом оповещении, запущенном с помощью этой подписки на событие.
Каждый идентификатор RESOURCE ARM должен соответствовать этому шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
описание Описание, которое будет присоединено к каждому оповещению, запущенному через эту подписку на событие. струна
суровость Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на события.
Это поле должно быть предоставлено.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

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

NamespaceTopicEventSubscriptionDestinationProperties

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

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[][]

PartnerEventSubscriptionDestination

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

PartnerEventSubscriptionDestinationProperties

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

RetryPolicy

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationProperties

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

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationProperties

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

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

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[]

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

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

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

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

Шаблон Описание
создание настраиваемой темы сетки событий 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-12-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 = {
          federatedIdentityCredentialInfo = {
            federatedClientId = "string"
          }
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      deliveryWithResourceIdentity = {
        destination = {
          endpointType = "string"
          // For remaining properties, see EventSubscriptionDestination objects
        }
        identity = {
          federatedIdentityCredentialInfo = {
            federatedClientId = "string"
          }
          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"
  }
}

Объекты DeliveryAttributeMapping

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

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

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

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

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

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

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

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

AdvancedFilter

Имя Описание Ценность
ключ Поле или свойство в событии, на основе которого требуется отфильтровать. струна
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 Максимальное количество событий в пакете. int
preferredBatchSizeInKilobytes Предпочтительный размер пакета в Килобайтах. int
resourceId Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на событие. струна

BoolEqualsAdvancedFilter

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

DeadLetterDestination

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

DeadLetterWithResourceIdentity

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

DeliveryAttributeMapping

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

DeliveryWithResourceIdentity

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

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

Имя Описание Ценность
endpointType Установите значение AzureFunction для типа AzureFunctionEventSubscriptionDestination. Установите значение EventHub для типа 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 Массив расширенных фильтров, используемых для фильтрации подписок на события. AdvancedFilter[]
enableAdvancedFilteringOnArrays Позволяет вычислять расширенные фильтры по массиву значений вместо ожидания сингулярного значения. bool
includedEventTypes Список применимых типов событий, которые должны быть частью подписки на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. string[]
isSubjectCaseSensitive Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра
следует сравнить с учетом регистра.
bool
subjectBeginsWith Необязательная строка для фильтрации событий подписки на основе префикса пути к ресурсу.
Формат этого зависит от издателя событий.
Подстановочные знаки не поддерживаются в этом пути.
струна
subjectEndsWith Необязательная строка для фильтрации событий подписки на основе суффикса пути к ресурсу.
Подстановочные знаки не поддерживаются в этом пути.
струна

EventSubscriptionIdentity

Имя Описание Ценность
federatedIdentityCredentialInfo Сведения о федеративных учетных данных удостоверениях (FIC), используемых при доставке ресурсов. FederatedIdentityCredentialInfo
тип Тип управляемого удостоверения, используемого. Может быть либо SystemAssigned, либо UserAssigned. SystemAssigned
UserAssigned
userAssignedIdentity Удостоверение пользователя, связанное с ресурсом. струна

EventSubscriptionProperties

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

FederatedIdentityCredentialInfo

Имя Описание Ценность
федеративныйClientId Приложение AAD с несколькими клиентами, с которым связаны учетные данные федеративного удостоверения (FIC). струна

Ограничения целостности:
Минимальная длина = 36
Максимальная длина = 36
Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (обязательно)

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

Microsoft.EventGrid/eventSubscriptions

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

MonitorAlertEventSubscriptionDestination

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

MonitorAlertEventSubscriptionDestinationProperties

Имя Описание Ценность
actionGroups Список идентификаторов ARM групп действий, которые будут активироваться при каждом оповещении, запущенном с помощью этой подписки на событие.
Каждый идентификатор RESOURCE ARM должен соответствовать этому шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
описание Описание, которое будет присоединено к каждому оповещению, запущенному через эту подписку на событие. струна
суровость Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на события.
Это поле должно быть предоставлено.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

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

NamespaceTopicEventSubscriptionDestinationProperties

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

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[][]

PartnerEventSubscriptionDestination

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

PartnerEventSubscriptionDestinationProperties

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

RetryPolicy

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationProperties

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

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationProperties

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

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

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[]

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

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