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


Событие Microsoft.EventGrid eventSubscriptions 2018-09-15-preview

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

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

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

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

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2018-09-15-preview' = {
  scope: resourceSymbolicName or scope
  name: '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
    }
  }
}

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

Объекты DeadLetterDestination

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

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

{
  endpointType: 'StorageBlob'
  properties: {
    blobContainerName: 'string'
    resourceId: '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'
  ]
}

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

Microsoft.EventGrid/eventSubscriptions

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

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

Имя Описание Ценность
ключ Ключ фильтра. Представляет свойство события до двух уровней вложения. струна
operatorType Задайте значение BoolEquals для типа BoolEqualsAdvancedFilter. Установите значение NumberGreaterThan для типа NumberGreaterThanAdvancedFilter. Задайте значение NumberGreaterThanOrEquals для типа NumberGreaterThanOrEqualsAdvancedFilter. Задайте значение NumberIn для типа NumberInAdvancedFilter. Установите значение NumberLessThan для типа NumberLessThanAdvancedFilter. Установите значение NumberLessThanOrEquals для типа NumberLessThanOrEqualsAdvancedFilter. Установите значение NumberNotIn для типа NumberNotInAdvancedFilter. Установите значение StringBeginsWith для типа StringBeginsWithAdvancedFilter. Задайте значение StringContains для типа StringContainsAdvancedFilter. Установите значение StringEndsWith для типа StringEndsWithAdvancedFilter. Задайте значение StringIn для типа StringInAdvancedFilter. Задайте значение StringNotIn для типа StringNotInAdvancedFilter. BoolEquals
"NumberGreaterThan"
"NumberGreaterThanOrEquals"
"NumberIn"
"NumberLessThan"
"NumberLessThanOrEquals"
"NumberNotIn"
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotIn (обязательно)

BoolEqualsAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра BoolEquals (обязательный)
ценность Значение фильтра булевая переменная (bool)

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

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

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

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

Свойства EventHubEventSubscriptionDestinationProperties

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

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

Имя Описание Ценность
endpointType Установите значение EventHub для типа EventHubEventSubscriptionDestination. Установите значение HybridConnection для типа HybridConnectionEventSubscriptionDestination. Установите значение StorageQueue для типа StorageQueueEventSubscriptionDestination. Установите значение WebHook для типа WebHookEventSubscriptionDestination. EventHub
"HybridConnection"
StorageQueue
WebHook (обязательный)

Фильтр EventSubscriptionFilter

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

Свойства EventSubscriptionProperties

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

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

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

HybridConnectionEventSubscriptionDestinationProperties

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

NumberGreaterThanAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberGreaterThan (обязательный)
ценность Значение фильтра инт

NumberGreaterThanOrEqualsAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberGreaterThanOrEquals (обязательный)
ценность Значение фильтра инт

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

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberIn (обязательный)
Значения Набор значений фильтра int[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра "NumberLessThan" (обязательный)
ценность Значение фильтра инт

NumberLessThanOrEqualsAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberLessThanOrEquals (обязательный)
ценность Значение фильтра инт

NumberNotInAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberNotIn (обязательно)
Значения Набор значений фильтра int[]

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

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

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

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

StorageQueueEventSubscriptionDestinationProperties

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

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringBeginsWith (обязательный)
Значения Набор значений фильтра строка[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringContains (обязательно)
Значения Набор значений фильтра строка[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringEndsWith (обязательный)
Значения Набор значений фильтра строка[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringIn (обязательно)
Значения Набор значений фильтра строка[]

StringNotInAdvancedFilter (СтрокаNotInAdvancedFilter)

Имя Описание Ценность
operatorType Представляет оператор фильтра StringNotIn (обязательно)
Значения Набор значений фильтра строка[]

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

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

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

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

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

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

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

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

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

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2018-09-15-preview",
  "name": "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"
    }
  }
}

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

Объекты DeadLetterDestination

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

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

{
  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "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" ]
}

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

Microsoft.EventGrid/eventSubscriptions

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

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

Имя Описание Ценность
ключ Ключ фильтра. Представляет свойство события до двух уровней вложения. струна
operatorType Задайте значение BoolEquals для типа BoolEqualsAdvancedFilter. Установите значение NumberGreaterThan для типа NumberGreaterThanAdvancedFilter. Задайте значение NumberGreaterThanOrEquals для типа NumberGreaterThanOrEqualsAdvancedFilter. Задайте значение NumberIn для типа NumberInAdvancedFilter. Установите значение NumberLessThan для типа NumberLessThanAdvancedFilter. Установите значение NumberLessThanOrEquals для типа NumberLessThanOrEqualsAdvancedFilter. Установите значение NumberNotIn для типа NumberNotInAdvancedFilter. Установите значение StringBeginsWith для типа StringBeginsWithAdvancedFilter. Задайте значение StringContains для типа StringContainsAdvancedFilter. Установите значение StringEndsWith для типа StringEndsWithAdvancedFilter. Задайте значение StringIn для типа StringInAdvancedFilter. Задайте значение StringNotIn для типа StringNotInAdvancedFilter. BoolEquals
"NumberGreaterThan"
"NumberGreaterThanOrEquals"
"NumberIn"
"NumberLessThan"
"NumberLessThanOrEquals"
"NumberNotIn"
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotIn (обязательно)

BoolEqualsAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра BoolEquals (обязательный)
ценность Значение фильтра булевая переменная (bool)

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

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

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

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

