Microsoft.EventGrid eventSubscriptions 2018-09-15-preview
Определение ресурса Bicep
Тип ресурса eventSubscriptions является ресурсом расширения, что означает, что его можно применить к другому ресурсу.
scope
Используйте свойство этого ресурса, чтобы задать область для этого ресурса. См. раздел Настройка область для ресурсов расширения в Bicep.
Тип ресурса eventSubscriptions можно развернуть с помощью операций, предназначенных для:
- Группы ресурсов — см. команды развертывания группы ресурсов.
- Подписки — см. команды развертывания подписки.
Список измененных свойств в каждой версии API см. в журнале изменений.
Формат ресурсов
Чтобы создать ресурс Microsoft.EventGrid/eventSubscriptions, добавьте в шаблон следующий код Bicep.
resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2018-09-15-preview' = {
name: 'string'
scope: resourceSymbolicName
properties: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
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
}
]
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 , чтобы указать тип объекта .
Для EventHub используйте:
endpointType: 'EventHub'
properties: {
resourceId: 'string'
}
Для HybridConnection используйте:
endpointType: 'HybridConnection'
properties: {
resourceId: 'string'
}
Для StorageQueue используйте:
endpointType: 'StorageQueue'
properties: {
queueName: 'string'
resourceId: 'string'
}
Для веб-перехватчика используйте:
endpointType: 'WebHook'
properties: {
endpointUrl: 'string'
}
Объекты AdvancedFilter
Задайте свойство operatorType , чтобы указать тип объекта .
Для BoolEquals используйте:
operatorType: 'BoolEquals'
value: bool
Для NumberGreaterThan используйте:
operatorType: 'NumberGreaterThan'
value: int
Для NumberGreaterThanOrEquals используйте:
operatorType: 'NumberGreaterThanOrEquals'
value: int
Для NumberIn используйте:
operatorType: 'NumberIn'
values: [
int
]
Для NumberLessThan используйте:
operatorType: 'NumberLessThan'
value: int
Для NumberLessThanOrEquals используйте:
operatorType: 'NumberLessThanOrEquals'
value: int
Для NumberNotIn используйте:
operatorType: 'NumberNotIn'
values: [
int
]
Для StringBeginsWith используйте:
operatorType: 'StringBeginsWith'
values: [
'string'
]
Для StringContains используйте:
operatorType: 'StringContains'
values: [
'string'
]
Для StringEndsWith используйте:
operatorType: 'StringEndsWith'
values: [
'string'
]
Для StringIn используйте:
operatorType: 'StringIn'
values: [
'string'
]
Для StringNotIn используйте:
operatorType: 'StringNotIn'
values: [
'string'
]
Значения свойств
eventSubscriptions
Имя | Описание | Значение |
---|---|---|
name | имя ресурса. | строка (обязательно) Ограничение символов: 3–64 Допустимые символы: Буквенно-цифровые символы и дефисы. |
область | Используйте при создании ресурса расширения на область, отличном от область развертывания. | Целевой ресурс Для Bicep задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения. |
properties | Свойства подписки на события | EventSubscriptionProperties |
EventSubscriptionProperties
Имя | Описание | Значение |
---|---|---|
deadLetterDestination | Назначение DeadLetter подписки на события. | DeadLetterDestination |
ресурс destination | Сведения о назначении, куда должны доставляться события для подписки на события. | EventSubscriptionDestination |
eventDeliverySchema | Схема доставки событий для подписки на события. | CloudEventV01Schema CustomInputSchema EventGridSchema |
expirationTimeUtc | Срок действия подписки на события. | строка |
фильтр | Сведения о фильтре для подписки на события. | EventSubscriptionFilter |
метки; | Список пользовательских меток. | string[] |
retryPolicy | Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. | RetryPolicy |
DeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | StorageBlob (обязательно) |
StorageBlobDeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения недоставленных сообщений | StorageBlob (обязательно) |
properties | Свойства назначения недоставки на основе BLOB-объектов хранилища | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
Имя | Описание | Значение |
---|---|---|
blobContainerName | Имя контейнера BLOB-объектов хранилища, который является местом назначения событий недоставки. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, которая является местом назначения событий недоставки | строка |
EventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | EventHub HybridConnection StorageQueue Веб-перехватчик (обязательно) |
EventHubEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | EventHub (обязательно) |
properties | Свойства концентратора событий назначения подписки на события | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения концентратора событий подписки на события. | строка |
HybridConnectionEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | HybridConnection (обязательно) |
properties | Свойства гибридного подключения для назначения подписки на события | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. | строка |
StorageQueueEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | StorageQueue (обязательно) |
properties | Свойства очереди хранилища для назначения подписки на события | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
queueName | Имя очереди хранилища в учетной записи хранения, которая является местом назначения подписки на события. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является местом назначения подписки на события. | строка |
WebHookEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | "Веб-перехватчик" (обязательно) |
properties | Свойства веб-перехватчика назначения подписки на события | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
endpointUrl | URL-адрес, представляющий конечную точку назначения подписки на события. | строка |
EventSubscriptionFilter
Имя | Описание | Значение |
---|---|---|
advancedFilters | Список расширенных фильтров. | AdvancedFilter[] |
includedEventTypes | Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий, необходимо указать строку "all" в качестве элемента в этом списке. |
string[] |
isSubjectCaseSensitive | Указывает, если свойства SubjectBeginsWith и SubjectEndsWith фильтра следует сравнивать с учетом регистра. |
bool |
subjectBeginsWith | Необязательная строка для фильтрации событий для подписки на события на основе префикса пути к ресурсу. Формат зависит от издателя событий. Подстановочные знаки не поддерживаются в этом пути. |
строка |
subjectEndsWith | Необязательная строка для фильтрации событий для подписки на события на основе суффикса пути к ресурсу. Подстановочные знаки не поддерживаются в этом пути. |
строка |
AdvancedFilter
Имя | Описание | Значение |
---|---|---|
key | Ключ фильтра. Представляет свойство события с двумя уровнями вложенности. | строка |
operatorType | Установка типа объекта | BoolEquals NumberGreaterThan; NumberGreaterThanOrEquals; NumberIn; NumberLessThan; NumberGreaterThanOrEquals; NumberNotIn. StringBeginsWith; StringContains; StringEndsWith; StringIn; StringNotIn (обязательно) |
BoolEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | BoolEquals (обязательно) |
значение | Значение фильтра | bool |
NumberGreaterThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "NumberGreaterThan" (обязательно) |
значение | Значение фильтра | INT |
NumberGreaterThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | NumberGreaterThanOrEquals (обязательно) |
значение | Значение фильтра | INT |
NumberInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | NumberIn (обязательно) |
значения | Набор значений фильтра | int[] |
NumberLessThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | NumberLessThan (обязательно) |
значение | Значение фильтра | INT |
NumberLessThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | NumberLessThanOrEquals (обязательно) |
значение | Значение фильтра | INT |
NumberNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | NumberNotIn (обязательно) |
значения | Набор значений фильтра | int[] |
StringBeginsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | StringBeginsWith (обязательно) |
значения | Набор значений фильтра | string[] |
StringContainsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | StringContains (обязательно) |
значения | Набор значений фильтра | string[] |
StringEndsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | StringEndsWith (обязательно) |
значения | Набор значений фильтра | string[] |
StringInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | StringIn (обязательно) |
значения | Набор значений фильтра | string[] |
StringNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | 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": "2018-09-15-preview",
"name": "string",
"scope": "string",
"properties": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"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
}
],
"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 , чтобы указать тип объекта.
Для EventHub используйте:
"endpointType": "EventHub",
"properties": {
"resourceId": "string"
}
Для HybridConnection используйте:
"endpointType": "HybridConnection",
"properties": {
"resourceId": "string"
}
Для StorageQueue используйте:
"endpointType": "StorageQueue",
"properties": {
"queueName": "string",
"resourceId": "string"
}
Для веб-перехватчика используйте:
"endpointType": "WebHook",
"properties": {
"endpointUrl": "string"
}
Объекты AdvancedFilter
Задайте свойство operatorType , чтобы указать тип объекта .
Для BoolEquals используйте:
"operatorType": "BoolEquals",
"value": "bool"
Для NumberGreaterThan используйте:
"operatorType": "NumberGreaterThan",
"value": "int"
Для NumberGreaterThanOrEquals используйте:
"operatorType": "NumberGreaterThanOrEquals",
"value": "int"
Для NumberIn используйте:
"operatorType": "NumberIn",
"values": [ "int" ]
Для NumberLessThan используйте:
"operatorType": "NumberLessThan",
"value": "int"
Для NumberLessThanOrEquals используйте:
"operatorType": "NumberLessThanOrEquals",
"value": "int"
Для NumberNotIn используйте:
"operatorType": "NumberNotIn",
"values": [ "int" ]
Для StringBeginsWith используйте:
"operatorType": "StringBeginsWith",
"values": [ "string" ]
Для StringContains используйте:
"operatorType": "StringContains",
"values": [ "string" ]
Для StringEndsWith используйте:
"operatorType": "StringEndsWith",
"values": [ "string" ]
Для StringIn используйте:
"operatorType": "StringIn",
"values": [ "string" ]
Для StringNotIn используйте:
"operatorType": "StringNotIn",
"values": [ "string" ]
Значения свойств
eventSubscriptions
Имя | Описание | Значение |
---|---|---|
тип | Тип ресурса | Microsoft.EventGrid/eventSubscriptions |
версия_API | Версия API ресурсов | '2018-09-15-preview' |
name | имя ресурса. | string (обязательно) Ограничение символов: 3-64 Допустимые символы: Буквенно-цифровые символы и дефисы. |
область | Используйте при создании ресурса расширения в область, отличном от область развертывания. | Целевой ресурс Для JSON задайте полное имя ресурса, к который будет применяться ресурс расширения . |
properties | Свойства подписки на события | EventSubscriptionProperties |
EventSubscriptionProperties
Имя | Описание | Значение |
---|---|---|
deadLetterDestination | Назначение DeadLetter подписки на событие. | DeadLetterDestination |
ресурс destination | Сведения о назначении, куда должны быть доставлены события для подписки на события. | EventSubscriptionDestination |
eventDeliverySchema | Схема доставки событий для подписки на события. | CloudEventV01Schema CustomInputSchema EventGridSchema |
expirationTimeUtc | Время истечения срока действия подписки на событие. | строка |
фильтр | Сведения о фильтре для подписки на события. | EventSubscriptionFilter |
метки; | Список пользовательских меток. | string[] |
retryPolicy | Политика повтора для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. | RetryPolicy |
DeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | StorageBlob (обязательно) |
StorageBlobDeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения недоставленных сообщений | StorageBlob (обязательно) |
properties | Свойства назначения недоставки на основе BLOB-объектов хранилища | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
Имя | Описание | Значение |
---|---|---|
blobContainerName | Имя контейнера BLOB-объектов хранилища, который является местом назначения событий недоставки. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, которая является местом назначения событий недоставки | строка |
EventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | EventHub HybridConnection StorageQueue Веб-перехватчик (обязательно) |
EventHubEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | EventHub (обязательно) |
properties | Свойства концентратора событий назначения подписки на события | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения концентратора событий подписки на события. | строка |
HybridConnectionEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | HybridConnection (обязательно) |
properties | Свойства гибридного подключения для назначения подписки на события | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. | строка |
StorageQueueEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | StorageQueue (обязательно) |
properties | Свойства очереди хранилища для назначения подписки на события | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
queueName | Имя очереди хранилища в учетной записи хранения, которая является местом назначения подписки на события. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является местом назначения подписки на события. | строка |
WebHookEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | "Веб-перехватчик" (обязательно) |
properties | Свойства веб-перехватчика назначения подписки на события | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
endpointUrl | URL-адрес, представляющий конечную точку назначения подписки на события. | строка |
EventSubscriptionFilter
Имя | Описание | Значение |
---|---|---|
advancedFilters | Список расширенных фильтров. | AdvancedFilter[] |
includedEventTypes | Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий, необходимо указать строку "all" в качестве элемента в этом списке. |
string[] |
isSubjectCaseSensitive | Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра. следует сравнивать с учетом регистра. |
bool |
subjectBeginsWith | Необязательная строка для фильтрации событий для подписки на события на основе префикса пути к ресурсу. Формат зависит от издателя событий. Подстановочные знаки не поддерживаются в этом пути. |
строка |
subjectEndsWith | Необязательная строка для фильтрации событий для подписки на события на основе суффикса пути к ресурсу. Подстановочные знаки не поддерживаются в этом пути. |
строка |
AdvancedFilter
Имя | Описание | Значение |
---|---|---|
key | Ключ фильтра. Представляет свойство события с двумя уровнями вложенности. | строка |
operatorType | Установка типа объекта | BoolEquals NumberGreaterThan; NumberGreaterThanOrEquals; NumberIn; NumberLessThan; NumberGreaterThanOrEquals; NumberNotIn. StringBeginsWith; StringContains; StringEndsWith; StringIn; StringNotIn (обязательно) |
BoolEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | BoolEquals (обязательно) |
значение | Значение фильтра | bool |
NumberGreaterThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | NumberGreaterThan (обязательно) |
значение | Значение фильтра | INT |
NumberGreaterThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | NumberGreaterThanOrEquals (обязательно) |
значение | Значение фильтра | INT |
NumberInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "NumberIn" (обязательно) |
значения | Набор значений фильтра | int[] |
NumberLessThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | NumberLessThan (обязательно) |
значение | Значение фильтра | INT |
NumberLessThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | NumberLessThanOrEquals (обязательно) |
значение | Значение фильтра | INT |
NumberNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | NumberNotIn (обязательно) |
значения | Набор значений фильтра | int[] |
StringBeginsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | StringBeginsWith (обязательно) |
значения | Набор значений фильтра | string[] |
StringContainsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | StringContains (обязательно) |
значения | Набор значений фильтра | string[] |
StringEndsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | StringEndsWith (обязательно) |
значения | Набор значений фильтра | string[] |
StringInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | StringIn (обязательно) |
значения | Набор значений фильтра | string[] |
StringNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | 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@2018-09-15-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
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
}
]
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 , чтобы указать тип объекта.
Для EventHub используйте:
endpointType = "EventHub"
properties = {
resourceId = "string"
}
Для HybridConnection используйте:
endpointType = "HybridConnection"
properties = {
resourceId = "string"
}
Для StorageQueue используйте:
endpointType = "StorageQueue"
properties = {
queueName = "string"
resourceId = "string"
}
Для веб-перехватчика используйте:
endpointType = "WebHook"
properties = {
endpointUrl = "string"
}
Объекты AdvancedFilter
Задайте свойство operatorType , чтобы указать тип объекта .
Для BoolEquals используйте:
operatorType = "BoolEquals"
value = bool
Для NumberGreaterThan используйте:
operatorType = "NumberGreaterThan"
value = int
Для NumberGreaterThanOrEquals используйте:
operatorType = "NumberGreaterThanOrEquals"
value = int
Для NumberIn используйте:
operatorType = "NumberIn"
values = [
int
]
Для NumberLessThan используйте:
operatorType = "NumberLessThan"
value = int
Для NumberLessThanOrEquals используйте:
operatorType = "NumberLessThanOrEquals"
value = int
Для NumberNotIn используйте:
operatorType = "NumberNotIn"
values = [
int
]
Для StringBeginsWith используйте:
operatorType = "StringBeginsWith"
values = [
"string"
]
Для StringContains используйте:
operatorType = "StringContains"
values = [
"string"
]
Для StringEndsWith используйте:
operatorType = "StringEndsWith"
values = [
"string"
]
Для StringIn используйте:
operatorType = "StringIn"
values = [
"string"
]
Для StringNotIn используйте:
operatorType = "StringNotIn"
values = [
"string"
]
Значения свойств
eventSubscriptions
Имя | Описание | Значение |
---|---|---|
тип | Тип ресурса | "Microsoft.EventGrid/eventSubscriptions@2018-09-15-preview" |
name | имя ресурса. | string (обязательно) Ограничение символов: 3-64 Допустимые символы: Буквенно-цифровые символы и дефисы. |
parent_id | Идентификатор ресурса, к который применяется этот ресурс расширения. | string (обязательно) |
properties | Свойства подписки на события | EventSubscriptionProperties |
EventSubscriptionProperties
Имя | Описание | Значение |
---|---|---|
deadLetterDestination | Назначение DeadLetter подписки на событие. | DeadLetterDestination |
ресурс destination | Сведения о назначении, куда должны быть доставлены события для подписки на события. | EventSubscriptionDestination |
eventDeliverySchema | Схема доставки событий для подписки на события. | "CloudEventV01Schema" "CustomInputSchema" "EventGridSchema" |
expirationTimeUtc | Время истечения срока действия подписки на событие. | строка |
фильтр | Сведения о фильтре для подписки на события. | EventSubscriptionFilter |
метки; | Список пользовательских меток. | string[] |
retryPolicy | Политика повтора для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. | RetryPolicy |
DeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | StorageBlob (обязательно) |
StorageBlobDeadLetterDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения недоставленных сообщений | StorageBlob (обязательно) |
properties | Свойства назначения недоставленных сообщений на основе BLOB-объектов хранилища | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
Имя | Описание | Значение |
---|---|---|
blobContainerName | Имя контейнера больших двоичных объектов хранилища, который является местом назначения событий недоставленных сообщений. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, которая является местом назначения событий недоставленных сообщений. | строка |
EventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Установка типа объекта | EventHub Гибридное подключение StorageQueue Веб-перехватчик (обязательно) |
EventHubEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | "EventHub" (обязательно) |
properties | Свойства концентратора событий назначения подписки на события | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения концентратора событий подписки на события. | строка |
HybridConnectionEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | HybridConnection (обязательно) |
properties | Свойства гибридного подключения назначения подписки на события | HybridConnectionEventSubscriptionDestinationProperti... |
HybridConnectionEventSubscriptionDestinationProperti...
Имя | Описание | Значение |
---|---|---|
resourceId | Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. | строка |
StorageQueueEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | StorageQueue (обязательно) |
properties | Свойства очереди хранилища назначения подписки на события | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
queueName | Имя очереди хранилища в учетной записи хранения, которая является местом назначения подписки на события. | строка |
resourceId | Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является местом назначения подписки на события. | строка |
WebHookEventSubscriptionDestination
Имя | Описание | Значение |
---|---|---|
endpointType | Тип конечной точки для назначения подписки на события | WebHook (обязательно) |
properties | Свойства веб-перехватчика назначения подписки на события | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
Имя | Описание | Значение |
---|---|---|
endpointUrl | URL-адрес, представляющий конечную точку назначения подписки на события. | строка |
EventSubscriptionFilter
Имя | Описание | Значение |
---|---|---|
advancedFilters | Список расширенных фильтров. | AdvancedFilter[] |
includedEventTypes | Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий, необходимо указать строку "all" в качестве элемента в этом списке. |
string[] |
isSubjectCaseSensitive | Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра. следует сравнивать с учетом регистра. |
bool |
subjectBeginsWith | Необязательная строка для фильтрации событий для подписки на события на основе префикса пути к ресурсу. Формат зависит от издателя событий. Подстановочные знаки не поддерживаются в этом пути. |
строка |
subjectEndsWith | Необязательная строка для фильтрации событий для подписки на события на основе суффикса пути к ресурсу. Подстановочные знаки не поддерживаются в этом пути. |
строка |
AdvancedFilter
Имя | Описание | Значение |
---|---|---|
key | Ключ фильтра. Представляет свойство события с двумя уровнями вложенности. | строка |
operatorType | Установка типа объекта | BoolEquals NumberGreaterThan; NumberGreaterThanOrEquals; NumberIn; NumberLessThan; NumberGreaterThanOrEquals; NumberNotIn. StringBeginsWith; StringContains; StringEndsWith; StringIn; StringNotIn (обязательно) |
BoolEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | BoolEquals (обязательно) |
значение | Значение фильтра | bool |
NumberGreaterThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "NumberGreaterThan" (обязательно) |
значение | Значение фильтра | INT |
NumberGreaterThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "NumberGreaterThanOrEquals" (обязательно) |
значение | Значение фильтра | INT |
NumberInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "NumberIn" (обязательно) |
значения | Набор значений фильтра | int[] |
NumberLessThanAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "NumberLessThan" (обязательно) |
значение | Значение фильтра | INT |
NumberLessThanOrEqualsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "NumberLessThanOrEquals" (обязательно) |
значение | Значение фильтра | INT |
NumberNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "NumberNotIn" (обязательно) |
значения | Набор значений фильтра | int[] |
StringBeginsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "StringBeginsWith" (обязательно) |
значения | Набор значений фильтра | string[] |
StringContainsAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "StringContains" (обязательно) |
значения | Набор значений фильтра | string[] |
StringEndsWithAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "StringEndsWith" (обязательно) |
значения | Набор значений фильтра | string[] |
StringInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "StringIn" (обязательно) |
значения | Набор значений фильтра | string[] |
StringNotInAdvancedFilter
Имя | Описание | Значение |
---|---|---|
operatorType | Представляет оператор фильтра | "StringNotIn" (обязательно) |
значения | Набор значений фильтра | string[] |
политика RetryPolicy
Имя | Описание | Значение |
---|---|---|
eventTimeToLiveInMinutes | Время жизни (в минутах) для событий. | INT |
maxDeliveryAttempts | Максимальное число повторных попыток доставки для событий. | INT |