Microsoft.EventGrid eventSubscriptions
Определение ресурса Bicep
Тип ресурса eventSubscriptions является ресурсом расширения, что означает, что его можно применить к другому ресурсу.
scope
Используйте свойство этого ресурса, чтобы задать область для этого ресурса. См. раздел Настройка область для ресурсов расширения в Bicep.
Тип ресурса eventSubscriptions можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
- Подписки — см. команды развертывания подписки.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.EventGrid/eventSubscriptions, добавьте в шаблон следующий код Bicep.
resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview' = {
name: 'string'
scope: resourceSymbolicName
properties: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
deadLetterWithResourceIdentity: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
deliveryWithResourceIdentity: {
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
identity: {
type: 'string'
userAssignedIdentity: 'string'
}
}
destination: {
endpointType: 'string'
// For remaining properties, see EventSubscriptionDestination objects
}
eventDeliverySchema: 'string'
expirationTimeUtc: 'string'
filter: {
advancedFilters: [
{
key: 'string'
operatorType: 'string'
// For remaining properties, see AdvancedFilter objects
}
]
enableAdvancedFilteringOnArrays: bool
includedEventTypes: [
'string'
]
isSubjectCaseSensitive: bool
subjectBeginsWith: 'string'
subjectEndsWith: 'string'
}
labels: [
'string'
]
retryPolicy: {
eventTimeToLiveInMinutes: int
maxDeliveryAttempts: int
}
}
}
Объекты DeadLetterDestination
Задайте свойство endpointType , чтобы указать тип объекта .
Для StorageBlob используйте:
endpointType: 'StorageBlob'
properties: {
blobContainerName: 'string'
resourceId: 'string'
}
Объекты EventSubscriptionDestination
Задайте свойство endpointType , чтобы указать тип объекта .
Для AzureFunction используйте:
endpointType: 'AzureFunction'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
maxEventsPerBatch: int
preferredBatchSizeInKilobytes: int
resourceId: 'string'
}
Для EventHub используйте:
endpointType: 'EventHub'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
Для HybridConnection используйте:
endpointType: 'HybridConnection'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
Для 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
}
Объекты DeliveryAttributeMapping
Задайте свойство type , чтобы указать тип объекта .
Для dynamic используйте:
type: 'Dynamic'
properties: {
sourceField: 'string'
}
Для static используйте:
type: 'Static'
properties: {
isSecret: bool
value: 'string'
}
Объекты AdvancedFilter
Задайте свойство operatorType , чтобы указать тип объекта .
Для BoolEquals используйте:
operatorType: 'BoolEquals'
value: bool
Для IsNotNull используйте:
operatorType: 'IsNotNull'
Для Параметра IsNullOrUndefined используйте:
operatorType: 'IsNullOrUndefined'
Для NumberGreaterThan используйте:
operatorType: 'NumberGreaterThan'
value: int
Для NumberGreaterThanOrEquals используйте:
operatorType: 'NumberGreaterThanOrEquals'
value: int
Для NumberIn используйте:
operatorType: 'NumberIn'
values: [
int
]
Для NumberInRange используйте:
operatorType: 'NumberInRange'
values: [
[
int
]
]
Для NumberLessThan используйте:
operatorType: 'NumberLessThan'
value: int
Для NumberLessThanOrEquals используйте:
operatorType: 'NumberLessThanOrEquals'
value: int
Для NumberNotIn используйте:
operatorType: 'NumberNotIn'
values: [
int
]
Для NumberNotInRange используйте:
operatorType: 'NumberNotInRange'
values: [
[
int
]
]
Для StringBeginsWith используйте:
operatorType: 'StringBeginsWith'
values: [
'string'
]
Для StringContains используйте:
operatorType: 'StringContains'
values: [
'string'
]
Для StringEndsWith используйте:
operatorType: 'StringEndsWith'
values: [
'string'
]
Для StringIn используйте:
operatorType: 'StringIn'
values: [
'string'
]
Для StringNotBeginsWith используйте:
operatorType: 'StringNotBeginsWith'
values: [
'string'
]
Для StringNotContains используйте:
operatorType: 'StringNotContains'
values: [
'string'
]
Для StringNotEndsWith используйте:
operatorType: 'StringNotEndsWith'
values: [
'string'
]
Для StringNotIn используйте:
operatorType: 'StringNotIn'
values: [
'string'
]
Значения свойств
eventSubscriptions
Имя | Описание | Значение |
---|---|---|
name | имя ресурса. | строка (обязательно) Ограничение символов: 3–64 Допустимые символы: Буквенно-цифровые символы и дефисы. |
область | Используйте при создании ресурса расширения на область, отличном от область развертывания. | Целевой ресурс Для Bicep задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения. |
properties | Свойства подписки на события. | EventSubscriptionProperties |
EventSubscriptionProperties
Имя | Описание | Значение |
---|---|---|
deadLetterDestination | Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения , отправляется в место назначения недоставленных сообщений. Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
DeadLetterDestination |
deadLetterWithResourceIdentity | Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленных сообщений. Использует настройку управляемого удостоверения в родительском ресурсе (а именно в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки сообщений. |
DeadLetterWithResourceIdentity |
deliveryWithResourceIdentity | Сведения о назначении, куда должны быть доставлены события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки сообщений. |
DeliveryWithResourceIdentity |
ресурс destination | Сведения о назначении, куда должны быть доставлены события для подписки на события. Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
EventSubscriptionDestination |
eventDeliverySchema | Схема доставки событий для подписки на события. | 'CloudEventSchemaV1_0' CustomInputSchema EventGridSchema |
expirationTimeUtc | Время истечения срока действия подписки на событие. | строка |
фильтр | Сведения о фильтре для подписки на события. | EventSubscriptionFilter |
метки; | Список пользовательских меток. | string[] |
retryPolicy | Политика повтора для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. | RetryPolicy |
DeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | StorageBlob (обязательно) |
StorageBlobDeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения недоставленных сообщений | StorageBlob (обязательно) |
properties | Свойства назначения недоставки на основе BLOB-объектов хранилища | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
Имя | Описание | Значение |
---|---|---|
blobContainerName | Имя контейнера BLOB-объектов хранилища, который является местом назначения событий недоставки. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, которая является местом назначения событий недоставки | строка |
DeadLetterWithResourceIdentity
Имя | Описание | Значение |
---|---|---|
deadLetterDestination | Сведения о назначении, куда должны быть доставлены события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки сообщений. |
DeadLetterDestination |
удостоверение | Удостоверение, используемое при недоставленных событиях. | EventSubscriptionIdentity |
EventSubscriptionIdentity
Имя | Описание | Значение |
---|---|---|
тип | Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор назначаемых пользователем удостоверений. Тип None приведет к удалению всех удостоверений. | SystemAssigned UserAssigned |
userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | строка |
DeliveryWithResourceIdentity
Имя | Описание | Значение |
---|---|---|
ресурс destination | Сведения о назначении, куда должны быть доставлены события для подписки на события. Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
EventSubscriptionDestination |
удостоверение | Удостоверение, используемое при доставке событий. | EventSubscriptionIdentity |
EventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | AzureFunction EventHub HybridConnection MonitorAlert NamespaceTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue Веб-перехватчик (обязательно) |
AzureFunctionEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | AzureFunction (обязательно) |
properties | Свойства функции Azure назначения подписки на события. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
maxEventsPerBatch | Максимальное число событий в пакете. | INT |
preferredBatchSizeInKilobytes | Предпочтительный размер пакета в килобайтах. | INT |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на события. | строка |
DeliveryAttributeMapping
Имя | Описание | Значение |
---|---|---|
name | Имя атрибута доставки или заголовка. | строка |
type | Установка типа объекта | динамически; Static (обязательно) |
DynamicDeliveryAttributeMapping
Имя | Описание | Значение |
---|---|---|
тип | Тип атрибута доставки или имени заголовка. | Dynamic (обязательно) |
properties | Свойства сопоставления атрибутов динамической доставки. | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
Имя | Описание | Значение |
---|---|---|
sourceField | Путь JSON в событии, которое содержит значение атрибута. | строка |
StaticDeliveryAttributeMapping
Имя | Описание | Значение |
---|---|---|
тип | Тип атрибута доставки или имени заголовка. | Static (обязательно) |
properties | Свойства сопоставления атрибутов статической доставки. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
Имя | Описание | Значение |
---|---|---|
isSecret | Логический флаг, который указывает, содержит ли атрибут конфиденциальную информацию . | bool |
значение | Значение атрибута доставки. | строка |
EventHubEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | EventHub (обязательно) |
properties | Свойства концентратора событий назначения подписки на события. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения концентратора событий подписки на события. | строка |
HybridConnectionEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | HybridConnection (обязательно) |
properties | Свойства гибридного подключения для назначения подписки на события. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. | строка |
MonitorAlertEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | MonitorAlert (обязательно) |
properties | Мониторинг свойств оповещений назначения подписки на события. | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
actionGroups | Список идентификаторов ARM групп действий, которые будут запускаться при каждом оповещении, запущенном с помощью этой подписки на событие. Каждый идентификатор ARM ресурса должен соответствовать следующему шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}. |
string[] |
description | Описание, которое будет присоединено к каждому оповещению, запущенному через эту подписку на событие. | строка |
severity | Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на событие. Это поле должно быть указано. |
'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4' |
NamespaceTopicEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | NamespaceTopic (обязательно) |
properties | Свойства раздела пространства имен назначения подписки на события. | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения раздела пространства имен Сетки событий подписки на события. Это поле является обязательным, и ресурс раздела пространства имен уже должен существовать. Идентификатор ARM ресурса должен соответствовать следующему шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}. |
строка |
PartnerEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | PartnerDestination (обязательно) |
properties | Назначение партнера. Свойства назначения подписки на события. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения партнера подписки на события. | строка |
ServiceBusQueueEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | ServiceBusQueue (обязательно) |
properties | Свойства служебной шины назначения подписки на события. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения служебной шины подписки на события. | строка |
ServiceBusTopicEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | ServiceBusTopic (обязательно) |
properties | Свойства раздела служебной шины назначения подписки на события. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения раздела служебной шины подписки на события. | строка |
StorageQueueEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | StorageQueue (обязательно) |
properties | Свойства очереди хранилища назначения подписки на события. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
queueMessageTimeToLiveInSeconds | Время жизни сообщения очереди хранилища в секундах. Это значение не может быть равно нулю или отрицательному значению, за исключением использования -1, чтобы указать, что время жизни сообщения бесконечно. | INT |
queueName | Имя очереди хранилища в учетной записи хранения, которая является местом назначения подписки на события. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является местом назначения подписки на события. | строка |
WebHookEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | WebHook (обязательно) |
properties | Свойства веб-перехватчика назначения подписки на события. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
azureActiveDirectoryApplicationIdOrUri | Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в запросы на доставку в качестве маркера носителя. | строка |
azureActiveDirectoryTenantId | Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в запросы на доставку в качестве маркера носителя. | строка |
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
endpointUrl | URL-адрес, представляющий конечную точку назначения подписки на события. | строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
maxEventsPerBatch | Максимальное количество событий на пакет. | INT |
minimumTlsVersionAllowed | Минимальная версия TLS, которая должна поддерживаться конечной точкой веб-перехватчика | '1.0' '1.1' '1.2' |
preferredBatchSizeInKilobytes | Предпочтительный размер пакета в килобайтах. | INT |
EventSubscriptionFilter
Имя | Описание | Значение |
---|---|---|
advancedFilters | Массив расширенных фильтров, используемых для фильтрации подписок на события. | AdvancedFilter[] |
enableAdvancedFilteringOnArrays | Позволяет оценивать расширенные фильтры по массиву значений, а не ожидать единственного значения. | bool |
includedEventTypes | Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. | string[] |
isSubjectCaseSensitive | Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра. следует сравнивать с учетом регистра. |
bool |
subjectBeginsWith | Необязательная строка для фильтрации событий для подписки на события на основе префикса пути к ресурсу. Формат зависит от издателя событий. Подстановочные знаки не поддерживаются в этом пути. |
строка |
subjectEndsWith | Необязательная строка для фильтрации событий для подписки на события на основе суффикса пути к ресурсу. Подстановочные знаки не поддерживаются в этом пути. |
строка |
AdvancedFilter
Имя | Описание | Значение |
---|---|---|
key | Поле или свойство в событии в зависимости от того, по которому требуется выполнить фильтрацию. | строка |
operatorType | Установка типа объекта | BoolEquals IsNotNull IsNullOrUndefined NumberGreaterThan; NumberGreaterThanOrEquals; NumberIn; NumberInRange NumberLessThan; NumberGreaterThanOrEquals; NumberNotIn. NumberNotInRange StringBeginsWith; StringContains; StringEndsWith; StringIn; StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (обязательно) |
BoolEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | BoolEquals (обязательно) |
значение | Значение логического фильтра. | bool |
IsNotNullAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | IsNotNull (обязательно) |
IsNullOrUndefinedAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | IsNullOrUndefined (обязательно) |
NumberGreaterThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberGreaterThan (обязательно) |
значение | Значение фильтра. | INT |
NumberGreaterThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberGreaterThanOrEquals (обязательно) |
значение | Значение фильтра. | INT |
NumberInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "NumberIn" (обязательно) |
значения | Набор значений фильтра. | int[] |
NumberInRangeAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberInRange (обязательно) |
значения | Набор значений фильтра. | int[][] |
NumberLessThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberLessThan (обязательно) |
значение | Значение фильтра. | INT |
NumberLessThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberLessThanOrEquals (обязательно) |
значение | Значение фильтра. | INT |
NumberNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberNotIn (обязательно) |
значения | Набор значений фильтра. | int[] |
NumberNotInRangeAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberNotInRange (обязательно) |
значения | Набор значений фильтра. | int[][] |
StringBeginsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringBeginsWith (обязательно) |
значения | Набор значений фильтра. | string[] |
StringContainsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringContains (обязательно) |
значения | Набор значений фильтра. | string[] |
StringEndsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringEndsWith (обязательно) |
значения | Набор значений фильтра. | string[] |
StringInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringIn (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotBeginsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringNotBeginsWith (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotContainsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringNotContains (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotEndsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringNotEndsWith (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringNotIn (обязательно) |
значения | Набор значений фильтра. | string[] |
политика RetryPolicy
Имя | Описание | Значение |
---|---|---|
eventTimeToLiveInMinutes | Время жизни (в минутах) для событий. | INT |
maxDeliveryAttempts | Максимальное число повторных попыток доставки для событий. | INT |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
Шаблон | Описание |
---|---|
Создание пользовательского раздела и подписки Сетка событий Azure |
Создает Сетка событий Azure пользовательский раздел и подписку веб-перехватчика. Шаблон первоначально автор Джон Даусс. |
Раздел или подписка пользовательского Сетка событий Azure с помощью CloudEvents |
Создает пользовательский Сетка событий Azure раздел, подписку веб-перехватчика со схемой CloudEvents и приложение логики в качестве обработчика событий. Шаблон первоначально автор Джастин Йо. |
Создание пользовательского раздела и обработчика концентратора событий Сетки событий |
Создает Сетка событий Azure настраиваемый раздел и концентратор событий для обработки событий. |
Создание подписки службы "Сетка событий" для событий ресурсов |
Создает подписку сетки событий для группы ресурсов или подписки Azure. |
Создание Сетка событий Azure настраиваемой подписки на раздел и очередь |
Создает Сетка событий Azure настраиваемый раздел и подписку очереди служебной шины. Шаблон, автор : Маркус Мейер. |
Создание подписки Сетка событий Azure пользовательских разделов |
Создает Сетка событий Azure пользовательский раздел и подписку на раздел служебной шины. Шаблон, автор : Маркус Мейер. |
Определение ресурса шаблона ARM
Тип ресурса eventSubscriptions является ресурсом расширения, что означает, что его можно применить к другому ресурсу.
scope
Используйте свойство этого ресурса, чтобы задать область для этого ресурса. См. раздел Настройка область для ресурсов расширения в шаблонах ARM.
Тип ресурса eventSubscriptions можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
- Подписки — см. команды развертывания подписки.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.EventGrid/eventSubscriptions, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.EventGrid/eventSubscriptions",
"apiVersion": "2023-12-15-preview",
"name": "string",
"scope": "string",
"properties": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"deadLetterWithResourceIdentity": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"deliveryWithResourceIdentity": {
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"eventDeliverySchema": "string",
"expirationTimeUtc": "string",
"filter": {
"advancedFilters": [
{
"key": "string",
"operatorType": "string"
// For remaining properties, see AdvancedFilter objects
}
],
"enableAdvancedFilteringOnArrays": "bool",
"includedEventTypes": [ "string" ],
"isSubjectCaseSensitive": "bool",
"subjectBeginsWith": "string",
"subjectEndsWith": "string"
},
"labels": [ "string" ],
"retryPolicy": {
"eventTimeToLiveInMinutes": "int",
"maxDeliveryAttempts": "int"
}
}
}
Объекты DeadLetterDestination
Задайте свойство endpointType , чтобы указать тип объекта .
Для StorageBlob используйте:
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "string",
"resourceId": "string"
}
Объекты EventSubscriptionDestination
Задайте свойство endpointType , чтобы указать тип объекта .
Для AzureFunction используйте:
"endpointType": "AzureFunction",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"maxEventsPerBatch": "int",
"preferredBatchSizeInKilobytes": "int",
"resourceId": "string"
}
Для EventHub используйте:
"endpointType": "EventHub",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
Для HybridConnection используйте:
"endpointType": "HybridConnection",
"properties": {
"deliveryAttributeMappings": [
{
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
],
"resourceId": "string"
}
Для 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"
}
Объекты DeliveryAttributeMapping
Задайте свойство type , чтобы указать тип объекта .
Для dynamic используйте:
"type": "Dynamic",
"properties": {
"sourceField": "string"
}
Для static используйте:
"type": "Static",
"properties": {
"isSecret": "bool",
"value": "string"
}
Объекты AdvancedFilter
Задайте свойство operatorType , чтобы указать тип объекта .
Для BoolEquals используйте:
"operatorType": "BoolEquals",
"value": "bool"
Для IsNotNull используйте:
"operatorType": "IsNotNull"
Для Параметра IsNullOrUndefined используйте:
"operatorType": "IsNullOrUndefined"
Для NumberGreaterThan используйте:
"operatorType": "NumberGreaterThan",
"value": "int"
Для NumberGreaterThanOrEquals используйте:
"operatorType": "NumberGreaterThanOrEquals",
"value": "int"
Для NumberIn используйте:
"operatorType": "NumberIn",
"values": [ "int" ]
Для NumberInRange используйте:
"operatorType": "NumberInRange",
"values": [ [ "int" ] ]
Для NumberLessThan используйте:
"operatorType": "NumberLessThan",
"value": "int"
Для NumberLessThanOrEquals используйте:
"operatorType": "NumberLessThanOrEquals",
"value": "int"
Для NumberNotIn используйте:
"operatorType": "NumberNotIn",
"values": [ "int" ]
Для NumberNotInRange используйте:
"operatorType": "NumberNotInRange",
"values": [ [ "int" ] ]
Для StringBeginsWith используйте:
"operatorType": "StringBeginsWith",
"values": [ "string" ]
Для StringContains используйте:
"operatorType": "StringContains",
"values": [ "string" ]
Для StringEndsWith используйте:
"operatorType": "StringEndsWith",
"values": [ "string" ]
Для StringIn используйте:
"operatorType": "StringIn",
"values": [ "string" ]
Для StringNotBeginsWith используйте:
"operatorType": "StringNotBeginsWith",
"values": [ "string" ]
Для StringNotContains используйте:
"operatorType": "StringNotContains",
"values": [ "string" ]
Для StringNotEndsWith используйте:
"operatorType": "StringNotEndsWith",
"values": [ "string" ]
Для StringNotIn используйте:
"operatorType": "StringNotIn",
"values": [ "string" ]
Значения свойств
eventSubscriptions
Имя | Описание | Значение |
---|---|---|
тип | Тип ресурса | Microsoft.EventGrid/eventSubscriptions |
версия_API | Версия API ресурсов | '15.12.2023-preview' |
name | имя ресурса. | строка (обязательно) Ограничение символов: 3–64 Допустимые символы: Буквенно-цифровые символы и дефисы. |
область | Используйте при создании ресурса расширения на область, отличном от область развертывания. | Целевой ресурс Для JSON задайте полное имя ресурса, к который будет применяться ресурс расширения . |
properties | Свойства подписки на события. | EventSubscriptionProperties |
EventSubscriptionProperties
Имя | Описание | Значение |
---|---|---|
deadLetterDestination | Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения , отправляется в место назначения недоставленных сообщений. Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
DeadLetterDestination |
deadLetterWithResourceIdentity | Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения , отправляется в место назначения недоставленных сообщений. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
DeadLetterWithResourceIdentity |
deliveryWithResourceIdentity | Сведения о назначении, куда должны доставляться события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
DeliveryWithResourceIdentity |
ресурс destination | Сведения о назначении, куда должны доставляться события для подписки на события. Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
EventSubscriptionDestination |
eventDeliverySchema | Схема доставки событий для подписки на события. | "CloudEventSchemaV1_0" CustomInputSchema EventGridSchema |
expirationTimeUtc | Срок действия подписки на события. | строка |
фильтр | Сведения о фильтре для подписки на события. | EventSubscriptionFilter |
метки; | Список пользовательских меток. | string[] |
retryPolicy | Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. | RetryPolicy |
DeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | StorageBlob (обязательно) |
StorageBlobDeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения недоставленных сообщений | StorageBlob (обязательно) |
properties | Свойства назначения недоставленных сообщений на основе BLOB-объектов хранилища | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
Имя | Описание | Значение |
---|---|---|
blobContainerName | Имя контейнера больших двоичных объектов хранилища, который является местом назначения событий недоставленных сообщений. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, которая является местом назначения событий недоставленных сообщений. | строка |
DeadLetterWithResourceIdentity
Имя | Описание | Значение |
---|---|---|
deadLetterDestination | Сведения о назначении, куда должны доставляться события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
DeadLetterDestination |
удостоверение | Удостоверение, используемое при недоставленных событиях. | EventSubscriptionIdentity |
EventSubscriptionIdentity
Имя | Описание | Значение |
---|---|---|
тип | Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None приведет к удалению всех удостоверений. | SystemAssigned UserAssigned |
userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | строка |
DeliveryWithResourceIdentity
Имя | Описание | Значение |
---|---|---|
ресурс destination | Сведения о назначении, куда должны доставляться события для подписки на события. Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
EventSubscriptionDestination |
удостоверение | Удостоверение, используемое при доставке событий. | EventSubscriptionIdentity |
EventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | AzureFunction EventHub Гибридное подключение MonitorAlert Пространство именTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue Веб-перехватчик (обязательно) |
AzureFunctionEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | AzureFunction (обязательно) |
properties | Свойства функции Azure назначения подписки на события. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
maxEventsPerBatch | Максимальное количество событий на пакет. | INT |
preferredBatchSizeInKilobytes | Предпочтительный размер пакета в килобайтах. | INT |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на события. | строка |
DeliveryAttributeMapping
Имя | Описание | Значение |
---|---|---|
name | Имя атрибута или заголовка доставки. | строка |
type | Установка типа объекта | динамически; Static (обязательно) |
DynamicDeliveryAttributeMapping
Имя | Описание | Значение |
---|---|---|
тип | Тип атрибута доставки или имени заголовка. | Dynamic (обязательно) |
properties | Свойства сопоставления атрибутов динамической доставки. | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
Имя | Описание | Значение |
---|---|---|
sourceField | Путь JSON в событии, которое содержит значение атрибута. | строка |
StaticDeliveryAttributeMapping
Имя | Описание | Значение |
---|---|---|
тип | Тип атрибута доставки или имени заголовка. | Static (обязательно) |
properties | Свойства сопоставления атрибутов статической доставки. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
Имя | Описание | Значение |
---|---|---|
isSecret | Логический флаг, который указывает, содержит ли атрибут конфиденциальную информацию . | bool |
значение | Значение атрибута доставки. | строка |
EventHubEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | EventHub (обязательно) |
properties | Свойства концентратора событий назначения подписки на события. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения концентратора событий подписки на события. | строка |
HybridConnectionEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | HybridConnection (обязательно) |
properties | Свойства гибридного подключения для назначения подписки на события. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. | строка |
MonitorAlertEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | MonitorAlert (обязательно) |
properties | Мониторинг свойств оповещений назначения подписки на события. | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
actionGroups | Список идентификаторов ARM групп действий, которые будут запускаться при каждом оповещении, запущенном с помощью этой подписки на событие. Каждый идентификатор ARM ресурса должен соответствовать следующему шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}. |
string[] |
description | Описание, которое будет присоединено к каждому оповещению, запущенному через эту подписку на событие. | строка |
severity | Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на событие. Это поле должно быть указано. |
'Sev0' 'Sev1' 'Sev2' 'Sev3' 'Sev4' |
NamespaceTopicEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | NamespaceTopic (обязательно) |
properties | Свойства раздела пространства имен назначения подписки на события. | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения раздела пространства имен Сетки событий подписки на события. Это поле является обязательным, и ресурс раздела пространства имен уже должен существовать. Идентификатор ARM ресурса должен соответствовать следующему шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}. |
строка |
PartnerEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | PartnerDestination (обязательно) |
properties | Назначение партнера. Свойства назначения подписки на события. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения партнера подписки на события. | строка |
ServiceBusQueueEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | ServiceBusQueue (обязательно) |
properties | Свойства служебной шины назначения подписки на события. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения служебной шины подписки на события. | строка |
ServiceBusTopicEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | ServiceBusTopic (обязательно) |
properties | Свойства раздела служебной шины назначения подписки на события. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения раздела служебной шины подписки на события. | строка |
StorageQueueEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | StorageQueue (обязательно) |
properties | Свойства очереди хранилища назначения подписки на события. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
queueMessageTimeToLiveInSeconds | Время жизни сообщения очереди хранилища в секундах. Это значение не может быть равно нулю или отрицательному значению, за исключением использования значения -1, чтобы указать, что время жизни сообщения равно Бесконечно. | INT |
queueName | Имя очереди хранилища в учетной записи хранения, которая является местом назначения подписки на события. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является местом назначения подписки на события. | строка |
WebHookEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | "Веб-перехватчик" (обязательно) |
properties | Свойства веб-перехватчика назначения подписки на события. | 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 |
EventSubscriptionFilter
Имя | Описание | Значение |
---|---|---|
advancedFilters | Массив расширенных фильтров, используемых для фильтрации подписок на события. | AdvancedFilter[] |
enableAdvancedFilteringOnArrays | Позволяет вычислять расширенные фильтры по массиву значений, а не ожидать единственного значения. | bool |
includedEventTypes | Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий по умолчанию, присвойте параметру IncludedEventTypes значение NULL. | string[] |
isSubjectCaseSensitive | Указывает, если свойства SubjectBeginsWith и SubjectEndsWith фильтра следует сравнивать с учетом регистра. |
bool |
subjectBeginsWith | Необязательная строка для фильтрации событий для подписки на события на основе префикса пути к ресурсу. Формат зависит от издателя событий. Подстановочные знаки не поддерживаются в этом пути. |
строка |
subjectEndsWith | Необязательная строка для фильтрации событий для подписки на события на основе суффикса пути к ресурсу. Подстановочные знаки не поддерживаются в этом пути. |
строка |
AdvancedFilter
Имя | Описание | Значение |
---|---|---|
key | Поле или свойство в событии, по которому требуется отфильтровать. | строка |
operatorType | Установка типа объекта | BoolEquals IsNotNull IsNullOrUndefined NumberGreaterThan; NumberGreaterThanOrEquals; NumberIn; NumberInRange NumberLessThan; NumberGreaterThanOrEquals; NumberNotIn. NumberNotInRange StringBeginsWith; StringContains; StringEndsWith; StringIn; StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (обязательно) |
BoolEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | BoolEquals (обязательно) |
значение | Значение логического фильтра. | bool |
IsNotNullAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | IsNotNull (обязательно) |
IsNullOrUndefinedAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | IsNullOrUndefined (обязательно) |
NumberGreaterThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "NumberGreaterThan" (обязательно) |
значение | Значение фильтра. | INT |
NumberGreaterThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberGreaterThanOrEquals (обязательно) |
значение | Значение фильтра. | INT |
NumberInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberIn (обязательно) |
значения | Набор значений фильтра. | int[] |
NumberInRangeAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberInRange (обязательно) |
значения | Набор значений фильтра. | int[][] |
NumberLessThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberLessThan (обязательно) |
значение | Значение фильтра. | INT |
NumberLessThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberLessThanOrEquals (обязательно) |
значение | Значение фильтра. | INT |
NumberNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberNotIn (обязательно) |
значения | Набор значений фильтра. | int[] |
NumberNotInRangeAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | NumberNotInRange (обязательно) |
значения | Набор значений фильтра. | int[][] |
StringBeginsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringBeginsWith (обязательно) |
значения | Набор значений фильтра. | string[] |
StringContainsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringContains (обязательно) |
значения | Набор значений фильтра. | string[] |
StringEndsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringEndsWith (обязательно) |
значения | Набор значений фильтра. | string[] |
StringInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringIn (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotBeginsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringNotBeginsWith (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotContainsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringNotContains (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotEndsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringNotEndsWith (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringNotIn (обязательно) |
значения | Набор значений фильтра. | string[] |
политика RetryPolicy
Имя | Описание | Значение |
---|---|---|
eventTimeToLiveInMinutes | Время жизни (в минутах) для событий. | INT |
maxDeliveryAttempts | Максимальное число повторных попыток доставки для событий. | INT |
Шаблоны быстрого запуска
Следующие шаблоны быстрого запуска развертывают этот тип ресурса.
Шаблон | Описание |
---|---|
Создание пользовательского раздела и подписки Сетка событий Azure |
Создает Сетка событий Azure пользовательский раздел и подписку веб-перехватчика. Шаблон первоначально автор Джон Даусс. |
Раздел или подписка пользовательского Сетка событий Azure с помощью CloudEvents |
Создает пользовательский Сетка событий Azure раздел, подписку веб-перехватчика со схемой CloudEvents и приложение логики в качестве обработчика событий. Шаблон первоначально автор Джастин Йо. |
Создание пользовательского раздела и обработчика концентратора событий Сетки событий |
Создает Сетка событий Azure настраиваемый раздел и концентратор событий для обработки событий. |
Создание подписки службы "Сетка событий" для событий ресурсов |
Создает подписку сетки событий для группы ресурсов или подписки Azure. |
Создание Сетка событий Azure настраиваемой подписки на раздел и очередь |
Создает Сетка событий Azure настраиваемый раздел и подписку очереди служебной шины. Шаблон, автор : Маркус Мейер. |
Создание подписки Сетка событий Azure пользовательских разделов |
Создает Сетка событий Azure пользовательский раздел и подписку на раздел служебной шины. Шаблон, автор : Маркус Мейер. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса eventSubscriptions является ресурсом расширения, что означает, что его можно применить к другому ресурсу.
parent_id
Используйте свойство этого ресурса, чтобы задать область для этого ресурса.
Тип ресурса eventSubscriptions можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов
- Подписки
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.EventGrid/eventSubscriptions, добавьте в шаблон следующую terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/eventSubscriptions@2023-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 = {
type = "string"
userAssignedIdentity = "string"
}
}
deliveryWithResourceIdentity = {
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
eventDeliverySchema = "string"
expirationTimeUtc = "string"
filter = {
advancedFilters = [
{
key = "string"
operatorType = "string"
// For remaining properties, see AdvancedFilter objects
}
]
enableAdvancedFilteringOnArrays = bool
includedEventTypes = [
"string"
]
isSubjectCaseSensitive = bool
subjectBeginsWith = "string"
subjectEndsWith = "string"
}
labels = [
"string"
]
retryPolicy = {
eventTimeToLiveInMinutes = int
maxDeliveryAttempts = int
}
}
})
}
Объекты DeadLetterDestination
Задайте свойство endpointType , чтобы указать тип объекта .
Для StorageBlob используйте:
endpointType = "StorageBlob"
properties = {
blobContainerName = "string"
resourceId = "string"
}
Объекты EventSubscriptionDestination
Задайте свойство endpointType , чтобы указать тип объекта .
Для AzureFunction используйте:
endpointType = "AzureFunction"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
maxEventsPerBatch = int
preferredBatchSizeInKilobytes = int
resourceId = "string"
}
Для EventHub используйте:
endpointType = "EventHub"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
Для HybridConnection используйте:
endpointType = "HybridConnection"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
Для 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
}
Объекты DeliveryAttributeMapping
Задайте свойство type , чтобы указать тип объекта .
Для dynamic используйте:
type = "Dynamic"
properties = {
sourceField = "string"
}
Для static используйте:
type = "Static"
properties = {
isSecret = bool
value = "string"
}
Объекты AdvancedFilter
Задайте свойство operatorType , чтобы указать тип объекта .
Для BoolEquals используйте:
operatorType = "BoolEquals"
value = bool
Для IsNotNull используйте:
operatorType = "IsNotNull"
Для Параметра IsNullOrUndefined используйте:
operatorType = "IsNullOrUndefined"
Для NumberGreaterThan используйте:
operatorType = "NumberGreaterThan"
value = int
Для NumberGreaterThanOrEquals используйте:
operatorType = "NumberGreaterThanOrEquals"
value = int
Для NumberIn используйте:
operatorType = "NumberIn"
values = [
int
]
Для NumberInRange используйте:
operatorType = "NumberInRange"
values = [
[
int
]
]
Для NumberLessThan используйте:
operatorType = "NumberLessThan"
value = int
Для NumberLessThanOrEquals используйте:
operatorType = "NumberLessThanOrEquals"
value = int
Для NumberNotIn используйте:
operatorType = "NumberNotIn"
values = [
int
]
Для NumberNotInRange используйте:
operatorType = "NumberNotInRange"
values = [
[
int
]
]
Для StringBeginsWith используйте:
operatorType = "StringBeginsWith"
values = [
"string"
]
Для StringContains используйте:
operatorType = "StringContains"
values = [
"string"
]
Для StringEndsWith используйте:
operatorType = "StringEndsWith"
values = [
"string"
]
Для StringIn используйте:
operatorType = "StringIn"
values = [
"string"
]
Для StringNotBeginsWith используйте:
operatorType = "StringNotBeginsWith"
values = [
"string"
]
Для StringNotContains используйте:
operatorType = "StringNotContains"
values = [
"string"
]
Для StringNotEndsWith используйте:
operatorType = "StringNotEndsWith"
values = [
"string"
]
Для StringNotIn используйте:
operatorType = "StringNotIn"
values = [
"string"
]
Значения свойств
eventSubscriptions
Имя | Описание | Значение |
---|---|---|
тип | Тип ресурса | "Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview" |
name | имя ресурса. | строка (обязательно) Ограничение символов: 3–64 Допустимые символы: Буквенно-цифровые символы и дефисы. |
parent_id | Идентификатор ресурса, к который применяется этот ресурс расширения. | строка (обязательно) |
properties | Свойства подписки на события. | EventSubscriptionProperties |
EventSubscriptionProperties
Имя | Описание | Значение |
---|---|---|
deadLetterDestination | Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения , отправляется в место назначения недоставленных сообщений. Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
DeadLetterDestination |
deadLetterWithResourceIdentity | Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения , отправляется в место назначения недоставленных сообщений. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
DeadLetterWithResourceIdentity |
deliveryWithResourceIdentity | Сведения о назначении, куда должны доставляться события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
DeliveryWithResourceIdentity |
ресурс destination | Сведения о назначении, куда должны доставляться события для подписки на события. Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
EventSubscriptionDestination |
eventDeliverySchema | Схема доставки событий для подписки на события. | "CloudEventSchemaV1_0" CustomInputSchema "EventGridSchema" |
expirationTimeUtc | Срок действия подписки на события. | строка |
фильтр | Сведения о фильтре для подписки на события. | EventSubscriptionFilter |
метки; | Список пользовательских меток. | string[] |
retryPolicy | Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. | RetryPolicy |
DeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | StorageBlob (обязательно) |
StorageBlobDeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения недоставленных сообщений | StorageBlob (обязательно) |
properties | Свойства назначения недоставленных сообщений на основе BLOB-объектов хранилища | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
Имя | Описание | Значение |
---|---|---|
blobContainerName | Имя контейнера больших двоичных объектов хранилища, который является местом назначения событий недоставленных сообщений. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, которая является местом назначения событий недоставленных сообщений. | строка |
DeadLetterWithResourceIdentity
Имя | Описание | Значение |
---|---|---|
deadLetterDestination | Сведения о назначении, куда должны доставляться события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
DeadLetterDestination |
удостоверение | Удостоверение, используемое при недоставленных событиях. | EventSubscriptionIdentity |
EventSubscriptionIdentity
Имя | Описание | Значение |
---|---|---|
тип | Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None приведет к удалению всех удостоверений. | "SystemAssigned" UserAssigned |
userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | строка |
DeliveryWithResourceIdentity
Имя | Описание | Значение |
---|---|---|
ресурс destination | Сведения о назначении, куда должны доставляться события для подписки на события. Использует удостоверение Сетка событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений. |
EventSubscriptionDestination |
удостоверение | Удостоверение, используемое при доставке событий. | EventSubscriptionIdentity |
EventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | AzureFunction EventHub Гибридное подключение MonitorAlert Пространство именTopic PartnerDestination ServiceBusQueue ServiceBusTopic StorageQueue Веб-перехватчик (обязательно) |
AzureFunctionEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | AzureFunction (обязательно) |
properties | Свойства функции Azure назначения подписки на события. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
maxEventsPerBatch | Максимальное число событий в пакете. | INT |
preferredBatchSizeInKilobytes | Предпочтительный размер пакета в килобайтах. | INT |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на события. | строка |
DeliveryAttributeMapping
Имя | Описание | Значение |
---|---|---|
name | Имя атрибута доставки или заголовка. | строка |
type | Установка типа объекта | динамически; Static (обязательно) |
DynamicDeliveryAttributeMapping
Имя | Описание | Значение |
---|---|---|
тип | Тип атрибута доставки или имени заголовка. | "Dynamic" (обязательно) |
properties | Свойства сопоставления атрибутов динамической доставки. | DynamicDeliveryAttributeMappingProperties |
DynamicDeliveryAttributeMappingProperties
Имя | Описание | Значение |
---|---|---|
sourceField | Путь JSON в событии, которое содержит значение атрибута. | строка |
StaticDeliveryAttributeMapping
Имя | Описание | Значение |
---|---|---|
тип | Тип атрибута доставки или имени заголовка. | "Static" (обязательно) |
properties | Свойства сопоставления атрибутов статической доставки. | StaticDeliveryAttributeMappingProperties |
StaticDeliveryAttributeMappingProperties
Имя | Описание | Значение |
---|---|---|
isSecret | Логический флаг, который указывает, содержит ли атрибут конфиденциальную информацию . | bool |
значение | Значение атрибута доставки. | строка |
EventHubEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | "EventHub" (обязательно) |
properties | Свойства концентратора событий назначения подписки на события. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения концентратора событий подписки на события. | строка |
HybridConnectionEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | HybridConnection (обязательно) |
properties | Свойства гибридного подключения назначения подписки на события. | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. | строка |
MonitorAlertEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | MonitorAlert (обязательно) |
properties | Мониторинг свойств оповещений назначения подписки на события. | MonitorAlertEventSubscriptionDestinationProperties |
MonitorAlertEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
actionGroups | Список идентификаторов ARM групп действий, которые будут активироваться при каждом оповещении, запущенном в рамках этой подписки на событие. Каждый идентификатор ARM ресурса должен соответствовать следующему шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}. |
string[] |
description | Описание, которое будет вложено к каждому оповещению, запущенному через эту подписку на событие. | строка |
severity | Серьезность, которая будет присоединена к каждому оповещению, запущенному через эту подписку на событие. Это поле должно быть указано. |
"Sev0" "Sev1" "Sev2" "Sev3" "Sev4" |
NamespaceTopicEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | NamespaceTopic (обязательно) |
properties | Свойства раздела пространства имен назначения подписки на события. | NamespaceTopicEventSubscriptionDestinationProperties |
NamespaceTopicEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения раздела пространства имен Сетки событий подписки на события. Это поле является обязательным, и указанный ресурс раздела пространства имен уже должен существовать. Идентификатор ARM ресурса должен соответствовать следующему шаблону: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}. |
строка |
PartnerEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | PartnerDestination (обязательно) |
properties | Назначение партнера. Свойства назначения подписки на события. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения партнера подписки на события. | строка |
ServiceBusQueueEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | ServiceBusQueue (обязательно) |
properties | Свойства служебной шины назначения подписки на события. | ServiceBusQueueEventSubscriptionDestinationPropertie... |
ServiceBusQueueEventSubscriptionDestinationPropertie...
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения служебной шины подписки на события. | строка |
ServiceBusTopicEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | ServiceBusTopic (обязательно) |
properties | Свойства раздела служебной шины назначения подписки на события. | ServiceBusTopicEventSubscriptionDestinationPropertie... |
ServiceBusTopicEventSubscriptionDestinationPropertie...
Имя | Описание | Значение |
---|---|---|
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения раздела служебной шины подписки на события. | строка |
StorageQueueEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | StorageQueue (обязательно) |
properties | Свойства очереди хранилища назначения подписки на события. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
queueMessageTimeToLiveInSeconds | Время жизни сообщения очереди хранилища в секундах. Это значение не может быть равно нулю или отрицательному значению, за исключением использования -1, чтобы указать, что время жизни сообщения бесконечно. | INT |
queueName | Имя очереди хранилища в учетной записи хранения, которая является местом назначения подписки на события. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является местом назначения подписки на события. | строка |
WebHookEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события. | WebHook (обязательно) |
properties | Свойства веб-перехватчика назначения подписки на события. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
azureActiveDirectoryApplicationIdOrUri | Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в запросы на доставку в качестве маркера носителя. | строка |
azureActiveDirectoryTenantId | Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в запросы на доставку в качестве маркера носителя. | строка |
deliveryAttributeMappings | Сведения об атрибуте доставки. | DeliveryAttributeMapping[] |
endpointUrl | URL-адрес, представляющий конечную точку назначения подписки на события. | строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
maxEventsPerBatch | Максимальное количество событий на пакет. | INT |
minimumTlsVersionAllowed | Минимальная версия TLS, которая должна поддерживаться конечной точкой веб-перехватчика | "1.0" "1.1" "1.2" |
preferredBatchSizeInKilobytes | Предпочтительный размер пакета в килобайтах. | INT |
EventSubscriptionFilter
Имя | Описание | Значение |
---|---|---|
advancedFilters | Массив расширенных фильтров, используемых для фильтрации подписок на события. | AdvancedFilter[] |
enableAdvancedFilteringOnArrays | Позволяет оценивать расширенные фильтры по массиву значений, а не ожидать единственного значения. | bool |
includedEventTypes | Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. | string[] |
isSubjectCaseSensitive | Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра. следует сравнивать с учетом регистра. |
bool |
subjectBeginsWith | Необязательная строка для фильтрации событий для подписки на события на основе префикса пути к ресурсу. Формат зависит от издателя событий. Подстановочные знаки не поддерживаются в этом пути. |
строка |
subjectEndsWith | Необязательная строка для фильтрации событий для подписки на события на основе суффикса пути к ресурсу. Подстановочные знаки не поддерживаются в этом пути. |
строка |
AdvancedFilter
Имя | Описание | Значение |
---|---|---|
key | Поле или свойство в событии в зависимости от того, по которому требуется выполнить фильтрацию. | строка |
operatorType | Установка типа объекта | BoolEquals IsNotNull IsNullOrUndefined NumberGreaterThan; NumberGreaterThanOrEquals; NumberIn; NumberInRange NumberLessThan; NumberGreaterThanOrEquals; NumberNotIn. NumberNotInRange StringBeginsWith; StringContains; StringEndsWith; StringIn; StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (обязательно) |
BoolEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | BoolEquals (обязательно) |
значение | Значение логического фильтра. | bool |
IsNotNullAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | IsNotNull (обязательно) |
IsNullOrUndefinedAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "IsNullOrUndefined" (обязательно) |
NumberGreaterThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "NumberGreaterThan" (обязательно) |
значение | Значение фильтра. | INT |
NumberGreaterThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "NumberGreaterThanOrEquals" (обязательно) |
значение | Значение фильтра. | INT |
NumberInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "NumberIn" (обязательно) |
значения | Набор значений фильтра. | int[] |
NumberInRangeAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "NumberInRange" (обязательно) |
значения | Набор значений фильтра. | int[][] |
NumberLessThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "NumberLessThan" (обязательно) |
значение | Значение фильтра. | INT |
NumberLessThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "NumberLessThanOrEquals" (обязательно) |
значение | Значение фильтра. | INT |
NumberNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "NumberNotIn" (обязательно) |
значения | Набор значений фильтра. | int[] |
NumberNotInRangeAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "NumberNotInRange" (обязательно) |
значения | Набор значений фильтра. | int[][] |
StringBeginsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "StringBeginsWith" (обязательно) |
значения | Набор значений фильтра. | string[] |
StringContainsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "StringContains" (обязательно) |
значения | Набор значений фильтра. | string[] |
StringEndsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "StringEndsWith" (обязательно) |
значения | Набор значений фильтра. | string[] |
StringInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "StringIn" (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotBeginsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "StringNotBeginsWith" (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotContainsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringNotContains (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotEndsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | StringNotEndsWith (обязательно) |
значения | Набор значений фильтра. | string[] |
StringNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. | "StringNotIn" (обязательно) |
значения | Набор значений фильтра. | string[] |
политика RetryPolicy
Имя | Описание | Значение |
---|---|---|
eventTimeToLiveInMinutes | Время жизни (в минутах) для событий. | INT |
maxDeliveryAttempts | Максимальное количество повторных попыток доставки для событий. | INT |