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


Пространства имен Microsoft.EventGrid/topics/eventSubscriptions 2023-06-01-preview

Определение ресурса Bicep

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

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

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

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

resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-06-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    deliveryConfiguration: {
      deliveryMode: 'Queue'
      queue: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
        receiveLockDurationInSeconds: int
      }
    }
    eventDeliverySchema: 'CloudEventSchemaV1_0'
    filtersConfiguration: {
      filters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see Filter objects
        }
      ]
      includedEventTypes: [
        'string'
      ]
    }
  }
}

Объекты DeadLetterDestination

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

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

  endpointType: 'StorageBlob'
  properties: {
    blobContainerName: 'string'
    resourceId: 'string'
  }

Фильтрация объектов

Задайте свойство 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'
  ]

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

namespaces/topics/eventSubscriptions

Имя Описание Значение
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в Bicep.
строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить только в том случае, если дочерний ресурс объявлен вне родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: темы
properties Свойства подписки на события. Свойства подписки

Свойства подписки

Имя Описание Значение
deliveryConfiguration Сведения о конфигурации доставки подписки на события. DeliveryConfiguration
eventDeliverySchema Схема доставки событий для подписки на события. "CloudEventSchemaV1_0"
filtersConfiguration Сведения о фильтре для подписки на события. FiltersConfiguration

DeliveryConfiguration

Имя Описание Значение
deliveryMode Режим доставки подписки на события. "Очередь"
очередь Это свойство должно заполняться, если параметр deliveryMode имеет значение queue и представляет сведения о подписке очереди. QueueInfo

QueueInfo

Имя Описание Значение
deadLetterDestinationWithResourceIdentity Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения , отправляется в место назначения недоставленных сообщений.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно в разделе) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeadLetterWithResourceIdentity
eventTimeToLive Продолжительность интервала времени в формате ISO 8601, которая определяет, сколько сообщений доступны для подписки с момента публикации сообщения.
Это значение длительности выражается в следующем формате: "P(n)Y(n)M(n)DT(n)H(n)M(n)S", где:
— (n) заменяется значением каждого элемента времени, следующего за (n).
— P — это указатель длительности (или точки) и всегда размещается в начале длительности.
- Y — это указатель года, и он следует за значением числа лет.
— M — это указатель месяца, который следует за значением числа месяцев.
- W — это указатель недели, и он следует за значением количества недель.
— D — это указатель дня, который следует за значением числа дней.
— T — это конструктор времени, который предшествует компонентам времени.
— H — это указатель часов, который следует за значением числа часов.
— M — это указатель минут, который следует за значением количества минут.
— S — второй конструктор, который следует за значением числа секунд.
Это значение длительности не может быть больше значения EventRetentionInDays раздела. Это необязательное поле, где его минимальное значение составляет 1 минуту, а его максимальное значение определяется
по значению EventRetentionInDays раздела. Ниже приведены примеры допустимых значений.
- "P0DT23H12M" или "PT23H12M": продолжительность 23 часов и 12 минут.
— "P1D" или "P1DT0H0M0S": в течение 1 дня.
строка
maxDeliveryCount Максимальное число доставок событий. INT
receiveLockDurationInSeconds Максимальный период в секундах, в течение которого сообщение находится в состоянии получения (клиентом) и ожидает принятия, освобождения или отклонения.
Если это время прошло после того, как сообщение было получено клиентом и не было перенесено в принято (не обработано), выпущено или отклонено,
сообщение доступно для повторной подготовки. Это необязательное поле, где значение по умолчанию — 60 секунд, минимальное — 60 секунд, а максимальное — 300 секунд.
INT

DeadLetterWithResourceIdentity

Имя Описание Значение
deadLetterDestination Сведения о назначении, куда должны быть доставлены события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки сообщений.
DeadLetterDestination
удостоверение Удостоверение, используемое при недоставленных событиях. EventSubscriptionIdentity

DeadLetterDestination

Имя Описание Значение
endpointType Установка типа объекта StorageBlob (обязательно)

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

Имя Описание Значение
blobContainerName Имя контейнера BLOB-объектов хранилища, который является местом назначения событий недоставки. строка
resourceId Идентификатор ресурса Azure учетной записи хранения, которая является местом назначения событий недоставки строка

