Microsoft.EventGrid eventSubscriptions 2019-06-01

Definição de recurso do Bicep

O tipo de recurso eventSubscriptions é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.

Utilize a scope propriedade neste recurso para definir o âmbito deste recurso. Veja Definir âmbito nos recursos de extensão no Bicep.

O tipo de recurso eventSubscriptions pode ser implementado com operações que visam:

• Grupos de recursos – veja os comandos de implementação do grupo de recursos
• Subscrições – veja os comandos de implementação da subscrição

Para obter uma lista das propriedades alteradas em cada versão da API, veja Registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2019-06-01' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    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
    }
  }
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, utilize:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para o EventHub, utilize:

  endpointType: 'EventHub'
  properties: {
    resourceId: 'string'
  }

Para HybridConnection, utilize:

  endpointType: 'HybridConnection'
  properties: {
    resourceId: 'string'
  }

Para ServiceBusQueue, utilize:

  endpointType: 'ServiceBusQueue'
  properties: {
    resourceId: 'string'
  }

Para StorageQueue, utilize:

  endpointType: 'StorageQueue'
  properties: {
    queueName: 'string'
    resourceId: 'string'
  }

Para o WebHook, utilize:

  endpointType: 'WebHook'
  properties: {
    endpointUrl: 'string'
  }

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto.

Para BoolEquals, utilize:

  operatorType: 'BoolEquals'
  value: bool

Para NumberGreaterThan, utilize:

  operatorType: 'NumberGreaterThan'
  value: int

Para NumberGreaterThanOrEquals, utilize:

  operatorType: 'NumberGreaterThanOrEquals'
  value: int

Para NumberIn, utilize:

  operatorType: 'NumberIn'
  values: [
    int
  ]

Para NumberLessThan, utilize:

  operatorType: 'NumberLessThan'
  value: int

Para NumberLessThanOrEquals, utilize:

  operatorType: 'NumberLessThanOrEquals'
  value: int

Para NumberNotIn, utilize:

  operatorType: 'NumberNotIn'
  values: [
    int
  ]

Para StringBeginsWith, utilize:

  operatorType: 'StringBeginsWith'
  values: [
    'string'
  ]

Para StringContains, utilize:

  operatorType: 'StringContains'
  values: [
    'string'
  ]

Para StringEndsWith, utilize:

  operatorType: 'StringEndsWith'
  values: [
    'string'
  ]

Para StringIn, utilize:

  operatorType: 'StringIn'
  values: [
    'string'
  ]

Para StringNotIn, utilize:

  operatorType: 'StringNotIn'
  values: [
    'string'
  ]

Valores de propriedade

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

ServiceBusQueueEventSubscriptionDestination

ServiceBusQueueEventSubscriptionDestinationPropertie...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

AdvancedFilter

BoolEqualsAdvancedFilter

NumberGreaterThanAdvancedFilter

NumberGreaterThanOrEqualsAdvancedFilter

NumberInAdvancedFilter

NumberLessThanAdvancedFilter

NumberLessThanOrEqualsAdvancedFilter

NumberNotInAdvancedFilter

StringBeginsWithAdvancedFilter

StringContainsAdvancedFilter

StringEndsWithAdvancedFilter

StringInAdvancedFilter

StringNotInAdvancedFilter

RetryPolicy

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Criar Azure Event Grid Tópico Personalizado e Subscrição	Cria um tópico personalizado Azure Event Grid e uma subscrição de webhook. Modelo originalmente criado por John Downs.
Tópico/Subscrição de Azure Event Grid Personalizado com o CloudEvents	Cria um tópico de Azure Event Grid personalizado, uma subscrição de webhook com esquema CloudEvents e uma Aplicação Lógica como processador de eventos. Modelo originalmente criado por Justin Yoo.
Criar tópico personalizado do Event Grid e processador do hub de eventos	Cria um Azure Event Grid tópico personalizado e hub de eventos para processar os eventos.
Criar uma subscrição do Event Grid para eventos de recursos	Cria uma subscrição do Event Grid para um grupo de recursos ou uma subscrição do Azure.
Criar Azure Event Grid Tópico Personalizado e Subscrição de Fila	Cria um tópico personalizado Azure Event Grid e uma subscrição de fila do service bus. Modelo originalmente criado por Markus Meyer.
Criar Azure Event Grid Subscrição de Tópico Personalizado	Cria um tópico personalizado Azure Event Grid e uma subscrição de tópico do service bus. Modelo originalmente criado por Markus Meyer.

