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

Событие Microsoft.EventGrid eventSubscriptions 2019-01-01

  • Статья

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

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

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

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

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2019-01-01' = {
  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
    }
    filter: {
      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'
  }
}

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

DeadLetterDestination

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

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

EventSubscriptionFilter

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

EventSubscriptionProperties

Имя Описание Ценность
deadLetterDestination Назначение DeadLetter подписки на событие. DeadLetterDestination
назначение Сведения о назначении, в котором должны быть доставлены события для подписки на события. EventSubscriptionDestination
фильтр Сведения о фильтре для подписки на события. EventSubscriptionFilter
Метки Список определяемых пользователем меток. string[]
retryPolicy Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. RetryPolicy

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

Microsoft.EventGrid/eventSubscriptions

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

RetryPolicy

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

Имя Описание Ценность
blobContainerName Имя контейнера BLOB-объектов хранилища, который является назначением событий недоставки струна
resourceId Идентификатор ресурса Azure учетной записи хранения, которая является назначением событий недоставки. Например: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft. Storage/storageAccounts/{StorageAccountName} струна

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

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

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

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

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

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

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

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

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2019-01-01",
  "name": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "filter": {
      "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"
  }
}

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

DeadLetterDestination

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

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

EventSubscriptionFilter

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

EventSubscriptionProperties

Имя Описание Ценность
deadLetterDestination Назначение DeadLetter подписки на событие. DeadLetterDestination
назначение Сведения о назначении, в котором должны быть доставлены события для подписки на события. EventSubscriptionDestination
фильтр Сведения о фильтре для подписки на события. EventSubscriptionFilter
Метки Список определяемых пользователем меток. string[]
retryPolicy Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. RetryPolicy

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

Microsoft.EventGrid/eventSubscriptions

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

RetryPolicy

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

Имя Описание Ценность
blobContainerName Имя контейнера BLOB-объектов хранилища, который является назначением событий недоставки струна
resourceId Идентификатор ресурса Azure учетной записи хранения, которая является назначением событий недоставки. Например: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft. Storage/storageAccounts/{StorageAccountName} струна

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

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

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

Шаблон Описание
создание настраиваемой темы сетки событий 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@2019-01-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      destination = {
        endpointType = "string"
        // For remaining properties, see EventSubscriptionDestination objects
      }
      filter = {
        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"
  }
}

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

DeadLetterDestination

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

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

EventSubscriptionFilter

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

EventSubscriptionProperties

Имя Описание Ценность
deadLetterDestination Назначение DeadLetter подписки на событие. DeadLetterDestination
назначение Сведения о назначении, в котором должны быть доставлены события для подписки на события. EventSubscriptionDestination
фильтр Сведения о фильтре для подписки на события. EventSubscriptionFilter
Метки Список определяемых пользователем меток. string[]
retryPolicy Политика повторных попыток для событий. Это можно использовать для настройки максимального количества попыток доставки и времени жизни для событий. RetryPolicy

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

Microsoft.EventGrid/eventSubscriptions

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

RetryPolicy

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

Имя Описание Ценность
blobContainerName Имя контейнера BLOB-объектов хранилища, который является назначением событий недоставки струна
resourceId Идентификатор ресурса Azure учетной записи хранения, которая является назначением событий недоставки. Например: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/microsoft. Storage/storageAccounts/{StorageAccountName} струна

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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