EventSubscriptionIdentity

Имя Описание Значение
тип Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор назначаемых пользователем удостоверений. Тип None приведет к удалению всех удостоверений. SystemAssigned
UserAssigned
userAssignedIdentity Удостоверение пользователя, связанное с ресурсом. строка

FiltersConfiguration

Имя Описание Значение
filters Массив фильтров, используемых для фильтрации подписок на события. Filter[]
includedEventTypes Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий по умолчанию, присвойте параметру IncludedEventTypes значение NULL. string[]

Фильтр

Имя Описание Значение
key Поле или свойство в событии, по которому требуется отфильтровать. строка
operatorType Установка типа объекта BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan;
NumberGreaterThanOrEquals;
NumberIn;
NumberInRange
NumberLessThan;
NumberGreaterThanOrEquals;
NumberNotIn.
NumberNotInRange
StringBeginsWith;
StringContains;
StringEndsWith;
StringIn;
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (обязательно)

BoolEqualsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. BoolEquals (обязательно)
значение Значение логического фильтра. bool

IsNotNullFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. IsNotNull (обязательно)

IsNullOrUndefinedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. IsNullOrUndefined (обязательно)

NumberGreaterThanFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberGreaterThan" (обязательно)
значение Значение фильтра. INT

NumberGreaterThanOrEqualsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberGreaterThanOrEquals (обязательно)
значение Значение фильтра. INT

NumberInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberIn (обязательно)
значения Набор значений фильтра. int[]

NumberInRangeFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberInRange (обязательно)
значения Набор значений фильтра. int[][]

NumberLessThanFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberLessThan (обязательно)
значение Значение фильтра. INT

NumberLessThanOrEqualsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberLessThanOrEquals (обязательно)
значение Значение фильтра. INT

NumberNotInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberNotIn (обязательно)
значения Набор значений фильтра. int[]

NumberNotInRangeFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberNotInRange (обязательно)
значения Набор значений фильтра. int[][]

StringBeginsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringBeginsWith (обязательно)
значения Набор значений фильтра. string[]

StringContainsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringContains (обязательно)
значения Набор значений фильтра. string[]

StringEndsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringEndsWith (обязательно)
значения Набор значений фильтра. string[]

StringInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringIn (обязательно)
значения Набор значений фильтра. string[]

StringNotBeginsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotBeginsWith (обязательно)
значения Набор значений фильтра. string[]

StringNotContainsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotContains (обязательно)
значения Набор значений фильтра. string[]

StringNotEndsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotEndsWith (обязательно)
значения Набор значений фильтра. string[]

StringNotInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotIn (обязательно)
значения Набор значений фильтра. string[]

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

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

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

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

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

