Share via


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:

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

Nome Descrição Valor
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 3-64

Carateres válidos:
Alfanuméricos e hífenes.
scope Utilize ao criar um recurso de extensão num âmbito diferente do âmbito de implementação. Recurso de destino

Para Bicep, defina esta propriedade como o nome simbólico do recurso para aplicar o recurso de extensão.
propriedades Propriedades da subscrição do evento EventSubscriptionProperties

EventSubscriptionProperties

Nome Descrição Valor
deadLetterDestination O destino DeadLetter da subscrição do evento. DeadLetterDestination
destino Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. EventSubscriptionDestination
expirationTimeUtc Hora de expiração da subscrição do evento. string
filter Informações sobre o filtro para a subscrição de eventos. EventSubscriptionFilter
etiquetas Lista de etiquetas definidas pelo utilizador. string[]
retryPolicy A política de repetição para eventos. Isto pode ser utilizado para configurar o número máximo de tentativas de entrega e tempo de duração para eventos. RetryPolicy

DeadLetterDestination

Nome Descrição Valor
endpointType Definir o tipo de objeto StorageBlob (obrigatório)

StorageBlobDeadLetterDestination

Nome Descrição Valor
endpointType Tipo de ponto final para o destino da letra não entregue "StorageBlob" (obrigatório)
propriedades As propriedades do destino deadletter baseado em Blobs de Armazenamento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Nome Descrição Valor
blobContainerName O nome do contentor de blobs de armazenamento que é o destino dos eventos deadletter string
resourceId O ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos deadletter string

EventSubscriptionDestination

Nome Descrição Valor
endpointType Definir o tipo de objeto EventHub
Ligação Híbrida
ServiceBusQueue
StorageQueue
WebHook (obrigatório)

EventHubEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "EventHub" (obrigatório)
propriedades Propriedades do Hub de Eventos do destino da subscrição de eventos EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Nome Descrição Valor
resourceId O ID de Recurso do Azure que representa o ponto final de um destino do Hub de Eventos de uma subscrição de evento. string

HybridConnectionEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "HybridConnection" (obrigatório)
propriedades Propriedades da ligação híbrida do destino da subscrição de eventos HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Nome Descrição Valor
resourceId O ID de Recurso do Azure de uma ligação híbrida que é o destino de uma subscrição de evento. string

ServiceBusQueueEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "ServiceBusQueue" (obrigatório)
propriedades Propriedades do Service Bus do destino da subscrição de eventos ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Nome Descrição Valor
resourceId O ID de Recurso do Azure que representa o ponto final do destino do Service Bus de uma subscrição de evento. string

StorageQueueEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "StorageQueue" (obrigatório)
propriedades Propriedades da Fila de Armazenamento do destino da subscrição de eventos StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Nome Descrição Valor
queueName O nome da fila de Armazenamento numa conta de armazenamento que é o destino de uma subscrição de evento. string
resourceId O ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma subscrição de evento. string

WebHookEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "WebHook" (obrigatório)
propriedades Propriedades do WebHook do destino da subscrição de eventos WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nome Descrição Valor
endpointUrl O URL que representa o ponto final do destino de uma subscrição de evento. string

EventSubscriptionFilter

Nome Descrição Valor
advancedFilters Uma matriz de filtros avançados que são utilizados para filtrar subscrições de eventos. AdvancedFilter[]
includedEventTypes Uma lista dos tipos de evento aplicáveis que têm de fazer parte da subscrição do evento. Se quiser subscrever todos os tipos de eventos predefinidos, defina IncludedEventTypes como nulo. cadeia[]
isSubjectCaseSensitive Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro
deve ser comparado de forma sensível a maiúsculas e minúsculas.
bool
subjectBeginsWith Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num prefixo de caminho de recurso.
O formato deste procedimento depende do publicador dos eventos.
Os carateres universais não são suportados neste caminho.
string
subjectEndsWith Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num sufixo de caminho de recurso.
Os carateres universais não são suportados neste caminho.
string

AdvancedFilter

Nome Descrição Valor
chave O campo/propriedade no evento com base no qual pretende filtrar. string
operatorType Definir o tipo de objeto BoolEquals
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotIn (obrigatório)

BoolEqualsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "BoolEquals" (obrigatório)
valor O valor do filtro booleano. bool

NumberGreaterThanAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberGreaterThan" (obrigatório)
valor O valor do filtro. int

NumberGreaterThanOrEqualsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberGreaterThanOrEquals" (obrigatório)
valor O valor do filtro. int

NumberInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberIn" (obrigatório)
values O conjunto de valores de filtro. int[]

NumberLessThanAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberLessThan" (obrigatório)
valor O valor do filtro. int

NumberLessThanOrEqualsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberLessThanOrEquals" (obrigatório)
valor O valor do filtro. int

NumberNotInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberNotIn" (obrigatório)
values O conjunto de valores de filtro. int[]

StringBeginsWithAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringBeginsWith" (obrigatório)
values O conjunto de valores de filtro. string[]

StringContainsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringContains" (obrigatório)
values O conjunto de valores de filtro. string[]

StringEndsWithAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringEndsWith" (obrigatório)
values O conjunto de valores de filtro. string[]

StringInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringIn" (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringNotIn" (obrigatório)
values O conjunto de valores de filtro. string[]

RetryPolicy

Nome Descrição Valor
eventTimeToLiveInMinutes Time To Live (em minutos) para eventos. int
maxDeliveryAttempts Número máximo de tentativas de repetição de entrega para eventos. int

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

Implementar no Azure
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

Implementar no Azure
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

Implementar no Azure
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

Implementar no Azure
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

Implementar no Azure
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

Implementar no Azure
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:

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

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.EventGrid/eventSubscriptions"
apiVersion A versão da API de recursos '2019-06-01'
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 3-64

Carateres válidos:
Alfanuméricos e hífenes.
scope Utilize ao criar um recurso de extensão num âmbito diferente do âmbito de implementação. Recurso de destino

Para JSON, defina o valor como o nome completo do recurso ao qual pretende aplicar o recurso de extensão .
propriedades Propriedades da subscrição do evento EventSubscriptionProperties

EventSubscriptionProperties

Nome Descrição Valor
deadLetterDestination O destino DeadLetter da subscrição do evento. DeadLetterDestination
destino Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. EventSubscriptionDestination
expirationTimeUtc Tempo de expiração da subscrição do evento. string
filter Informações sobre o filtro da subscrição do evento. EventSubscriptionFilter
etiquetas Lista de etiquetas definidas pelo utilizador. cadeia[]
retryPolicy A política de repetição para eventos. Isto pode ser utilizado para configurar o número máximo de tentativas de entrega e tempo de transmissão em direto para eventos. RetryPolicy

DeadLetterDestination

Nome Descrição Valor
endpointType Definir o tipo de objeto StorageBlob (obrigatório)

StorageBlobDeadLetterDestination

Nome Descrição Valor
endpointType Tipo de ponto final para o destino da letra não entregue "StorageBlob" (obrigatório)
propriedades As propriedades do destino deadletter baseado em Blobs de Armazenamento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Nome Descrição Valor
blobContainerName O nome do contentor de blobs de armazenamento que é o destino dos eventos deadletter string
resourceId O ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos deadletter string

EventSubscriptionDestination

Nome Descrição Valor
endpointType Definir o tipo de objeto EventHub
Ligação Híbrida
ServiceBusQueue
StorageQueue
WebHook (obrigatório)

EventHubEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "EventHub" (obrigatório)
propriedades Propriedades do Hub de Eventos do destino da subscrição de eventos EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Nome Descrição Valor
resourceId O ID de Recurso do Azure que representa o ponto final de um destino do Hub de Eventos de uma subscrição de evento. string

HybridConnectionEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "HybridConnection" (obrigatório)
propriedades Propriedades da ligação híbrida do destino da subscrição de eventos HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Nome Descrição Valor
resourceId O ID de Recurso do Azure de uma ligação híbrida que é o destino de uma subscrição de evento. string

ServiceBusQueueEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "ServiceBusQueue" (obrigatório)
propriedades Propriedades do Service Bus do destino da subscrição de eventos ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Nome Descrição Valor
resourceId O ID de Recurso do Azure que representa o ponto final do destino do Service Bus de uma subscrição de evento. string

StorageQueueEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "StorageQueue" (obrigatório)
propriedades Propriedades da Fila de Armazenamento do destino da subscrição de eventos StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Nome Descrição Valor
queueName O nome da fila de Armazenamento numa conta de armazenamento que é o destino de uma subscrição de evento. string
resourceId O ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma subscrição de evento. string

WebHookEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "WebHook" (obrigatório)
propriedades Propriedades do WebHook do destino da subscrição de eventos WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nome Descrição Valor
endpointUrl O URL que representa o ponto final do destino de uma subscrição de evento. string

EventSubscriptionFilter

Nome Descrição Valor
advancedFilters Uma matriz de filtros avançados que são utilizados para filtrar subscrições de eventos. AdvancedFilter[]
includedEventTypes Uma lista dos tipos de evento aplicáveis que têm de fazer parte da subscrição do evento. Se quiser subscrever todos os tipos de eventos predefinidos, defina IncludedEventTypes como nulo. cadeia[]
isSubjectCaseSensitive Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro
deve ser comparado de forma sensível a maiúsculas e minúsculas.
bool
subjectBeginsWith Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num prefixo de caminho de recurso.
O formato deste procedimento depende do publicador dos eventos.
Os carateres universais não são suportados neste caminho.
string
subjectEndsWith Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num sufixo de caminho de recurso.
Os carateres universais não são suportados neste caminho.
string

AdvancedFilter

Nome Descrição Valor
chave O campo/propriedade no evento com base no qual pretende filtrar. string
operatorType Definir o tipo de objeto BoolEquals
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotIn (obrigatório)

BoolEqualsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "BoolEquals" (obrigatório)
valor O valor do filtro booleano. bool

NumberGreaterThanAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberGreaterThan" (obrigatório)
valor O valor do filtro. int

NumberGreaterThanOrEqualsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberGreaterThanOrEquals" (obrigatório)
valor O valor do filtro. int

NumberInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberIn" (obrigatório)
values O conjunto de valores de filtro. int[]

NumberLessThanAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberLessThan" (obrigatório)
valor O valor do filtro. int

NumberLessThanOrEqualsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberLessThanOrEquals" (obrigatório)
valor O valor do filtro. int

NumberNotInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberNotIn" (obrigatório)
values O conjunto de valores de filtro. int[]

StringBeginsWithAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringBeginsWith" (obrigatório)
values O conjunto de valores de filtro. string[]

StringContainsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringContains" (obrigatório)
values O conjunto de valores de filtro. string[]

StringEndsWithAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringEndsWith" (obrigatório)
values O conjunto de valores de filtro. string[]

StringInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringIn" (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringNotIn" (obrigatório)
values O conjunto de valores de filtro. string[]

RetryPolicy

Nome Descrição Valor
eventTimeToLiveInMinutes Time To Live (em minutos) para eventos. int
maxDeliveryAttempts Número máximo de tentativas de repetição de entrega para eventos. int

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

Implementar no Azure
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

Implementar no Azure
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

Implementar no Azure
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

Implementar no Azure
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

Implementar no Azure
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

Implementar no Azure
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

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.EventGrid/eventSubscriptions@2019-06-01"
name O nome do recurso cadeia (obrigatório)

Limite de carateres: 3-64

Carateres válidos:
Alfanuméricos e hífenes.
parent_id O ID do recurso para aplicar este recurso de extensão. cadeia (obrigatório)
propriedades Propriedades da subscrição do evento EventSubscriptionProperties

EventSubscriptionProperties

Nome Descrição Valor
deadLetterDestination O destino DeadLetter da subscrição do evento. DeadLetterDestination
destino Informações sobre o destino onde os eventos têm de ser entregues para a subscrição do evento. EventSubscriptionDestination
expirationTimeUtc Tempo de expiração da subscrição do evento. string
filter Informações sobre o filtro da subscrição do evento. EventSubscriptionFilter
etiquetas Lista de etiquetas definidas pelo utilizador. cadeia[]
retryPolicy A política de repetição para eventos. Isto pode ser utilizado para configurar o número máximo de tentativas de entrega e tempo de transmissão em direto para eventos. RetryPolicy

DeadLetterDestination

Nome Descrição Valor
endpointType Definir o tipo de objeto StorageBlob (obrigatório)

StorageBlobDeadLetterDestination

Nome Descrição Valor
endpointType Tipo de ponto final para o destino da letra não entregue "StorageBlob" (obrigatório)
propriedades As propriedades do destino deadletter baseado em Blobs de Armazenamento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Nome Descrição Valor
blobContainerName O nome do contentor de blobs de armazenamento que é o destino dos eventos deadletter string
resourceId O ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos deadletter string

EventSubscriptionDestination

Nome Descrição Valor
endpointType Definir o tipo de objeto EventHub
Ligação Híbrida
ServiceBusQueue
StorageQueue
WebHook (obrigatório)

EventHubEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "EventHub" (obrigatório)
propriedades Propriedades do Hub de Eventos do destino da subscrição de eventos EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Nome Descrição Valor
resourceId O ID de Recurso do Azure que representa o ponto final de um destino do Hub de Eventos de uma subscrição de evento. string

HybridConnectionEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "HybridConnection" (obrigatório)
propriedades Propriedades da ligação híbrida do destino da subscrição de eventos HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Nome Descrição Valor
resourceId O ID de Recurso do Azure de uma ligação híbrida que é o destino de uma subscrição de evento. string

ServiceBusQueueEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto final para o destino da subscrição de eventos "ServiceBusQueue" (obrigatório)
propriedades Propriedades do Service Bus do destino da subscrição de eventos ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Nome Descrição Valor
resourceId O ID de Recurso do Azure que representa o ponto final do destino do Service Bus de uma subscrição de evento. string

StorageQueueEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo de ponto final para o destino da subscrição de eventos "StorageQueue" (obrigatório)
propriedades Propriedades da Fila de Armazenamento do destino da subscrição de eventos StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Nome Descrição Valor
queueName O nome da fila de Armazenamento numa conta de armazenamento que é o destino de uma subscrição de evento. string
resourceId O ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma subscrição de evento. string

WebHookEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo de ponto final para o destino da subscrição de eventos "WebHook" (obrigatório)
propriedades Propriedades do WebHook do destino da subscrição do evento WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nome Descrição Valor
endpointUrl O URL que representa o ponto final do destino de uma subscrição de evento. string

EventSubscriptionFilter

Nome Descrição Valor
advancedFilters Uma matriz de filtros avançados que são utilizados para filtrar subscrições de eventos. AdvancedFilter[]
includedEventTypes Uma lista dos tipos de evento aplicáveis que têm de fazer parte da subscrição do evento. Se pretender subscrever todos os tipos de eventos predefinidos, defina IncludedEventTypes como nulo. string[]
isSubjectCaseSensitive Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro
deve ser comparado de forma sensível a maiúsculas e minúsculas.
bool
subjectBeginsWith Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num prefixo de caminho de recurso.
O formato depende do publicador dos eventos.
Os carateres universais não são suportados neste caminho.
string
subjectEndsWith Uma cadeia opcional para filtrar eventos para uma subscrição de evento com base num sufixo de caminho de recurso.
Os carateres universais não são suportados neste caminho.
string

AdvancedFilter

Nome Descrição Valor
chave O campo/propriedade no evento com base no qual pretende filtrar. string
operatorType Definir o tipo de objeto BoolEquals
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberLessThan
NumberLessThanOrEquals
NúmNotIn
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotIn (obrigatório)

BoolEqualsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "BoolEquals" (obrigatório)
valor O valor do filtro booleano. bool

NumberGreaterThanAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberGreaterThan" (obrigatório)
valor O valor do filtro. int

NumberGreaterThanOrEqualsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberGreaterThanOrEquals" (obrigatório)
valor O valor do filtro. int

NumberInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberIn" (obrigatório)
values O conjunto de valores de filtro. int[]

NumberLessThanAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberLessThan" (obrigatório)
valor O valor do filtro. int

NumberLessThanOrEqualsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberLessThanOrEquals" (obrigatório)
valor O valor do filtro. int

NumberNotInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "NumberNotIn" (obrigatório)
values O conjunto de valores de filtro. int[]

StringBeginsWithAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringBeginsWith" (obrigatório)
values O conjunto de valores de filtro. cadeia[]

StringContainsAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringContains" (obrigatório)
values O conjunto de valores de filtro. cadeia[]

StringEndsWithAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringEndsWith" (obrigatório)
values O conjunto de valores de filtro. cadeia[]

StringInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringIn" (obrigatório)
values O conjunto de valores de filtro. cadeia[]

StringNotInAdvancedFilter

Nome Descrição Valor
operatorType O tipo de operador utilizado para filtrar, por exemplo, NumberIn, StringContains, BoolEquals e outros. "StringNotIn" (obrigatório)
values O conjunto de valores de filtro. cadeia[]

RetryPolicy

Nome Descrição Valor
eventTimeToLiveInMinutes Time To Live (em minutos) para eventos. int
maxDeliveryAttempts Número máximo de tentativas de repetição de entrega para eventos. int