Definição de recurso de modelo do ARM

O tipo de recurso eventSubscriptions é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.

Utilize a scope propriedade neste recurso para definir o âmbito deste recurso. Veja Definir âmbito nos recursos de extensão nos modelos do ARM.

O tipo de recurso eventSubscriptions pode ser implementado com operações que visam:

• Grupos de recursos – veja comandos de implementação de grupos de recursos
• Subscrições - Veja os comandos de implementação da subscrição

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o seguinte JSON ao seu modelo.

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

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, utilize:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para o EventHub, utilize:

  "endpointType": "EventHub",
  "properties": {
    "resourceId": "string"
  }

Para HybridConnection, utilize:

  "endpointType": "HybridConnection",
  "properties": {
    "resourceId": "string"
  }

Para ServiceBusQueue, utilize:

  "endpointType": "ServiceBusQueue",
  "properties": {
    "resourceId": "string"
  }

Para StorageQueue, utilize:

  "endpointType": "StorageQueue",
  "properties": {
    "queueName": "string",
    "resourceId": "string"
  }

Para WebHook, utilize:

  "endpointType": "WebHook",
  "properties": {
    "endpointUrl": "string"
  }

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto.

Para BoolEquals, utilize:

  "operatorType": "BoolEquals",
  "value": "bool"

Para NumberGreaterThan, utilize:

  "operatorType": "NumberGreaterThan",
  "value": "int"

Para NumberGreaterThanOrEquals, utilize:

  "operatorType": "NumberGreaterThanOrEquals",
  "value": "int"

Para NumberIn, utilize:

  "operatorType": "NumberIn",
  "values": [ "int" ]

Para NumberLessThan, utilize:

  "operatorType": "NumberLessThan",
  "value": "int"

Para NumberLessThanOrEquals, utilize:

  "operatorType": "NumberLessThanOrEquals",
  "value": "int"

Para NumberNotIn, utilize:

  "operatorType": "NumberNotIn",
  "values": [ "int" ]

Para StringBeginsWith, utilize:

  "operatorType": "StringBeginsWith",
  "values": [ "string" ]

Para StringContains, utilize:

  "operatorType": "StringContains",
  "values": [ "string" ]

Para StringEndsWith, utilize:

  "operatorType": "StringEndsWith",
  "values": [ "string" ]

Para StringIn, utilize:

  "operatorType": "StringIn",
  "values": [ "string" ]

Para StringNotIn, utilize:

  "operatorType": "StringNotIn",
  "values": [ "string" ]

Valores de propriedade

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

ServiceBusQueueEventSubscriptionDestination

ServiceBusQueueEventSubscriptionDestinationPropertie...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

AdvancedFilter

BoolEqualsAdvancedFilter

NumberGreaterThanAdvancedFilter

NumberGreaterThanOrEqualsAdvancedFilter

NumberInAdvancedFilter

NumberLessThanAdvancedFilter

NumberLessThanOrEqualsAdvancedFilter

NumberNotInAdvancedFilter

StringBeginsWithAdvancedFilter

StringContainsAdvancedFilter

StringEndsWithAdvancedFilter

StringInAdvancedFilter

StringNotInAdvancedFilter

RetryPolicy

Modelos de início rápido

Os seguintes modelos de início rápido implementam este tipo de recurso.

Modelo	Description
Criar Azure Event Grid Tópico Personalizado e Subscrição	Cria um tópico personalizado Azure Event Grid e uma subscrição de webhook. Modelo originalmente criado por John Downs.
Tópico/Subscrição de Azure Event Grid Personalizado com o CloudEvents	Cria um tópico de Azure Event Grid personalizado, uma subscrição de webhook com esquema CloudEvents e uma Aplicação Lógica como processador de eventos. Modelo originalmente criado por Justin Yoo.
Criar tópico personalizado do Event Grid e processador do hub de eventos	Cria um Azure Event Grid tópico personalizado e hub de eventos para processar os eventos.
Criar uma subscrição do Event Grid para eventos de recursos	Cria uma subscrição do Event Grid para um grupo de recursos ou uma subscrição do Azure.
Criar Azure Event Grid Tópico Personalizado e Subscrição de Fila	Cria um tópico personalizado Azure Event Grid e uma subscrição de fila do service bus. Modelo originalmente criado por Markus Meyer.
Criar Azure Event Grid Subscrição de Tópico Personalizado	Cria um tópico personalizado Azure Event Grid e uma subscrição de tópico do service bus. Modelo originalmente criado por Markus Meyer.