{
  "type": "Microsoft.EventGrid/namespaces/topics/eventSubscriptions",
  "apiVersion": "2023-06-01-preview",
  "name": "string",
  "properties": {
    "deliveryConfiguration": {
      "deliveryMode": "Queue",
      "queue": {
        "deadLetterDestinationWithResourceIdentity": {
          "deadLetterDestination": {
            "endpointType": "string"
            // For remaining properties, see DeadLetterDestination objects
          },
          "identity": {
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "eventTimeToLive": "string",
        "maxDeliveryCount": "int",
        "receiveLockDurationInSeconds": "int"
      }
    },
    "eventDeliverySchema": "CloudEventSchemaV1_0",
    "filtersConfiguration": {
      "filters": [
        {
          "key": "string",
          "operatorType": "string"
          // For remaining properties, see Filter objects
        }
      ],
      "includedEventTypes": [ "string" ]
    }
  }
}

Объекты DeadLetterDestination

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

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

  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "string"
  }

Фильтрация объектов

Задайте свойство 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" ]

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

namespaces/topics/eventSubscriptions

Имя Описание Значение
тип Тип ресурса Microsoft.EventGrid/namespaces/topics/eventSubscriptions
версия_API Версия API ресурсов '2023-06-01-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.
строка (обязательно)
properties Свойства подписки на события. Свойства подписки

Свойства подписки

Имя Описание Значение
deliveryConfiguration Сведения о конфигурации доставки подписки на события. DeliveryConfiguration
eventDeliverySchema Схема доставки событий для подписки на события. "CloudEventSchemaV1_0"
filtersConfiguration Сведения о фильтре для подписки на события. FiltersConfiguration

DeliveryConfiguration

Имя Описание Значение
deliveryMode Режим доставки подписки на события. "Очередь"
очередь Это свойство должно заполняться, если параметр deliveryMode имеет значение queue и представляет сведения о подписке очереди. QueueInfo

QueueInfo

Имя Описание Значение
deadLetterDestinationWithResourceIdentity Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения , отправляется в место назначения недоставленных сообщений.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно в разделе) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeadLetterWithResourceIdentity
eventTimeToLive Продолжительность интервала времени в формате ISO 8601, которая определяет, сколько сообщений доступны для подписки с момента публикации сообщения.
Это значение длительности выражается в следующем формате: "P(n)Y(n)M(n)DT(n)H(n)M(n)S", где:
— (n) заменяется значением каждого элемента времени, следующего за (n).
— P — это указатель длительности (или точки) и всегда размещается в начале длительности.
- Y — это указатель года, и он следует за значением числа лет.
— M — это указатель месяца, который следует за значением числа месяцев.
- W — это указатель недели, и он следует за значением количества недель.
— D — это указатель дня, который следует за значением числа дней.
— T — это конструктор времени, который предшествует компонентам времени.
— H — это указатель часов, который следует за значением числа часов.
— M — это указатель минут, который следует за значением количества минут.
— S — второй конструктор, который следует за значением числа секунд.
Это значение длительности не может быть больше значения EventRetentionInDays раздела. Это необязательное поле, минимальное значение которого составляет 1 минуту, а максимальное значение определяется.
по значению EventRetentionInDays раздела. Ниже приведены примеры допустимых значений.
- "P0DT23H12M" или "PT23H12M": продолжительность 23 часов и 12 минут.
- "P1D" или "P1DT0H0M0S": в течение 1 дня.
строка
maxDeliveryCount Максимальное число доставок событий. INT
receiveLockDurationInSeconds Максимальный период в секундах, в течение которого сообщение находится в состоянии получения (клиентом) и ожидает принятия, освобождения или отклонения.
Если это время прошло после того, как сообщение было получено клиентом и не перемещено в принятое (не обработано), освобождено или отклонено,
сообщение доступно для повторной подготовки. Это необязательное поле, где значение по умолчанию — 60 секунд, минимальное — 60 секунд, а максимальное — 300 секунд.
INT

DeadLetterWithResourceIdentity

Имя Описание Значение
deadLetterDestination Сведения о назначении, куда должны доставляться события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно, в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeadLetterDestination
удостоверение Удостоверение, используемое при недоставленных событиях. EventSubscriptionIdentity

DeadLetterDestination

Имя Описание Значение
endpointType Установка типа объекта StorageBlob (обязательно)

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

EventSubscriptionIdentity

Имя Описание Значение
тип Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None приведет к удалению всех удостоверений. SystemAssigned
UserAssigned
userAssignedIdentity Удостоверение пользователя, связанное с ресурсом. строка

FiltersConfiguration

Имя Описание Значение
filters Массив фильтров, используемых для фильтрации подписок на события. Filter[]
includedEventTypes Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. string[]

Фильтр

Имя Описание Значение
key Поле или свойство в событии в зависимости от того, по которому требуется выполнить фильтрацию. строка
operatorType Установка типа объекта BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan;
NumberGreaterThanOrEquals;
NumberIn;
NumberInRange
NumberLessThan;
NumberGreaterThanOrEquals;
NumberNotIn.
NumberNotInRange
StringBeginsWith;
StringContains;
StringEndsWith;
StringIn;
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (обязательно)

BoolEqualsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. BoolEquals (обязательно)
значение Значение логического фильтра. bool

IsNotNullFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. IsNotNull (обязательно)

IsNullOrUndefinedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. IsNullOrUndefined (обязательно)

NumberGreaterThanFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberGreaterThan" (обязательно)
значение Значение фильтра. INT

NumberGreaterThanOrEqualsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberGreaterThanOrEquals (обязательно)
значение Значение фильтра. INT

NumberInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberIn (обязательно)
значения Набор значений фильтра. int[]

NumberInRangeFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberInRange (обязательно)
значения Набор значений фильтра. int[][]

NumberLessThanFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberLessThan (обязательно)
значение Значение фильтра. INT

NumberLessThanOrEqualsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberLessThanOrEquals (обязательно)
значение Значение фильтра. INT

NumberNotInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberNotIn (обязательно)
значения Набор значений фильтра. int[]

NumberNotInRangeFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. NumberNotInRange (обязательно)
значения Набор значений фильтра. int[][]

StringBeginsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringBeginsWith (обязательно)
значения Набор значений фильтра. string[]

StringContainsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringContains (обязательно)
значения Набор значений фильтра. string[]

StringEndsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringEndsWith (обязательно)
значения Набор значений фильтра. string[]

StringInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringIn (обязательно)
значения Набор значений фильтра. string[]

StringNotBeginsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotBeginsWith (обязательно)
значения Набор значений фильтра. string[]

StringNotContainsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotContains (обязательно)
значения Набор значений фильтра. string[]

StringNotEndsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotEndsWith (обязательно)
значения Набор значений фильтра. string[]

StringNotInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. StringNotIn (обязательно)
значения Набор значений фильтра. string[]

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

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

  • Группы ресурсов

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-06-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deliveryConfiguration = {
        deliveryMode = "Queue"
        queue = {
          deadLetterDestinationWithResourceIdentity = {
            deadLetterDestination = {
              endpointType = "string"
              // For remaining properties, see DeadLetterDestination objects
            }
            identity = {
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          eventTimeToLive = "string"
          maxDeliveryCount = int
          receiveLockDurationInSeconds = int
        }
      }
      eventDeliverySchema = "CloudEventSchemaV1_0"
      filtersConfiguration = {
        filters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see Filter objects
          }
        ]
        includedEventTypes = [
          "string"
        ]
      }
    }
  })
}

Объекты DeadLetterDestination

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

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

  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "string"
  }

Фильтрация объектов

Задайте свойство 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"
  ]

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

namespaces/topics/eventSubscriptions

Имя Описание Значение
тип Тип ресурса "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-06-01-preview"
name имя ресурса. string (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: темы
properties Свойства подписки на события. Свойства подписки

Свойства подписки

Имя Описание Значение
deliveryConfiguration Сведения о конфигурации доставки подписки на события. DeliveryConfiguration
eventDeliverySchema Схема доставки событий для подписки на события. "CloudEventSchemaV1_0"
filtersConfiguration Сведения о фильтре для подписки на события. FiltersConfiguration

DeliveryConfiguration

Имя Описание Значение
deliveryMode Режим доставки подписки на события. "Очередь"
очередь Это свойство должно быть заполнено, если deliveryMode имеет значение queue и представляет сведения о подписке очереди. QueueInfo

QueueInfo

Имя Описание Значение
deadLetterDestinationWithResourceIdentity Назначение недоставленных сообщений подписки на события. Любое событие, которое не может быть доставлено в место назначения, отправляется в место назначения недоставленных сообщений.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно в разделе) для получения маркеров проверки подлинности, используемых во время доставки или недоставленных сообщений.
DeadLetterWithResourceIdentity
eventTimeToLive Длительность интервала времени в формате ISO 8601, которая определяет, как долго сообщения доступны для подписки с момента публикации сообщения.
Это значение длительности выражается в следующем формате: "P(n)Y(n)M(n)DT(n)H(n)M(n)S", где:
— (n) заменяется значением каждого элемента времени, следующего за (n).
— P — это указатель длительности (или периода) и всегда помещается в начале длительности.
- Y является указателем года, и он следует за значением для количества лет.
— M — это индикатор месяца, который следует за значением числа месяцев.
- W — это указатель недели, который следует за значением для количества недель.
— D — это указатель дня, который следует за значением числа дней.
— T — это указатель времени, который предшествует компонентам времени.
— H — это указатель часов, который следует за значением числа часов.
— M — это указатель минут, который следует за значением для количества минут.
— S является вторым конструктором и следует за значением для количества секунд.
Это значение длительности не может быть больше значения EventRetentionInDays раздела. Это необязательное поле, где его минимальное значение составляет 1 минуту, а его максимальное значение определяется
по значению EventRetentionInDays раздела. Ниже приведены примеры допустимых значений.
- "P0DT23H12M" или "PT23H12M": продолжительность 23 часов и 12 минут.
— "P1D" или "P1DT0H0M0S": в течение 1 дня.
строка
maxDeliveryCount Максимальное число доставок событий. INT
receiveLockDurationInSeconds Максимальный период в секундах, в течение которого сообщение находится в состоянии получения (клиентом) и ожидает принятия, освобождения или отклонения.
Если это время прошло после того, как сообщение было получено клиентом и не было перенесено в принято (не обработано), выпущено или отклонено,
сообщение доступно для повторной подготовки. Это необязательное поле, где значение по умолчанию — 60 секунд, минимальное — 60 секунд, а максимальное — 300 секунд.
INT

