Примечание.
Для доступа к этой странице требуется авторизация. Вы можете попробовать войти или изменить каталоги.
Для доступа к этой странице требуется авторизация. Вы можете попробовать изменить каталоги.
- Latest
- 2025-04-01-preview
- 2025-02-15
- 2024-12-15-preview
- 2024-06-01-preview
- 2023-12-15-preview
- 2023-06-01-preview
- 2022-06-15
- 2021-12-01
- 2021-10-15-preview
- 2021-06-01-preview
- 2020-10-15-preview
- 2020-06-01
- 2020-04-01-preview
- 2020-01-01-preview
- 2019-06-01
- 2019-02-01-preview
- 2019-01-01
- 2018-09-15-preview
- 2018-05-01-preview
- 2018-01-01
- 2017-09-15-preview
- 2017-06-15-preview
Определение ресурсов Bicep
Тип ресурса eventSubscriptions можно развернуть с помощью операций, предназначенных для следующих операций:
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.EventGrid/eventSubscriptions, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2021-10-15-preview' = {
scope: resourceSymbolicName or scope
name: 'string'
properties: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
deadLetterWithResourceIdentity: {
deadLetterDestination: {
endpointType: 'string'
// For remaining properties, see DeadLetterDestination objects
}
identity: {
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
}
}
}
Объекты DeliveryAttributeMapping
Задайте свойство type , чтобы указать тип объекта.
Для Dynamic используйте:
{
properties: {
sourceField: 'string'
}
type: 'Dynamic'
}
Для статики используйте:
{
properties: {
isSecret: bool
value: 'string'
}
type: 'Static'
}
Объекты EventSubscriptionDestination
Задайте свойство endpointType , чтобы указать тип объекта.
Для AzureFunction используйте:
{
endpointType: 'AzureFunction'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
maxEventsPerBatch: int
preferredBatchSizeInKilobytes: int
resourceId: 'string'
}
}
Для EventHub используйте:
{
endpointType: 'EventHub'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
}
Для HybridConnection используйте:
{
endpointType: 'HybridConnection'
properties: {
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId: 'string'
}
}
Для 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'
}
}
Для WebHook используйте:
{
endpointType: 'WebHook'
properties: {
azureActiveDirectoryApplicationIdOrUri: 'string'
azureActiveDirectoryTenantId: 'string'
deliveryAttributeMappings: [
{
name: 'string'
type: 'string'
// For remaining properties, see DeliveryAttributeMapping objects
}
]
endpointUrl: 'string'
maxEventsPerBatch: int
preferredBatchSizeInKilobytes: int
}
}
Объекты 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'
]
}
Объекты DeadLetterDestination
Задайте свойство endpointType , чтобы указать тип объекта.
Для StorageBlob используйте:
{
endpointType: 'StorageBlob'
properties: {
blobContainerName: 'string'
resourceId: 'string'
}
}
Значения свойств
Microsoft.EventGrid/eventSubscriptions
| Name | Description | Value |
|---|---|---|
| name | имя ресурса. | строка (обязательно) |
| properties | Свойства подписки на события. | EventSubscriptionProperties |
| scope | Используется при создании ресурса в области, отличной от области развертывания. | Задайте для этого свойства символьное имя ресурса, чтобы применить ресурс расширения. |
AdvancedFilter
| Name | Description | Value |
|---|---|---|
| key | Поле или свойство в событии, на основе которого требуется отфильтровать. | string |
| operatorType | Установите значение 'BoolEquals' для типа BoolEqualsAdvancedFilter. Установите значение 'IsNotNull' для типа IsNotNullAdvancedFilter. Установите значение 'IsNullOrUndefined' для типа IsNullOrUndefinedAdvancedFilter. Установите значение 'NumberGreaterThan' для типа NumberGreaterThanAdvancedFilter. Установите значение 'NumberGreaterThanOrEquals' для типа NumberGreaterThanOrEqualsAdvancedFilter. Установите значение 'NumberIn' для типа NumberInAdvancedFilter. Установите значение 'NumberInRange' для типа NumberInRangeAdvancedFilter. Установите значение 'NumberLessThan' для типа NumberLessThanAdvancedFilter. Установите значение 'NumberLessThanOrEquals' для типа NumberLessThanOrEqualsAdvancedFilter. Установите значение 'NumberNotIn' для типа NumberNotInAdvancedFilter. Установите значение 'NumberNotInRange' для типа NumberNotInRangeAdvancedFilter. Установите значение 'StringBeginsWith' для типа StringBeginsWithAdvancedFilter. Установите значение 'StringContains' для типа StringContainsAdvancedFilter. Установите значение 'StringEndsWith' для типа StringEndsWithAdvancedFilter. Установите значение 'StringIn' для типа StringInAdvancedFilter. Установите значение 'StringNotBeginsWith' для типа StringNotBeginsWithAdvancedFilter. Установите значение 'StringNotContains' для типа StringNotContainsAdvancedFilter. Установите значение 'StringNotEndsWith' для типа StringNotEndsWithAdvancedFilter. Установите значение 'StringNotIn' для типа StringNotInAdvancedFilter. | 'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (обязательно) |
AzureFunctionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'AzureFunction' (обязательно) |
| properties | Свойства функции Azure назначения подписки на события. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| maxEventsPerBatch | Максимальное количество событий в пакете. | int |
| preferredBatchSizeInKilobytes | Предпочтительный размер пакета в Килобайтах. | int |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на событие. | string |
BoolEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'BoolEquals' (обязательно) |
| value | Логическое значение фильтра. | bool |
DeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Установите значение 'StorageBlob' для типа StorageBlobDeadLetterDestination. | 'StorageBlob' (обязательно) |
DeadLetterWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeadLetterDestination |
| identity | Удостоверение, используемое при недоставленных событиях. | EventSubscriptionIdentity |
DeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| name | Имя атрибута доставки или заголовка. | string |
| type | Установите значение "Dynamic" для типа DynamicDeliveryAttributeMapping. Установите значение 'Static' для типа StaticDeliveryAttributeMapping. | 'Dynamic' 'Статический' (обязательно) |
DeliveryWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| destination | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует удостоверение Сетки событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
EventSubscriptionDestination |
| identity | Удостоверение, используемое при доставке событий. | EventSubscriptionIdentity |
DynamicDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | Свойства сопоставления атрибутов динамической доставки. | DynamicDeliveryAttributeMappingProperties |
| type | Тип атрибута доставки или имени заголовка. | «Динамический» (обязательно) |
DynamicDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| sourceField | Путь JSON в событии, которое содержит значение атрибута. | string |
EventHubEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | «EventHub» (обязательно) |
| properties | Свойства концентратора событий назначения подписки на события. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения Концентратора событий подписки на событие. | string |
EventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Задайте значение AzureFunction для типа AzureFunctionEventSubscriptionDestination. Установите значение "EventHub" для типа EventHubEventSubscriptionDestination. Установите значение "HybridConnection" для типа HybridConnectionEventSubscriptionDestination. Установите значение PartnerDestination для типа PartnerEventSubscriptionDestination. Установите значение 'ServiceBusQueue' для типа ServiceBusQueueEventSubscriptionDestination. Установите значение 'ServiceBusTopic' для типа ServiceBusTopicEventSubscriptionDestination. Установите значение 'StorageQueue' для типа StorageQueueEventSubscriptionDestination. Установите значение 'WebHook' для типа WebHookEventSubscriptionDestination. | 'AzureFunction' 'EventHub' 'HybridConnection' 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (обязательно) |
EventSubscriptionFilter
| Name | Description | Value |
|---|---|---|
| advancedFilters | Массив расширенных фильтров, используемых для фильтрации подписок на события. | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | Позволяет вычислять расширенные фильтры по массиву значений вместо ожидания сингулярного значения. | bool |
| includedEventTypes | Список применимых типов событий, которые должны быть частью подписки на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. | string[] |
| isSubjectCaseSensitive | Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра следует сравнить с учетом регистра. |
bool |
| subjectBeginsWith | Необязательная строка для фильтрации событий подписки на основе префикса пути к ресурсу. Формат этого зависит от издателя событий. Подстановочные знаки не поддерживаются в этом пути. |
string |
| subjectEndsWith | Необязательная строка для фильтрации событий подписки на основе суффикса пути к ресурсу. Подстановочные знаки не поддерживаются в этом пути. |
string |
EventSubscriptionIdentity
| Name | Description | Value |
|---|---|---|
| type | Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" удаляет любое удостоверение. | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | string |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | Место назначения недоставленной буквы подписки на событие. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленной буквы. Использует удостоверение Сетки событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeadLetterDestination |
| deadLetterWithResourceIdentity | Место назначения недоставленной буквы подписки на событие. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленной буквы. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeliveryWithResourceIdentity |
| destination | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует удостоверение Сетки событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
EventSubscriptionDestination |
| eventDeliverySchema | Схема доставки событий для подписки на события. | 'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema' |
| expirationTimeUtc | Срок действия подписки на событие. | string |
| filter | Сведения о фильтре для подписки на события. | EventSubscriptionFilter |
| labels | Список определяемых пользователем меток. | string[] |
| retryPolicy | Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. | RetryPolicy |
HybridConnectionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'HybridConnection' (обязательно) |
| properties | Свойства гибридного подключения назначения подписки на событие. | HybridConnectionEventSubscriptionDestinationProperties |
HybridConnectionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. | string |
IsNotNullAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'IsNotNull' (обязательно) |
IsNullOrUndefinedAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'IsNullOrUndefined' (обязательно) |
NumberGreaterThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberGreaterThan' (обязательно) |
| value | Значение фильтра. | int |
NumberGreaterThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberGreaterThanOrEquals' (обязательно) |
| value | Значение фильтра. | int |
NumberInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberIn' (обязательно) |
| values | Набор значений фильтра. | int[] |
NumberInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberInRange' (обязательно) |
| values | Набор значений фильтра. | int[][] |
NumberLessThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberLessThan' (обязательно) |
| value | Значение фильтра. | int |
NumberLessThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberLessThanOrEquals' (обязательно) |
| value | Значение фильтра. | int |
NumberNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberNotIn' (обязательно) |
| values | Набор значений фильтра. | int[] |
NumberNotInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberNotInRange' (обязательно) |
| values | Набор значений фильтра. | int[][] |
PartnerEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'PartnerDestination' (обязательно) |
| properties | Свойства назначения партнера для назначения подписки на события. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения партнера подписки на событие. | string |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| eventTimeToLiveInMinutes | Время жизни (в минутах) для событий. | int |
| maxDeliveryAttempts | Максимальное количество попыток повторных попыток доставки для событий. | int |
ServiceBusQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'ServiceBusQueue' (обязательно) |
| properties | Свойства служебной шины назначения подписки на событие. | ServiceBusQueueEventSubscriptionDestinationProperties |
ServiceBusQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения служебной шины подписки на событие. | string |
ServiceBusTopicEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'ServiceBusTopic' (обязательно) |
| properties | Свойства раздела служебной шины назначения подписки на события. | ServiceBusTopicEventSubscriptionDestinationProperties |
ServiceBusTopicEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения раздела служебной шины подписки на событие. | string |
StaticDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | Свойства сопоставления атрибутов статической доставки. | StaticDeliveryAttributeMappingProperties |
| type | Тип атрибута доставки или имени заголовка. | 'Статический' (обязательно) |
StaticDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| isSecret | Логический флаг, чтобы определить, содержит ли атрибут конфиденциальную информацию. | bool |
| value | Значение атрибута доставки. | string |
StorageBlobDeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения недоставленной буквы | 'StorageBlob' (обязательно) |
| properties | Свойства назначения недоставки на основе BLOB-объектов хранилища | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Name | Description | Value |
|---|---|---|
| blobContainerName | Имя контейнера BLOB-объектов хранилища, который является назначением событий недоставки | string |
| resourceId | Идентификатор ресурса Azure учетной записи хранения, которая является назначением событий недоставки | string |
StorageQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'StorageQueue' (обязательно) |
| properties | Свойства очереди хранилища назначения подписки на события. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Время ожидания сообщения очереди хранилища в секундах. | int |
| queueName | Имя очереди хранилища в учетной записи хранения, которая является назначением подписки на событие. | string |
| resourceId | Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является назначением подписки на событие. | string |
StringBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringBeginsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringContains' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringEndsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringIn' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotBeginsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotContains' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotEndsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotIn' (обязательно) |
| values | Набор значений фильтра. | string[] |
WebHookEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'WebHook' (обязательно) |
| properties | Свойства веб-перехватчика назначения подписки на события. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. | string |
| azureActiveDirectoryTenantId | Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. | string |
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| endpointUrl | URL-адрес, представляющий конечную точку назначения подписки на событие. | string Constraints: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| maxEventsPerBatch | Максимальное количество событий в пакете. | int |
| preferredBatchSizeInKilobytes | Предпочтительный размер пакета в Килобайтах. | int |
Примеры использования
Примеры быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.
| Файл Bicep | Description |
|---|---|
| Создание настраиваемой темы и подписки службы "Сетка событий Azure" | Создает настраиваемый раздел Сетки событий Azure и подписку очереди служебной шины. Шаблон первоначально создан Маркусом Мейером. |
| Создание настраиваемого раздела и подписки в сетке событий Azure | Создает настраиваемый раздел Сетки событий Azure и подписку веб-перехватчика. Шаблон первоначально создан Джоном Дауном. |
Определение ресурса шаблона ARM
Тип ресурса eventSubscriptions можно развернуть с помощью операций, предназначенных для следующих операций:
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.EventGrid/eventSubscriptions, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.EventGrid/eventSubscriptions",
"apiVersion": "2021-10-15-preview",
"name": "string",
"properties": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"deadLetterWithResourceIdentity": {
"deadLetterDestination": {
"endpointType": "string"
// For remaining properties, see DeadLetterDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"deliveryWithResourceIdentity": {
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"identity": {
"type": "string",
"userAssignedIdentity": "string"
}
},
"destination": {
"endpointType": "string"
// For remaining properties, see EventSubscriptionDestination objects
},
"eventDeliverySchema": "string",
"expirationTimeUtc": "string",
"filter": {
"advancedFilters": [ {
"key": "string",
"operatorType": "string"
// For remaining properties, see AdvancedFilter objects
} ],
"enableAdvancedFilteringOnArrays": "bool",
"includedEventTypes": [ "string" ],
"isSubjectCaseSensitive": "bool",
"subjectBeginsWith": "string",
"subjectEndsWith": "string"
},
"labels": [ "string" ],
"retryPolicy": {
"eventTimeToLiveInMinutes": "int",
"maxDeliveryAttempts": "int"
}
}
}
Объекты DeliveryAttributeMapping
Задайте свойство type , чтобы указать тип объекта.
Для Dynamic используйте:
{
"properties": {
"sourceField": "string"
},
"type": "Dynamic"
}
Для статики используйте:
{
"properties": {
"isSecret": "bool",
"value": "string"
},
"type": "Static"
}
Объекты EventSubscriptionDestination
Задайте свойство endpointType , чтобы указать тип объекта.
Для AzureFunction используйте:
{
"endpointType": "AzureFunction",
"properties": {
"deliveryAttributeMappings": [ {
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
} ],
"maxEventsPerBatch": "int",
"preferredBatchSizeInKilobytes": "int",
"resourceId": "string"
}
}
Для EventHub используйте:
{
"endpointType": "EventHub",
"properties": {
"deliveryAttributeMappings": [ {
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
} ],
"resourceId": "string"
}
}
Для HybridConnection используйте:
{
"endpointType": "HybridConnection",
"properties": {
"deliveryAttributeMappings": [ {
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
} ],
"resourceId": "string"
}
}
Для 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"
}
}
Для WebHook используйте:
{
"endpointType": "WebHook",
"properties": {
"azureActiveDirectoryApplicationIdOrUri": "string",
"azureActiveDirectoryTenantId": "string",
"deliveryAttributeMappings": [ {
"name": "string",
"type": "string"
// For remaining properties, see DeliveryAttributeMapping objects
} ],
"endpointUrl": "string",
"maxEventsPerBatch": "int",
"preferredBatchSizeInKilobytes": "int"
}
}
Объекты 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" ]
}
Объекты DeadLetterDestination
Задайте свойство endpointType , чтобы указать тип объекта.
Для StorageBlob используйте:
{
"endpointType": "StorageBlob",
"properties": {
"blobContainerName": "string",
"resourceId": "string"
}
}
Значения свойств
Microsoft.EventGrid/eventSubscriptions
| Name | Description | Value |
|---|---|---|
| apiVersion | Версия API | '2021-10-15-preview' |
| name | имя ресурса. | строка (обязательно) |
| properties | Свойства подписки на события. | EventSubscriptionProperties |
| type | Тип ресурса | 'Microsoft.EventGrid/eventSubscriptions' |
AdvancedFilter
| Name | Description | Value |
|---|---|---|
| key | Поле или свойство в событии, на основе которого требуется отфильтровать. | string |
| operatorType | Установите значение 'BoolEquals' для типа BoolEqualsAdvancedFilter. Установите значение 'IsNotNull' для типа IsNotNullAdvancedFilter. Установите значение 'IsNullOrUndefined' для типа IsNullOrUndefinedAdvancedFilter. Установите значение 'NumberGreaterThan' для типа NumberGreaterThanAdvancedFilter. Установите значение 'NumberGreaterThanOrEquals' для типа NumberGreaterThanOrEqualsAdvancedFilter. Установите значение 'NumberIn' для типа NumberInAdvancedFilter. Установите значение 'NumberInRange' для типа NumberInRangeAdvancedFilter. Установите значение 'NumberLessThan' для типа NumberLessThanAdvancedFilter. Установите значение 'NumberLessThanOrEquals' для типа NumberLessThanOrEqualsAdvancedFilter. Установите значение 'NumberNotIn' для типа NumberNotInAdvancedFilter. Установите значение 'NumberNotInRange' для типа NumberNotInRangeAdvancedFilter. Установите значение 'StringBeginsWith' для типа StringBeginsWithAdvancedFilter. Установите значение 'StringContains' для типа StringContainsAdvancedFilter. Установите значение 'StringEndsWith' для типа StringEndsWithAdvancedFilter. Установите значение 'StringIn' для типа StringInAdvancedFilter. Установите значение 'StringNotBeginsWith' для типа StringNotBeginsWithAdvancedFilter. Установите значение 'StringNotContains' для типа StringNotContainsAdvancedFilter. Установите значение 'StringNotEndsWith' для типа StringNotEndsWithAdvancedFilter. Установите значение 'StringNotIn' для типа StringNotInAdvancedFilter. | 'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (обязательно) |
AzureFunctionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'AzureFunction' (обязательно) |
| properties | Свойства функции Azure назначения подписки на события. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| maxEventsPerBatch | Максимальное количество событий в пакете. | int |
| preferredBatchSizeInKilobytes | Предпочтительный размер пакета в Килобайтах. | int |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на событие. | string |
BoolEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'BoolEquals' (обязательно) |
| value | Логическое значение фильтра. | bool |
DeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Установите значение 'StorageBlob' для типа StorageBlobDeadLetterDestination. | 'StorageBlob' (обязательно) |
DeadLetterWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeadLetterDestination |
| identity | Удостоверение, используемое при недоставленных событиях. | EventSubscriptionIdentity |
DeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| name | Имя атрибута доставки или заголовка. | string |
| type | Установите значение "Dynamic" для типа DynamicDeliveryAttributeMapping. Установите значение 'Static' для типа StaticDeliveryAttributeMapping. | 'Dynamic' 'Статический' (обязательно) |
DeliveryWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| destination | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует удостоверение Сетки событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
EventSubscriptionDestination |
| identity | Удостоверение, используемое при доставке событий. | EventSubscriptionIdentity |
DynamicDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | Свойства сопоставления атрибутов динамической доставки. | DynamicDeliveryAttributeMappingProperties |
| type | Тип атрибута доставки или имени заголовка. | «Динамический» (обязательно) |
DynamicDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| sourceField | Путь JSON в событии, которое содержит значение атрибута. | string |
EventHubEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | «EventHub» (обязательно) |
| properties | Свойства концентратора событий назначения подписки на события. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения Концентратора событий подписки на событие. | string |
EventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Задайте значение AzureFunction для типа AzureFunctionEventSubscriptionDestination. Установите значение "EventHub" для типа EventHubEventSubscriptionDestination. Установите значение "HybridConnection" для типа HybridConnectionEventSubscriptionDestination. Установите значение PartnerDestination для типа PartnerEventSubscriptionDestination. Установите значение 'ServiceBusQueue' для типа ServiceBusQueueEventSubscriptionDestination. Установите значение 'ServiceBusTopic' для типа ServiceBusTopicEventSubscriptionDestination. Установите значение 'StorageQueue' для типа StorageQueueEventSubscriptionDestination. Установите значение 'WebHook' для типа WebHookEventSubscriptionDestination. | 'AzureFunction' 'EventHub' 'HybridConnection' 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (обязательно) |
EventSubscriptionFilter
| Name | Description | Value |
|---|---|---|
| advancedFilters | Массив расширенных фильтров, используемых для фильтрации подписок на события. | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | Позволяет вычислять расширенные фильтры по массиву значений вместо ожидания сингулярного значения. | bool |
| includedEventTypes | Список применимых типов событий, которые должны быть частью подписки на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. | string[] |
| isSubjectCaseSensitive | Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра следует сравнить с учетом регистра. |
bool |
| subjectBeginsWith | Необязательная строка для фильтрации событий подписки на основе префикса пути к ресурсу. Формат этого зависит от издателя событий. Подстановочные знаки не поддерживаются в этом пути. |
string |
| subjectEndsWith | Необязательная строка для фильтрации событий подписки на основе суффикса пути к ресурсу. Подстановочные знаки не поддерживаются в этом пути. |
string |
EventSubscriptionIdentity
| Name | Description | Value |
|---|---|---|
| type | Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" удаляет любое удостоверение. | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | string |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | Место назначения недоставленной буквы подписки на событие. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленной буквы. Использует удостоверение Сетки событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeadLetterDestination |
| deadLetterWithResourceIdentity | Место назначения недоставленной буквы подписки на событие. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленной буквы. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeliveryWithResourceIdentity |
| destination | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует удостоверение Сетки событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
EventSubscriptionDestination |
| eventDeliverySchema | Схема доставки событий для подписки на события. | 'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema' |
| expirationTimeUtc | Срок действия подписки на событие. | string |
| filter | Сведения о фильтре для подписки на события. | EventSubscriptionFilter |
| labels | Список определяемых пользователем меток. | string[] |
| retryPolicy | Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. | RetryPolicy |
HybridConnectionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'HybridConnection' (обязательно) |
| properties | Свойства гибридного подключения назначения подписки на событие. | HybridConnectionEventSubscriptionDestinationProperties |
HybridConnectionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. | string |
IsNotNullAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'IsNotNull' (обязательно) |
IsNullOrUndefinedAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'IsNullOrUndefined' (обязательно) |
NumberGreaterThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberGreaterThan' (обязательно) |
| value | Значение фильтра. | int |
NumberGreaterThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberGreaterThanOrEquals' (обязательно) |
| value | Значение фильтра. | int |
NumberInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberIn' (обязательно) |
| values | Набор значений фильтра. | int[] |
NumberInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberInRange' (обязательно) |
| values | Набор значений фильтра. | int[][] |
NumberLessThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberLessThan' (обязательно) |
| value | Значение фильтра. | int |
NumberLessThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberLessThanOrEquals' (обязательно) |
| value | Значение фильтра. | int |
NumberNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberNotIn' (обязательно) |
| values | Набор значений фильтра. | int[] |
NumberNotInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberNotInRange' (обязательно) |
| values | Набор значений фильтра. | int[][] |
PartnerEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'PartnerDestination' (обязательно) |
| properties | Свойства назначения партнера для назначения подписки на события. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения партнера подписки на событие. | string |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| eventTimeToLiveInMinutes | Время жизни (в минутах) для событий. | int |
| maxDeliveryAttempts | Максимальное количество попыток повторных попыток доставки для событий. | int |
ServiceBusQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'ServiceBusQueue' (обязательно) |
| properties | Свойства служебной шины назначения подписки на событие. | ServiceBusQueueEventSubscriptionDestinationProperties |
ServiceBusQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения служебной шины подписки на событие. | string |
ServiceBusTopicEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'ServiceBusTopic' (обязательно) |
| properties | Свойства раздела служебной шины назначения подписки на события. | ServiceBusTopicEventSubscriptionDestinationProperties |
ServiceBusTopicEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения раздела служебной шины подписки на событие. | string |
StaticDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | Свойства сопоставления атрибутов статической доставки. | StaticDeliveryAttributeMappingProperties |
| type | Тип атрибута доставки или имени заголовка. | 'Статический' (обязательно) |
StaticDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| isSecret | Логический флаг, чтобы определить, содержит ли атрибут конфиденциальную информацию. | bool |
| value | Значение атрибута доставки. | string |
StorageBlobDeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения недоставленной буквы | 'StorageBlob' (обязательно) |
| properties | Свойства назначения недоставки на основе BLOB-объектов хранилища | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Name | Description | Value |
|---|---|---|
| blobContainerName | Имя контейнера BLOB-объектов хранилища, который является назначением событий недоставки | string |
| resourceId | Идентификатор ресурса Azure учетной записи хранения, которая является назначением событий недоставки | string |
StorageQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'StorageQueue' (обязательно) |
| properties | Свойства очереди хранилища назначения подписки на события. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Время ожидания сообщения очереди хранилища в секундах. | int |
| queueName | Имя очереди хранилища в учетной записи хранения, которая является назначением подписки на событие. | string |
| resourceId | Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является назначением подписки на событие. | string |
StringBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringBeginsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringContains' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringEndsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringIn' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotBeginsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotContains' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotEndsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotIn' (обязательно) |
| values | Набор значений фильтра. | string[] |
WebHookEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'WebHook' (обязательно) |
| properties | Свойства веб-перехватчика назначения подписки на события. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. | string |
| azureActiveDirectoryTenantId | Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. | string |
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| endpointUrl | URL-адрес, представляющий конечную точку назначения подписки на событие. | string Constraints: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| maxEventsPerBatch | Максимальное количество событий в пакете. | int |
| preferredBatchSizeInKilobytes | Предпочтительный размер пакета в Килобайтах. | int |
Примеры использования
Шаблоны быстрого запуска Azure
Следующие шаблоны быстрого запуска Azure развертывают этот тип ресурса.
| Template | Description |
|---|---|
|
Создание настраиваемой темы и подписки службы "Сетка событий Azure" |
Создает настраиваемый раздел Сетки событий Azure и подписку очереди служебной шины. Шаблон первоначально создан Маркусом Мейером. |
|
Создание настраиваемого раздела и подписки в сетке событий Azure |
Создает настраиваемый раздел Сетки событий Azure и подписку веб-перехватчика. Шаблон первоначально создан Джоном Дауном. |
|
Создание настраиваемой подписки сетки событий Azure |
Создает настраиваемый раздел Сетки событий Azure и подписку на раздел служебной шины. Шаблон первоначально создан Маркусом Мейером. |
|
Создание настраиваемого раздела сетки событий и обработчика концентратора событий |
Создает настраиваемый раздел сетки событий Azure и концентратор событий для обработки событий. |
|
Создание подписки сетки событий для событий ресурсов |
Создает подписку сетки событий в группу ресурсов или подписку Azure. |
|
Настраиваемый раздел или подписка сетки событий Azure с CloudEvents |
Создает пользовательский раздел Сетки событий Azure, подписку веб-перехватчика с схемой CloudEvents и приложение логики в качестве обработчика событий. Шаблон первоначально создан ДжастинОм Yoo. |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса eventSubscriptions можно развернуть с помощью операций, предназначенных для следующих операций:
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.EventGrid/eventSubscriptions, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventGrid/eventSubscriptions@2021-10-15-preview"
name = "string"
parent_id = "string"
body = {
properties = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
deadLetterWithResourceIdentity = {
deadLetterDestination = {
endpointType = "string"
// For remaining properties, see DeadLetterDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
deliveryWithResourceIdentity = {
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
identity = {
type = "string"
userAssignedIdentity = "string"
}
}
destination = {
endpointType = "string"
// For remaining properties, see EventSubscriptionDestination objects
}
eventDeliverySchema = "string"
expirationTimeUtc = "string"
filter = {
advancedFilters = [
{
key = "string"
operatorType = "string"
// For remaining properties, see AdvancedFilter objects
}
]
enableAdvancedFilteringOnArrays = bool
includedEventTypes = [
"string"
]
isSubjectCaseSensitive = bool
subjectBeginsWith = "string"
subjectEndsWith = "string"
}
labels = [
"string"
]
retryPolicy = {
eventTimeToLiveInMinutes = int
maxDeliveryAttempts = int
}
}
}
}
Объекты DeliveryAttributeMapping
Задайте свойство type , чтобы указать тип объекта.
Для Dynamic используйте:
{
properties = {
sourceField = "string"
}
type = "Dynamic"
}
Для статики используйте:
{
properties = {
isSecret = bool
value = "string"
}
type = "Static"
}
Объекты EventSubscriptionDestination
Задайте свойство endpointType , чтобы указать тип объекта.
Для AzureFunction используйте:
{
endpointType = "AzureFunction"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
maxEventsPerBatch = int
preferredBatchSizeInKilobytes = int
resourceId = "string"
}
}
Для EventHub используйте:
{
endpointType = "EventHub"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
}
Для HybridConnection используйте:
{
endpointType = "HybridConnection"
properties = {
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
resourceId = "string"
}
}
Для 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"
}
}
Для WebHook используйте:
{
endpointType = "WebHook"
properties = {
azureActiveDirectoryApplicationIdOrUri = "string"
azureActiveDirectoryTenantId = "string"
deliveryAttributeMappings = [
{
name = "string"
type = "string"
// For remaining properties, see DeliveryAttributeMapping objects
}
]
endpointUrl = "string"
maxEventsPerBatch = int
preferredBatchSizeInKilobytes = int
}
}
Объекты 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"
]
}
Объекты DeadLetterDestination
Задайте свойство endpointType , чтобы указать тип объекта.
Для StorageBlob используйте:
{
endpointType = "StorageBlob"
properties = {
blobContainerName = "string"
resourceId = "string"
}
}
Значения свойств
Microsoft.EventGrid/eventSubscriptions
| Name | Description | Value |
|---|---|---|
| name | имя ресурса. | строка (обязательно) |
| parent_id | Идентификатор ресурса для применения этого ресурса расширения. | строка (обязательно) |
| properties | Свойства подписки на события. | EventSubscriptionProperties |
| type | Тип ресурса | "Microsoft.EventGrid/eventSubscriptions@2021-10-15-preview" |
AdvancedFilter
| Name | Description | Value |
|---|---|---|
| key | Поле или свойство в событии, на основе которого требуется отфильтровать. | string |
| operatorType | Установите значение 'BoolEquals' для типа BoolEqualsAdvancedFilter. Установите значение 'IsNotNull' для типа IsNotNullAdvancedFilter. Установите значение 'IsNullOrUndefined' для типа IsNullOrUndefinedAdvancedFilter. Установите значение 'NumberGreaterThan' для типа NumberGreaterThanAdvancedFilter. Установите значение 'NumberGreaterThanOrEquals' для типа NumberGreaterThanOrEqualsAdvancedFilter. Установите значение 'NumberIn' для типа NumberInAdvancedFilter. Установите значение 'NumberInRange' для типа NumberInRangeAdvancedFilter. Установите значение 'NumberLessThan' для типа NumberLessThanAdvancedFilter. Установите значение 'NumberLessThanOrEquals' для типа NumberLessThanOrEqualsAdvancedFilter. Установите значение 'NumberNotIn' для типа NumberNotInAdvancedFilter. Установите значение 'NumberNotInRange' для типа NumberNotInRangeAdvancedFilter. Установите значение 'StringBeginsWith' для типа StringBeginsWithAdvancedFilter. Установите значение 'StringContains' для типа StringContainsAdvancedFilter. Установите значение 'StringEndsWith' для типа StringEndsWithAdvancedFilter. Установите значение 'StringIn' для типа StringInAdvancedFilter. Установите значение 'StringNotBeginsWith' для типа StringNotBeginsWithAdvancedFilter. Установите значение 'StringNotContains' для типа StringNotContainsAdvancedFilter. Установите значение 'StringNotEndsWith' для типа StringNotEndsWithAdvancedFilter. Установите значение 'StringNotIn' для типа StringNotInAdvancedFilter. | 'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (обязательно) |
AzureFunctionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'AzureFunction' (обязательно) |
| properties | Свойства функции Azure назначения подписки на события. | AzureFunctionEventSubscriptionDestinationProperties |
AzureFunctionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| maxEventsPerBatch | Максимальное количество событий в пакете. | int |
| preferredBatchSizeInKilobytes | Предпочтительный размер пакета в Килобайтах. | int |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения функции Azure подписки на событие. | string |
BoolEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'BoolEquals' (обязательно) |
| value | Логическое значение фильтра. | bool |
DeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Установите значение 'StorageBlob' для типа StorageBlobDeadLetterDestination. | 'StorageBlob' (обязательно) |
DeadLetterWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeadLetterDestination |
| identity | Удостоверение, используемое при недоставленных событиях. | EventSubscriptionIdentity |
DeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| name | Имя атрибута доставки или заголовка. | string |
| type | Установите значение "Dynamic" для типа DynamicDeliveryAttributeMapping. Установите значение 'Static' для типа StaticDeliveryAttributeMapping. | 'Dynamic' 'Статический' (обязательно) |
DeliveryWithResourceIdentity
| Name | Description | Value |
|---|---|---|
| destination | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует удостоверение Сетки событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
EventSubscriptionDestination |
| identity | Удостоверение, используемое при доставке событий. | EventSubscriptionIdentity |
DynamicDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | Свойства сопоставления атрибутов динамической доставки. | DynamicDeliveryAttributeMappingProperties |
| type | Тип атрибута доставки или имени заголовка. | «Динамический» (обязательно) |
DynamicDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| sourceField | Путь JSON в событии, которое содержит значение атрибута. | string |
EventHubEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | «EventHub» (обязательно) |
| properties | Свойства концентратора событий назначения подписки на события. | EventHubEventSubscriptionDestinationProperties |
EventHubEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения Концентратора событий подписки на событие. | string |
EventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Задайте значение AzureFunction для типа AzureFunctionEventSubscriptionDestination. Установите значение "EventHub" для типа EventHubEventSubscriptionDestination. Установите значение "HybridConnection" для типа HybridConnectionEventSubscriptionDestination. Установите значение PartnerDestination для типа PartnerEventSubscriptionDestination. Установите значение 'ServiceBusQueue' для типа ServiceBusQueueEventSubscriptionDestination. Установите значение 'ServiceBusTopic' для типа ServiceBusTopicEventSubscriptionDestination. Установите значение 'StorageQueue' для типа StorageQueueEventSubscriptionDestination. Установите значение 'WebHook' для типа WebHookEventSubscriptionDestination. | 'AzureFunction' 'EventHub' 'HybridConnection' 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (обязательно) |
EventSubscriptionFilter
| Name | Description | Value |
|---|---|---|
| advancedFilters | Массив расширенных фильтров, используемых для фильтрации подписок на события. | AdvancedFilter[] |
| enableAdvancedFilteringOnArrays | Позволяет вычислять расширенные фильтры по массиву значений вместо ожидания сингулярного значения. | bool |
| includedEventTypes | Список применимых типов событий, которые должны быть частью подписки на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. | string[] |
| isSubjectCaseSensitive | Указывает, являются ли свойства SubjectBeginsWith и SubjectEndsWith фильтра следует сравнить с учетом регистра. |
bool |
| subjectBeginsWith | Необязательная строка для фильтрации событий подписки на основе префикса пути к ресурсу. Формат этого зависит от издателя событий. Подстановочные знаки не поддерживаются в этом пути. |
string |
| subjectEndsWith | Необязательная строка для фильтрации событий подписки на основе суффикса пути к ресурсу. Подстановочные знаки не поддерживаются в этом пути. |
string |
EventSubscriptionIdentity
| Name | Description | Value |
|---|---|---|
| type | Тип управляемого удостоверения, используемого. Тип SystemAssigned, UserAssigned включает как неявное созданное удостоверение, так и набор удостоверений, назначенных пользователем. Тип "Нет" удаляет любое удостоверение. | 'SystemAssigned' 'UserAssigned' |
| userAssignedIdentity | Удостоверение пользователя, связанное с ресурсом. | string |
EventSubscriptionProperties
| Name | Description | Value |
|---|---|---|
| deadLetterDestination | Место назначения недоставленной буквы подписки на событие. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленной буквы. Использует удостоверение Сетки событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeadLetterDestination |
| deadLetterWithResourceIdentity | Место назначения недоставленной буквы подписки на событие. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленной буквы. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeadLetterWithResourceIdentity |
| deliveryWithResourceIdentity | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует настройку управляемого удостоверения в родительском ресурсе (а именно, теме или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
DeliveryWithResourceIdentity |
| destination | Сведения о назначении, в котором должны быть доставлены события для подписки на события. Использует удостоверение Сетки событий Azure для получения маркеров проверки подлинности, используемых во время доставки или недоставки. |
EventSubscriptionDestination |
| eventDeliverySchema | Схема доставки событий для подписки на события. | 'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema' |
| expirationTimeUtc | Срок действия подписки на событие. | string |
| filter | Сведения о фильтре для подписки на события. | EventSubscriptionFilter |
| labels | Список определяемых пользователем меток. | string[] |
| retryPolicy | Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. | RetryPolicy |
HybridConnectionEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'HybridConnection' (обязательно) |
| properties | Свойства гибридного подключения назначения подписки на событие. | HybridConnectionEventSubscriptionDestinationProperties |
HybridConnectionEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure гибридного подключения, которое является назначением подписки на события. | string |
IsNotNullAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'IsNotNull' (обязательно) |
IsNullOrUndefinedAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'IsNullOrUndefined' (обязательно) |
NumberGreaterThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberGreaterThan' (обязательно) |
| value | Значение фильтра. | int |
NumberGreaterThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberGreaterThanOrEquals' (обязательно) |
| value | Значение фильтра. | int |
NumberInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberIn' (обязательно) |
| values | Набор значений фильтра. | int[] |
NumberInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberInRange' (обязательно) |
| values | Набор значений фильтра. | int[][] |
NumberLessThanAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberLessThan' (обязательно) |
| value | Значение фильтра. | int |
NumberLessThanOrEqualsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberLessThanOrEquals' (обязательно) |
| value | Значение фильтра. | int |
NumberNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberNotIn' (обязательно) |
| values | Набор значений фильтра. | int[] |
NumberNotInRangeAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'NumberNotInRange' (обязательно) |
| values | Набор значений фильтра. | int[][] |
PartnerEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'PartnerDestination' (обязательно) |
| properties | Свойства назначения партнера для назначения подписки на события. | PartnerEventSubscriptionDestinationProperties |
PartnerEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения партнера подписки на событие. | string |
RetryPolicy
| Name | Description | Value |
|---|---|---|
| eventTimeToLiveInMinutes | Время жизни (в минутах) для событий. | int |
| maxDeliveryAttempts | Максимальное количество попыток повторных попыток доставки для событий. | int |
ServiceBusQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'ServiceBusQueue' (обязательно) |
| properties | Свойства служебной шины назначения подписки на событие. | ServiceBusQueueEventSubscriptionDestinationProperties |
ServiceBusQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения служебной шины подписки на событие. | string |
ServiceBusTopicEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'ServiceBusTopic' (обязательно) |
| properties | Свойства раздела служебной шины назначения подписки на события. | ServiceBusTopicEventSubscriptionDestinationProperties |
ServiceBusTopicEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| resourceId | Идентификатор ресурса Azure, представляющий конечную точку назначения раздела служебной шины подписки на событие. | string |
StaticDeliveryAttributeMapping
| Name | Description | Value |
|---|---|---|
| properties | Свойства сопоставления атрибутов статической доставки. | StaticDeliveryAttributeMappingProperties |
| type | Тип атрибута доставки или имени заголовка. | 'Статический' (обязательно) |
StaticDeliveryAttributeMappingProperties
| Name | Description | Value |
|---|---|---|
| isSecret | Логический флаг, чтобы определить, содержит ли атрибут конфиденциальную информацию. | bool |
| value | Значение атрибута доставки. | string |
StorageBlobDeadLetterDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения недоставленной буквы | 'StorageBlob' (обязательно) |
| properties | Свойства назначения недоставки на основе BLOB-объектов хранилища | StorageBlobDeadLetterDestinationProperties |
StorageBlobDeadLetterDestinationProperties
| Name | Description | Value |
|---|---|---|
| blobContainerName | Имя контейнера BLOB-объектов хранилища, который является назначением событий недоставки | string |
| resourceId | Идентификатор ресурса Azure учетной записи хранения, которая является назначением событий недоставки | string |
StorageQueueEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'StorageQueue' (обязательно) |
| properties | Свойства очереди хранилища назначения подписки на события. | StorageQueueEventSubscriptionDestinationProperties |
StorageQueueEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| queueMessageTimeToLiveInSeconds | Время ожидания сообщения очереди хранилища в секундах. | int |
| queueName | Имя очереди хранилища в учетной записи хранения, которая является назначением подписки на событие. | string |
| resourceId | Идентификатор ресурса Azure учетной записи хранения, содержащей очередь, которая является назначением подписки на событие. | string |
StringBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringBeginsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringContains' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringEndsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringIn' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotBeginsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotBeginsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotContainsAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotContains' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotEndsWithAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotEndsWith' (обязательно) |
| values | Набор значений фильтра. | string[] |
StringNotInAdvancedFilter
| Name | Description | Value |
|---|---|---|
| operatorType | Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и других. | 'StringNotIn' (обязательно) |
| values | Набор значений фильтра. | string[] |
WebHookEventSubscriptionDestination
| Name | Description | Value |
|---|---|---|
| endpointType | Тип конечной точки для назначения подписки на события. | 'WebHook' (обязательно) |
| properties | Свойства веб-перехватчика назначения подписки на события. | WebHookEventSubscriptionDestinationProperties |
WebHookEventSubscriptionDestinationProperties
| Name | Description | Value |
|---|---|---|
| azureActiveDirectoryApplicationIdOrUri | Идентификатор приложения Azure Active Directory или URI для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. | string |
| azureActiveDirectoryTenantId | Идентификатор клиента Azure Active Directory для получения маркера доступа, который будет включен в качестве маркера носителя в запросах на доставку. | string |
| deliveryAttributeMappings | Сведения о атрибуте доставки. | DeliveryAttributeMapping[] |
| endpointUrl | URL-адрес, представляющий конечную точку назначения подписки на событие. | string Constraints: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| maxEventsPerBatch | Максимальное количество событий в пакете. | int |
| preferredBatchSizeInKilobytes | Предпочтительный размер пакета в Килобайтах. | int |
Примеры использования
Примеры Terraform
Простой пример развертывания подписки на события EventGrid.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westeurope"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = var.resource_name
location = var.location
}
resource "azapi_resource" "namespace" {
type = "Microsoft.EventHub/namespaces@2022-01-01-preview"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
properties = {
disableLocalAuth = false
isAutoInflateEnabled = false
publicNetworkAccess = "Enabled"
zoneRedundant = false
}
sku = {
capacity = 1
name = "Standard"
tier = "Standard"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "storageAccount" {
type = "Microsoft.Storage/storageAccounts@2021-09-01"
parent_id = azapi_resource.resourceGroup.id
name = var.resource_name
location = var.location
body = {
kind = "StorageV2"
properties = {
accessTier = "Hot"
allowBlobPublicAccess = true
allowCrossTenantReplication = true
allowSharedKeyAccess = true
defaultToOAuthAuthentication = false
encryption = {
keySource = "Microsoft.Storage"
services = {
queue = {
keyType = "Service"
}
table = {
keyType = "Service"
}
}
}
isHnsEnabled = false
isNfsV3Enabled = false
isSftpEnabled = false
minimumTlsVersion = "TLS1_2"
networkAcls = {
defaultAction = "Allow"
}
publicNetworkAccess = "Enabled"
supportsHttpsTrafficOnly = true
}
sku = {
name = "Standard_LRS"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "eventhub" {
type = "Microsoft.EventHub/namespaces/eventhubs@2021-11-01"
parent_id = azapi_resource.namespace.id
name = var.resource_name
body = {
properties = {
messageRetentionInDays = 1
partitionCount = 1
status = "Active"
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}
resource "azapi_resource" "eventSubscription" {
type = "Microsoft.EventGrid/eventSubscriptions@2021-12-01"
parent_id = azapi_resource.storageAccount.id
name = var.resource_name
body = {
properties = {
deadLetterDestination = null
destination = {
endpointType = "EventHub"
properties = {
deliveryAttributeMappings = null
resourceId = azapi_resource.eventhub.id
}
}
eventDeliverySchema = "EventGridSchema"
filter = {
includedEventTypes = [
"Microsoft.Storage.BlobCreated",
"Microsoft.Storage.BlobRenamed",
]
}
labels = [
]
retryPolicy = {
eventTimeToLiveInMinutes = 144
maxDeliveryAttempts = 10
}
}
}
schema_validation_enabled = false
response_export_values = ["*"]
}