Definição de recurso do Terraform (fornecedor AzAPI)

O tipo de recurso eventSubscriptions é um recurso de extensão, o que significa que pode aplicá-lo a outro recurso.

Utilize a parent_id propriedade neste recurso para definir o âmbito deste recurso.

O tipo de recurso eventSubscriptions pode ser implementado com operações que visam:

• Grupos de recursos
• Subscrições

Para obter uma lista de propriedades alteradas em cada versão da API, veja registo de alterações.

Formato do recurso

Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2019-06-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
      }
      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
      }
    }
  })
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, utilize:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para o EventHub, utilize:

  endpointType = "EventHub"
  properties = {
    resourceId = "string"
  }

Para HybridConnection, utilize:

  endpointType = "HybridConnection"
  properties = {
    resourceId = "string"
  }

Para ServiceBusQueue, utilize:

  endpointType = "ServiceBusQueue"
  properties = {
    resourceId = "string"
  }

Para StorageQueue, utilize:

  endpointType = "StorageQueue"
  properties = {
    queueName = "string"
    resourceId = "string"
  }

Para WebHook, utilize:

  endpointType = "WebHook"
  properties = {
    endpointUrl = "string"
  }

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto.

Para BoolEquals, utilize:

  operatorType = "BoolEquals"
  value = bool

Para NumberGreaterThan, utilize:

  operatorType = "NumberGreaterThan"
  value = int

Para NumberGreaterThanOrEquals, utilize:

  operatorType = "NumberGreaterThanOrEquals"
  value = int

Para NumberIn, utilize:

  operatorType = "NumberIn"
  values = [
    int
  ]

Para NumberLessThan, utilize:

  operatorType = "NumberLessThan"
  value = int

Para NumberLessThanOrEquals, utilize:

  operatorType = "NumberLessThanOrEquals"
  value = int

Para NumberNotIn, utilize:

  operatorType = "NumberNotIn"
  values = [
    int
  ]

Para StringBeginsWith, utilize:

  operatorType = "StringBeginsWith"
  values = [
    "string"
  ]

Para StringContains, utilize:

  operatorType = "StringContains"
  values = [
    "string"
  ]

Para StringEndsWith, utilize:

  operatorType = "StringEndsWith"
  values = [
    "string"
  ]

Para StringIn, utilize:

  operatorType = "StringIn"
  values = [
    "string"
  ]

Para StringNotIn, utilize:

  operatorType = "StringNotIn"
  values = [
    "string"
  ]

Valores de propriedade

eventSubscriptions

EventSubscriptionProperties

DeadLetterDestination

StorageBlobDeadLetterDestination

StorageBlobDeadLetterDestinationProperties

EventSubscriptionDestination

EventHubEventSubscriptionDestination

EventHubEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestination

HybridConnectionEventSubscriptionDestinationProperti...

ServiceBusQueueEventSubscriptionDestination

ServiceBusQueueEventSubscriptionDestinationPropertie...

StorageQueueEventSubscriptionDestination

StorageQueueEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestination

WebHookEventSubscriptionDestinationProperties

EventSubscriptionFilter

AdvancedFilter

BoolEqualsAdvancedFilter

NumberGreaterThanAdvancedFilter

NumberGreaterThanOrEqualsAdvancedFilter

NumberInAdvancedFilter

NumberLessThanAdvancedFilter

NumberLessThanOrEqualsAdvancedFilter

NumberNotInAdvancedFilter

StringBeginsWithAdvancedFilter

StringContainsAdvancedFilter

StringEndsWithAdvancedFilter

StringInAdvancedFilter

StringNotInAdvancedFilter

RetryPolicy