DeadLetterWithResourceIdentity

Имя Описание Значение
deadLetterDestination Сведения о назначении, куда должны быть доставлены события для подписки на события.
Использует настройку управляемого удостоверения в родительском ресурсе (а именно в разделе или домене) для получения маркеров проверки подлинности, используемых во время доставки или недоставки сообщений.
DeadLetterDestination
удостоверение Удостоверение, используемое при недоставленных событиях. EventSubscriptionIdentity

DeadLetterDestination

Имя Описание Значение
endpointType Установка типа объекта StorageBlob (обязательно)

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

EventSubscriptionIdentity

Имя Описание Значение
тип Используемый тип управляемого удостоверения. Тип SystemAssigned, UserAssigned включает как неявно созданное удостоверение, так и набор удостоверений, назначаемых пользователем. Тип None приведет к удалению всех удостоверений. "SystemAssigned"
UserAssigned
userAssignedIdentity Удостоверение пользователя, связанное с ресурсом. строка

FiltersConfiguration

Имя Описание Значение
filters Массив фильтров, используемых для фильтрации подписок на события. Filter[]
includedEventTypes Список применимых типов событий, которые должны входить в подписку на события. Если требуется подписаться на все типы событий по умолчанию, задайте для параметра IncludedEventTypes значение NULL. string[]

Фильтр

Имя Описание Значение
key Поле или свойство в событии в зависимости от того, по которому требуется выполнить фильтрацию. строка
operatorType Установка типа объекта BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan;
NumberGreaterThanOrEquals;
NumberIn;
NumberInRange
NumberLessThan;
NumberGreaterThanOrEquals;
NumberNotIn.
NumberNotInRange
StringBeginsWith;
StringContains;
StringEndsWith;
StringIn;
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (обязательно)

BoolEqualsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. BoolEquals (обязательно)
значение Значение логического фильтра. bool

IsNotNullFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. IsNotNull (обязательно)

IsNullOrUndefinedFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "IsNullOrUndefined" (обязательно)

NumberGreaterThanFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberGreaterThan" (обязательно)
значение Значение фильтра. INT

NumberGreaterThanOrEqualsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberGreaterThanOrEquals" (обязательно)
значение Значение фильтра. INT

NumberInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberIn" (обязательно)
значения Набор значений фильтра. int[]

NumberInRangeFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberInRange" (обязательно)
значения Набор значений фильтра. int[][]

NumberLessThanFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberLessThan" (обязательно)
значение Значение фильтра. INT

NumberLessThanOrEqualsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberLessThanOrEquals" (обязательно)
значение Значение фильтра. INT

NumberNotInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberNotIn" (обязательно)
значения Набор значений фильтра. int[]

NumberNotInRangeFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "NumberNotInRange" (обязательно)
значения Набор значений фильтра. int[][]

StringBeginsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringBeginsWith" (обязательно)
значения Набор значений фильтра. string[]

StringContainsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringContains" (обязательно)
значения Набор значений фильтра. string[]

StringEndsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringEndsWith" (обязательно)
значения Набор значений фильтра. string[]

StringInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringIn" (обязательно)
значения Набор значений фильтра. string[]

StringNotBeginsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringNotBeginsWith" (обязательно)
значения Набор значений фильтра. string[]

StringNotContainsFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringNotContains" (обязательно)
значения Набор значений фильтра. string[]

StringNotEndsWithFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringNotEndsWith" (обязательно)
значения Набор значений фильтра. string[]

StringNotInFilter

Имя Описание Значение
operatorType Тип оператора, используемый для фильтрации, например NumberIn, StringContains, BoolEquals и другие. "StringNotIn" (обязательно)
значения Набор значений фильтра. string[]