Свойства EventHubEventSubscriptionDestinationProperties

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

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

Имя Описание Ценность
endpointType Установите значение EventHub для типа EventHubEventSubscriptionDestination. Установите значение HybridConnection для типа HybridConnectionEventSubscriptionDestination. Установите значение StorageQueue для типа StorageQueueEventSubscriptionDestination. Установите значение WebHook для типа WebHookEventSubscriptionDestination. EventHub
"HybridConnection"
StorageQueue
WebHook (обязательный)

Фильтр EventSubscriptionFilter

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

Свойства EventSubscriptionProperties

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

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

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

HybridConnectionEventSubscriptionDestinationProperties

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

NumberGreaterThanAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberGreaterThan (обязательный)
ценность Значение фильтра инт

NumberGreaterThanOrEqualsAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberGreaterThanOrEquals (обязательный)
ценность Значение фильтра инт

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

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberIn (обязательный)
Значения Набор значений фильтра int[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра "NumberLessThan" (обязательный)
ценность Значение фильтра инт

NumberLessThanOrEqualsAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberLessThanOrEquals (обязательный)
ценность Значение фильтра инт

NumberNotInAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberNotIn (обязательно)
Значения Набор значений фильтра int[]

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

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

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

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

StorageQueueEventSubscriptionDestinationProperties

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

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringBeginsWith (обязательный)
Значения Набор значений фильтра строка[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringContains (обязательно)
Значения Набор значений фильтра строка[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringEndsWith (обязательный)
Значения Набор значений фильтра строка[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringIn (обязательно)
Значения Набор значений фильтра строка[]

StringNotInAdvancedFilter (СтрокаNotInAdvancedFilter)

Имя Описание Ценность
operatorType Представляет оператор фильтра StringNotIn (обязательно)
Значения Набор значений фильтра строка[]

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Объекты DeadLetterDestination

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

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

{
  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "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"
  ]
}

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

Microsoft.EventGrid/eventSubscriptions

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

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

Имя Описание Ценность
ключ Ключ фильтра. Представляет свойство события до двух уровней вложения. струна
operatorType Задайте значение BoolEquals для типа BoolEqualsAdvancedFilter. Установите значение NumberGreaterThan для типа NumberGreaterThanAdvancedFilter. Задайте значение NumberGreaterThanOrEquals для типа NumberGreaterThanOrEqualsAdvancedFilter. Задайте значение NumberIn для типа NumberInAdvancedFilter. Установите значение NumberLessThan для типа NumberLessThanAdvancedFilter. Установите значение NumberLessThanOrEquals для типа NumberLessThanOrEqualsAdvancedFilter. Установите значение NumberNotIn для типа NumberNotInAdvancedFilter. Установите значение StringBeginsWith для типа StringBeginsWithAdvancedFilter. Задайте значение StringContains для типа StringContainsAdvancedFilter. Установите значение StringEndsWith для типа StringEndsWithAdvancedFilter. Задайте значение StringIn для типа StringInAdvancedFilter. Задайте значение StringNotIn для типа StringNotInAdvancedFilter. BoolEquals
"NumberGreaterThan"
"NumberGreaterThanOrEquals"
"NumberIn"
"NumberLessThan"
"NumberLessThanOrEquals"
"NumberNotIn"
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotIn (обязательно)

BoolEqualsAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра BoolEquals (обязательный)
ценность Значение фильтра булевая переменная (bool)

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

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

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

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

Свойства EventHubEventSubscriptionDestinationProperties

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

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

Имя Описание Ценность
endpointType Установите значение EventHub для типа EventHubEventSubscriptionDestination. Установите значение HybridConnection для типа HybridConnectionEventSubscriptionDestination. Установите значение StorageQueue для типа StorageQueueEventSubscriptionDestination. Установите значение WebHook для типа WebHookEventSubscriptionDestination. EventHub
"HybridConnection"
StorageQueue
WebHook (обязательный)

Фильтр EventSubscriptionFilter

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

Свойства EventSubscriptionProperties

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

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

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

HybridConnectionEventSubscriptionDestinationProperties

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

NumberGreaterThanAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberGreaterThan (обязательный)
ценность Значение фильтра инт

NumberGreaterThanOrEqualsAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberGreaterThanOrEquals (обязательный)
ценность Значение фильтра инт

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

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberIn (обязательный)
Значения Набор значений фильтра int[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра "NumberLessThan" (обязательный)
ценность Значение фильтра инт

NumberLessThanOrEqualsAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberLessThanOrEquals (обязательный)
ценность Значение фильтра инт

NumberNotInAdvancedFilter

Имя Описание Ценность
operatorType Представляет оператор фильтра NumberNotIn (обязательно)
Значения Набор значений фильтра int[]

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

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

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

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

StorageQueueEventSubscriptionDestinationProperties

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

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringBeginsWith (обязательный)
Значения Набор значений фильтра строка[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringContains (обязательно)
Значения Набор значений фильтра строка[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringEndsWith (обязательный)
Значения Набор значений фильтра строка[]

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

Имя Описание Ценность
operatorType Представляет оператор фильтра StringIn (обязательно)
Значения Набор значений фильтра строка[]

StringNotInAdvancedFilter (СтрокаNotInAdvancedFilter)

Имя Описание Ценность
operatorType Представляет оператор фильтра StringNotIn (обязательно)
Значения Набор значений фильтра строка[]

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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