Evento Microsoft.EventGridSubscriptions 2019-06-01

Artigo
01/14/2024

Definição de recurso do Bicep

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

Use a scope propriedade nesse recurso para definir o escopo desse recurso. Consulte Definir escopo em recursos de extensão no Bicep.

O tipo de recurso eventSubscriptions pode ser implantado com operações direcionadas:

Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Assinaturas – Consulte comandos de implantação de assinatura

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

Formato de recurso

Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o seguinte Bicep ao 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, use:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para o EventHub, use:

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

Para HybridConnection, use:

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

Para ServiceBusQueue, use:

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

Para StorageQueue, use:

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

Para WebHook, use:

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

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto .

Para BoolEquals, use:

  operatorType: 'BoolEquals'
  value: bool

Para NumberGreaterThan, use:

  operatorType: 'NumberGreaterThan'
  value: int

Para NumberGreaterThanOrEquals, use:

  operatorType: 'NumberGreaterThanOrEquals'
  value: int

Para NumberIn, use:

  operatorType: 'NumberIn'
  values: [
    int
  ]

Para NumberLessThan, use:

  operatorType: 'NumberLessThan'
  value: int

Para NumberLessThanOrEquals, use:

  operatorType: 'NumberLessThanOrEquals'
  value: int

Para NumberNotIn, use:

  operatorType: 'NumberNotIn'
  values: [
    int
  ]

Para StringBeginsWith, use:

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

Para StringContains, use:

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

Para StringEndsWith, use:

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

Para StringIn, use:

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

Para StringNotIn, use:

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

Valores de propriedade

eventSubscriptions

Nome	Descrição	Valor
name	O nome do recurso	cadeia de caracteres (obrigatório) Limite de caracteres: 3 a 64 Caracteres válidos: Caracteres alfanuméricos e hifens.
scope	Use ao criar um recurso de extensão em um escopo diferente do escopo de implantação.	Recurso de destino Para o Bicep, defina essa propriedade como o nome simbólico do recurso para aplicar o recurso de extensão.
properties	Propriedades da assinatura do evento	EventSubscriptionProperties

EventSubscriptionProperties

Nome	Descrição	Valor
deadLetterDestination	O destino DeadLetter da assinatura do evento.	DeadLetterDestination
destino	Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento.	EventSubscriptionDestination
expirationTimeUtc	Hora de expiração da assinatura do evento.	string
filter	Informações sobre o filtro para a assinatura do evento.	EventSubscriptionFilter
rótulos	Lista de rótulos definidos pelo usuário.	string[]
retryPolicy	A política de repetição para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida para eventos.	RetryPolicy

DeadLetterDestination

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

StorageBlobDeadLetterDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino de mensagens mortas	'StorageBlob' (obrigatório)
properties	As propriedades do destino deadletter baseado em Blob de Armazenamento	StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Nome	Descrição	Valor
blobContainerName	O nome do contêiner de blob de armazenamento que é o destino dos eventos deadletter	string
resourceId	A 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 HybridConnection ServiceBusQueue StorageQueue WebHook (obrigatório)

EventHubEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	'EventHub' (obrigatório)
properties	Propriedades do Hub de Eventos do destino da assinatura de evento	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Nome	Descrição	Valor
resourceId	A ID de Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento.	string

HybridConnectionEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	'HybridConnection' (obrigatório)
properties	Propriedades de conexão híbrida do destino da assinatura de evento	HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Nome	Descrição	Valor
resourceId	A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento.	string

ServiceBusQueueEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	'ServiceBusQueue' (obrigatório)
properties	Propriedades do Barramento de Serviço do destino da assinatura de evento	ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Nome	Descrição	Valor
resourceId	A ID de Recurso do Azure que representa o ponto de extremidade do destino do Barramento de Serviço de uma assinatura de evento.	string

StorageQueueEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	'StorageQueue' (obrigatório)
properties	Propriedades da Fila de Armazenamento do destino da assinatura de evento	StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	'WebHook' (obrigatório)
properties	Propriedades do WebHook do destino da assinatura de evento	WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nome	Descrição	Valor
endpointUrl	A URL que representa o ponto de extremidade do destino de uma assinatura de evento.	string

EventSubscriptionFilter

Nome	Descrição	Valor
Advancedfilters	Uma matriz de filtros avançados que são usados para filtrar assinaturas de evento.	AdvancedFilter[]
includedEventTypes	Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo.	string[]
isSubjectCaseSensitive	Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de maneira sensível a maiúsculas e minúsculas.	bool
subjectBeginsWith	Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho.	string
subjectEndsWith	Uma cadeia de caracteres opcional para filtrar eventos de uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho.	string

Advancedfilter

Nome	Descrição	Valor
chave	O campo/propriedade no evento com base no qual você deseja 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 usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.	'BoolEquals' (obrigatório)
value	O valor do filtro booliano.	bool

NumberGreaterThanAdvancedFilter

Nome	Descrição	Valor
operatorType	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.	'NumberGreaterThan' (obrigatório)
value	O valor do filtro.	INT

NumberGreaterThanOrEqualsAdvancedFilter

Nome	Descrição	Valor
operatorType	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.	'NumberGreaterThanOrEquals' (obrigatório)
value	O valor do filtro.	INT

NumberInAdvancedFilter

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

NumberLessThanAdvancedFilter

Nome	Descrição	Valor
operatorType	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.	'NumberLessThan' (obrigatório)
value	O valor do filtro.	INT

NumberLessThanOrEqualsAdvancedFilter

Nome	Descrição	Valor
operatorType	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.	'NumberLessThanOrEquals' (obrigatório)
value	O valor do filtro.	INT

NumberNotInAdvancedFilter

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

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotInAdvancedFilter

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

RetryPolicy

Nome	Descrição	Valor
eventTimeToLiveInMinutes	Vida Útil (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 modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Criar Grade de Eventos do Azure tópico e assinatura personalizados	Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs.
Tópico/assinatura de Grade de Eventos do Azure personalizado com CloudEvents	Cria um tópico de Grade de Eventos do Azure personalizado, uma assinatura de webhook com esquema CloudEvents e um Aplicativo Lógico como um manipulador de eventos. Modelo originalmente criado por Justin Yoo.
Criar um manipulador personalizado de tópicos e hub de eventos da Grade de Eventos	Cria um tópico personalizado Grade de Eventos do Azure e um hub de eventos para lidar com os eventos.
Criar assinatura da Grade de Eventos para eventos de recurso	Cria uma assinatura da Grade de Eventos para o grupo de recursos ou a assinatura do Azure.
Criar Grade de Eventos do Azure assinatura de fila e tópico personalizado	Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de fila do barramento de serviço. Modelo originalmente criado por Markus Meyer.
Criar Grade de Eventos do Azure assinatura de tópico personalizado	Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de tópico do barramento de serviço. 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 você pode aplicá-lo a outro recurso.

Use a scope propriedade nesse recurso para definir o escopo desse recurso. Consulte Definir escopo em recursos de extensão em modelos do ARM.

O tipo de recurso eventSubscriptions pode ser implantado com operações direcionadas:

Grupos de recursos – Consulte comandos de implantação do grupo de recursos
Assinaturas – Consulte comandos de implantação de assinatura

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

Formato de recurso

Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o JSON a seguir ao 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, use:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para o EventHub, use:

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

Para HybridConnection, use:

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

Para ServiceBusQueue, use:

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

Para StorageQueue, use:

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

Para WebHook, use:

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

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto .

Para BoolEquals, use:

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

Para NumberGreaterThan, use:

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

Para NumberGreaterThanOrEquals, use:

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

Para NumberIn, use:

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

Para NumberLessThan, use:

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

Para NumberLessThanOrEquals, use:

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

Para NumberNotIn, use:

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

Para StringBeginsWith, use:

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

Para StringContains, use:

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

Para StringEndsWith, use:

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

Para StringIn, use:

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

Para StringNotIn, use:

  "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 de caracteres (obrigatório) Limite de caracteres: 3 a 64 Caracteres válidos: Caracteres alfanuméricos e hifens.
scope	Use ao criar um recurso de extensão em um escopo diferente do escopo de implantação.	Recurso de destino Para JSON, defina o valor como o nome completo do recurso ao qual aplicar o recurso de extensão .
properties	Propriedades da assinatura do evento	EventSubscriptionProperties

EventSubscriptionProperties

Nome	Descrição	Valor
deadLetterDestination	O destino DeadLetter da assinatura do evento.	DeadLetterDestination
destino	Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento.	EventSubscriptionDestination
expirationTimeUtc	Hora de expiração da assinatura do evento.	string
filter	Informações sobre o filtro para a assinatura do evento.	EventSubscriptionFilter
rótulos	Lista de rótulos definidos pelo usuário.	string[]
retryPolicy	A política de repetição para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida para eventos.	RetryPolicy

DeadLetterDestination

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

StorageBlobDeadLetterDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino de mensagens mortas	'StorageBlob' (obrigatório)
properties	As propriedades do destino deadletter baseado em Blob de Armazenamento	StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Nome	Descrição	Valor
blobContainerName	O nome do contêiner de blob de armazenamento que é o destino dos eventos deadletter	string
resourceId	A 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 HybridConnection ServiceBusQueue StorageQueue WebHook (obrigatório)

EventHubEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	'EventHub' (obrigatório)
properties	Propriedades do Hub de Eventos do destino da assinatura de evento	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Nome	Descrição	Valor
resourceId	A ID de Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento.	string

HybridConnectionEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	'HybridConnection' (obrigatório)
properties	Propriedades de conexão híbrida do destino da assinatura de evento	HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Nome	Descrição	Valor
resourceId	A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento.	string

ServiceBusQueueEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	'ServiceBusQueue' (obrigatório)
properties	Propriedades do Barramento de Serviço do destino da assinatura de evento	ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Nome	Descrição	Valor
resourceId	A ID de Recurso do Azure que representa o ponto de extremidade do destino do Barramento de Serviço de uma assinatura de evento.	string

StorageQueueEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	'StorageQueue' (obrigatório)
properties	Propriedades da Fila de Armazenamento do destino da assinatura de evento	StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	'WebHook' (obrigatório)
properties	Propriedades do WebHook do destino da assinatura de evento	WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nome	Descrição	Valor
endpointUrl	A URL que representa o ponto de extremidade do destino de uma assinatura de evento.	string

EventSubscriptionFilter

Nome	Descrição	Valor
Advancedfilters	Uma matriz de filtros avançados que são usados para filtrar assinaturas de evento.	AdvancedFilter[]
includedEventTypes	Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo.	string[]
isSubjectCaseSensitive	Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de maneira sensível a maiúsculas e minúsculas.	bool
subjectBeginsWith	Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho.	string
subjectEndsWith	Uma cadeia de caracteres opcional para filtrar eventos de uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho.	string

Advancedfilter

Nome	Descrição	Valor
chave	O campo/propriedade no evento com base no qual você deseja 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 usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.	'BoolEquals' (obrigatório)
value	O valor do filtro booliano.	bool

NumberGreaterThanAdvancedFilter

Nome	Descrição	Valor
operatorType	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.	'NumberGreaterThan' (obrigatório)
value	O valor do filtro.	INT

NumberGreaterThanOrEqualsAdvancedFilter

Nome	Descrição	Valor
operatorType	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.	'NumberGreaterThanOrEquals' (obrigatório)
value	O valor do filtro.	INT

NumberInAdvancedFilter

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

NumberLessThanAdvancedFilter

Nome	Descrição	Valor
operatorType	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.	'NumberLessThan' (obrigatório)
value	O valor do filtro.	INT

NumberLessThanOrEqualsAdvancedFilter

Nome	Descrição	Valor
operatorType	O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.	'NumberLessThanOrEquals' (obrigatório)
value	O valor do filtro.	INT

NumberNotInAdvancedFilter

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

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotInAdvancedFilter

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

RetryPolicy

Nome	Descrição	Valor
eventTimeToLiveInMinutes	Vida útil (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 modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo	Descrição
Criar Grade de Eventos do Azure tópico e assinatura personalizados	Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs.
Tópico/assinatura de Grade de Eventos do Azure personalizado com CloudEvents	Cria um tópico de Grade de Eventos do Azure personalizado, uma assinatura de webhook com esquema CloudEvents e um Aplicativo Lógico como um manipulador de eventos. Modelo originalmente criado por Justin Yoo.
Criar um manipulador personalizado de tópicos e hub de eventos da Grade de Eventos	Cria um tópico personalizado Grade de Eventos do Azure e um hub de eventos para lidar com os eventos.
Criar assinatura da Grade de Eventos para eventos de recurso	Cria uma assinatura da Grade de Eventos para o grupo de recursos ou a assinatura do Azure.
Criar Grade de Eventos do Azure assinatura de fila e tópico personalizado	Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de fila do barramento de serviço. Modelo originalmente criado por Markus Meyer.
Criar Grade de Eventos do Azure assinatura de tópico personalizado	Cria um tópico personalizado Grade de Eventos do Azure e uma assinatura de tópico do barramento de serviço. Modelo originalmente criado por Markus Meyer.

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

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

Use a parent_id propriedade nesse recurso para definir o escopo desse recurso.

O tipo de recurso eventSubscriptions pode ser implantado com operações direcionadas:

Grupos de recursos
Assinaturas

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

Formato de recurso

Para criar um recurso Microsoft.EventGrid/eventSubscriptions, adicione o Terraform a seguir ao 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, use:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para o EventHub, use:

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

Para HybridConnection, use:

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

Para ServiceBusQueue, use:

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

Para StorageQueue, use:

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

Para WebHook, use:

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

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto .

Para BoolEquals, use:

  operatorType = "BoolEquals"
  value = bool

Para NumberGreaterThan, use:

  operatorType = "NumberGreaterThan"
  value = int

Para NumberGreaterThanOrEquals, use:

  operatorType = "NumberGreaterThanOrEquals"
  value = int

Para NumberIn, use:

  operatorType = "NumberIn"
  values = [
    int
  ]

Para NumberLessThan, use:

  operatorType = "NumberLessThan"
  value = int

Para NumberLessThanOrEquals, use:

  operatorType = "NumberLessThanOrEquals"
  value = int

Para NumberNotIn, use:

  operatorType = "NumberNotIn"
  values = [
    int
  ]

Para StringBeginsWith, use:

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

Para StringContains, use:

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

Para StringEndsWith, use:

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

Para StringIn, use:

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

Para StringNotIn, use:

  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 de caracteres (obrigatório) Limite de caracteres: 3 a 64 Caracteres válidos: Caracteres alfanuméricos e hifens.
parent_id	A ID do recurso ao qual aplicar esse recurso de extensão.	cadeia de caracteres (obrigatório)
properties	Propriedades da assinatura do evento	EventSubscriptionProperties

EventSubscriptionProperties

Nome	Descrição	Valor
deadLetterDestination	O destino DeadLetter da assinatura do evento.	DeadLetterDestination
destino	Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento.	EventSubscriptionDestination
expirationTimeUtc	Hora de expiração da assinatura do evento.	string
filter	Informações sobre o filtro para a assinatura do evento.	EventSubscriptionFilter
rótulos	Lista de rótulos definidos pelo usuário.	string[]
retryPolicy	A política de repetição para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida para eventos.	RetryPolicy

DeadLetterDestination

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

StorageBlobDeadLetterDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino de mensagens mortas	"StorageBlob" (obrigatório)
properties	As propriedades do destino de mensagens mortas baseadas em Blob de Armazenamento	StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Nome	Descrição	Valor
blobContainerName	O nome do contêiner de blob de armazenamento que é o destino dos eventos de mensagens mortas	string
resourceId	A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos de mensagens mortas	string

EventSubscriptionDestination

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

EventHubEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	"EventHub" (obrigatório)
properties	Propriedades do Hub de Eventos do destino da assinatura de evento	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Nome	Descrição	Valor
resourceId	A ID de Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento.	string

HybridConnectionEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	"HybridConnection" (obrigatório)
properties	Propriedades de conexão híbrida do destino da assinatura de evento	HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

Nome	Descrição	Valor
resourceId	A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento.	string

ServiceBusQueueEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	"ServiceBusQueue" (obrigatório)
properties	Propriedades do Barramento de Serviço do destino da assinatura de evento	ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Nome	Descrição	Valor
resourceId	A ID de Recurso do Azure que representa o ponto de extremidade do destino do Barramento de Serviço de uma assinatura de evento.	string

StorageQueueEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	"StorageQueue" (obrigatório)
properties	Propriedades da Fila de Armazenamento do destino da assinatura de evento	StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento	"WebHook" (obrigatório)
properties	Propriedades do WebHook do destino da assinatura de evento	WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nome	Descrição	Valor
endpointUrl	A URL que representa o ponto de extremidade do destino de uma assinatura de evento.	string

EventSubscriptionFilter

Nome	Descrição	Valor
Advancedfilters	Uma matriz de filtros avançados que são usados para filtrar assinaturas de evento.	AdvancedFilter[]
includedEventTypes	Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo.	string[]
isSubjectCaseSensitive	Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de maneira sensível a maiúsculas e minúsculas.	bool
subjectBeginsWith	Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho.	string
subjectEndsWith	Uma cadeia de caracteres opcional para filtrar eventos de uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho.	string

Advancedfilter

Nome	Descrição	Valor
chave	O campo/propriedade no evento com base no qual você deseja 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 usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros.	"BoolEquals" (obrigatório)
value	O valor do filtro booliano.	bool

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotInAdvancedFilter

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

RetryPolicy

Nome	Descrição	Valor
eventTimeToLiveInMinutes	Vida útil (em minutos) para eventos.	INT
maxDeliveryAttempts	Número máximo de tentativas de repetição de entrega para eventos.	INT

Compartilhar via

Evento Microsoft.EventGridSubscriptions 2019-06-01

Definição de recurso do Bicep

Formato de recurso

Objetos DeadLetterDestination

Objetos EventSubscriptionDestination

Objetos AdvancedFilter

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

Definição de recurso de modelo do ARM

Formato de recurso

Objetos DeadLetterDestination

Objetos EventSubscriptionDestination

Objetos AdvancedFilter

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

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

Formato de recurso