Partilhar via


Microsoft.EventGrid eventSubscriptions 2018-09-15-preview

Definição de recursos do bíceps

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

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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@2018-09-15-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    eventDeliverySchema: 'string'
    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 EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para EventHub, use:

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

Para HybridConnection, use:

{
  endpointType: 'HybridConnection'
  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'
  ]
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob , use:

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

Valores de propriedade

AdvancedFilter

Designação Descrição Valor
chave A chave de filtro. Representa uma propriedade de evento com até dois níveis de aninhamento. string
Tipo de operador Defina como 'BoolEquals' para o tipo BoolEqualsAdvancedFilter. Defina como 'NumberGreaterThan' para o tipo NumberGreaterThanAdvancedFilter. Defina como 'NumberGreaterThanOrEquals' para o tipo NumberGreaterThanOrEqualsAdvancedFilter. Defina como 'NumberIn' para o tipo NumberInAdvancedFilter. Defina como 'NumberLessThan' para o tipo NumberLessThanAdvancedFilter. Defina como 'NumberLessThanOrEquals' para o tipo NumberLessThanOrEqualsAdvancedFilter. Defina como 'NumberNotIn' para o tipo NumberNotInAdvancedFilter. Defina como 'StringBeginsWith' para o tipo StringBeginsWithAdvancedFilter. Defina como 'StringContains' para o tipo StringContainsAdvancedFilter. Defina como 'StringEndsWith' para o tipo StringEndsWithAdvancedFilter. Defina como 'StringIn' para o tipo StringInAdvancedFilter. Defina como 'StringNotIn' para o tipo StringNotInAdvancedFilter. 'BoolEquals'
'NúmeroMaiorQue'
'NúmeroMaiorThanOrEquals'
'NumberIn'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotIn' (obrigatório)

BoolEqualsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'BoolEquals' (obrigatório)
valor O valor do filtro Bool

DeadLetterDestination

Designação Descrição Valor
endpointType Defina como 'StorageBlob' para o tipo StorageBlobDeadLetterDestination. 'StorageBlob' (obrigatório)

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Designação Descrição Valor
resourceId A Id de Recursos do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. string

EventSubscriptionDestination

Designação Descrição Valor
endpointType Defina como 'EventHub' para o tipo EventHubEventSubscriptionDestination. Defina como 'HybridConnection' para o tipo HybridConnectionEventSubscriptionDestination. Defina como 'StorageQueue' para o tipo StorageQueueEventSubscriptionDestination. Defina como 'WebHook' para o tipo WebHookEventSubscriptionDestination. 'EventHub'
'HybridConnection'
'StorageQueue'
'WebHook' (obrigatório)

EventSubscriptionFilter

Designação Descrição Valor
avançadoFiltros Uma lista de filtros avançados. AdvancedFilter[]
incluídoTipos de Evento Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento.
Se desejar inscrever-se em todos os tipos de evento, a cadeia de caracteres "all" precisa ser especificada como um elemento nesta lista.
string[]
isSubjectCaseSensitive Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro
devem ser comparados de forma sensível a maiúsculas e minúsculas.
Bool
assuntoComeçaCom Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso.
O formato depende do editor dos eventos.
Não há suporte para caracteres curinga neste caminho.
string
assuntoTermina Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo de caminho de recurso.
Não há suporte para caracteres curinga neste caminho.
string

EventSubscriptionProperties

Designação Descrição Valor
deadLetterDestino O destino DeadLetter da assinatura do evento. DeadLetterDestination
destino Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento. EventSubscriptionDestination
eventDeliverySchema O esquema de entrega de eventos para a assinatura do evento. 'CloudEventV01Schema'
'CustomInputSchema'
'EventGridSchema'
expiraçãoTimeUtc Tempo de expiração da subscrição do evento. string
filtrar 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 o tempo de vida dos eventos. RetryPolicy

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

Designação 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

Microsoft.EventGrid/eventSubscriptions

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
propriedades Propriedades da subscrição do evento EventSubscriptionProperties
Âmbito de aplicação Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .

NumberGreaterThanAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberGreaterThan' (obrigatório)
valor O valor do filtro Int

NumberGreaterThanOrEqualsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberGreaterThanOrEquals' (obrigatório)
valor O valor do filtro Int

NumberInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberIn' (obrigatório)
valores O conjunto de valores de filtro int[]

NumberLessThanAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberLessThan' (obrigatório)
valor O valor do filtro Int

NumberLessThanOrEqualsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberLessThanOrEquals' (obrigatório)
valor O valor do filtro Int

NumberNotInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberNotIn' (obrigatório)
valores O conjunto de valores de filtro int[]

RetryPolicy

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

StorageBlobDeadLetterDestination

Designação Descrição Valor
endpointType Tipo de ponto de extremidade para o destino da letra morta 'StorageBlob' (obrigatório)
propriedades As propriedades do destino de deadletter baseado em Blob de Armazenamento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Designação 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

StorageQueueEventSubscriptionDestination

Designação Descrição Valor
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento 'StorageQueue' (obrigatório)
propriedades Propriedades da fila de armazenamento do destino da assinatura do evento StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Designação 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

StringBeginsWithAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringBeginsWith' (obrigatório)
valores O conjunto de valores de filtro string[]

StringContainsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringContains' (obrigatório)
valores O conjunto de valores de filtro string[]

StringEndsWithAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringEndsWith' (obrigatório)
valores O conjunto de valores de filtro string[]

StringInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringIn' (obrigatório)
valores O conjunto de valores de filtro string[]

StringNotInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringNotIn' (obrigatório)
valores O conjunto de valores de filtro string[]

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

Exemplos de início rápido

Os exemplos de início rápido a seguir implantam esse tipo de recurso.

Arquivo Bicep Descrição
Criar Tópico Personalizado da Grade de Eventos do Azure e de Assinatura de Fila Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de fila de barramento de serviço. Modelo originalmente de autoria de Markus Meyer.
Criar tópico personalizado da grade de eventos do Azure e de assinatura Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs.

Definição de recurso de modelo ARM

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

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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": "2018-09-15-preview",
  "name": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "eventDeliverySchema": "string",
    "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 EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para EventHub, use:

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

Para HybridConnection, use:

{
  "endpointType": "HybridConnection",
  "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" ]
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob , use:

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

Valores de propriedade

AdvancedFilter

Designação Descrição Valor
chave A chave de filtro. Representa uma propriedade de evento com até dois níveis de aninhamento. string
Tipo de operador Defina como 'BoolEquals' para o tipo BoolEqualsAdvancedFilter. Defina como 'NumberGreaterThan' para o tipo NumberGreaterThanAdvancedFilter. Defina como 'NumberGreaterThanOrEquals' para o tipo NumberGreaterThanOrEqualsAdvancedFilter. Defina como 'NumberIn' para o tipo NumberInAdvancedFilter. Defina como 'NumberLessThan' para o tipo NumberLessThanAdvancedFilter. Defina como 'NumberLessThanOrEquals' para o tipo NumberLessThanOrEqualsAdvancedFilter. Defina como 'NumberNotIn' para o tipo NumberNotInAdvancedFilter. Defina como 'StringBeginsWith' para o tipo StringBeginsWithAdvancedFilter. Defina como 'StringContains' para o tipo StringContainsAdvancedFilter. Defina como 'StringEndsWith' para o tipo StringEndsWithAdvancedFilter. Defina como 'StringIn' para o tipo StringInAdvancedFilter. Defina como 'StringNotIn' para o tipo StringNotInAdvancedFilter. 'BoolEquals'
'NúmeroMaiorQue'
'NúmeroMaiorThanOrEquals'
'NumberIn'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotIn' (obrigatório)

BoolEqualsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'BoolEquals' (obrigatório)
valor O valor do filtro Bool

DeadLetterDestination

Designação Descrição Valor
endpointType Defina como 'StorageBlob' para o tipo StorageBlobDeadLetterDestination. 'StorageBlob' (obrigatório)

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Designação Descrição Valor
resourceId A Id de Recursos do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. string

EventSubscriptionDestination

Designação Descrição Valor
endpointType Defina como 'EventHub' para o tipo EventHubEventSubscriptionDestination. Defina como 'HybridConnection' para o tipo HybridConnectionEventSubscriptionDestination. Defina como 'StorageQueue' para o tipo StorageQueueEventSubscriptionDestination. Defina como 'WebHook' para o tipo WebHookEventSubscriptionDestination. 'EventHub'
'HybridConnection'
'StorageQueue'
'WebHook' (obrigatório)

EventSubscriptionFilter

Designação Descrição Valor
avançadoFiltros Uma lista de filtros avançados. AdvancedFilter[]
incluídoTipos de Evento Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento.
Se desejar inscrever-se em todos os tipos de evento, a cadeia de caracteres "all" precisa ser especificada como um elemento nesta lista.
string[]
isSubjectCaseSensitive Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro
devem ser comparados de forma sensível a maiúsculas e minúsculas.
Bool
assuntoComeçaCom Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso.
O formato depende do editor dos eventos.
Não há suporte para caracteres curinga neste caminho.
string
assuntoTermina Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo de caminho de recurso.
Não há suporte para caracteres curinga neste caminho.
string

EventSubscriptionProperties

Designação Descrição Valor
deadLetterDestino O destino DeadLetter da assinatura do evento. DeadLetterDestination
destino Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento. EventSubscriptionDestination
eventDeliverySchema O esquema de entrega de eventos para a assinatura do evento. 'CloudEventV01Schema'
'CustomInputSchema'
'EventGridSchema'
expiraçãoTimeUtc Tempo de expiração da subscrição do evento. string
filtrar 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 o tempo de vida dos eventos. RetryPolicy

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

Designação 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

Microsoft.EventGrid/eventSubscriptions

Designação Descrição Valor
apiVersion A versão api '2018-09-15-pré-visualização'
Designação O nome do recurso string (obrigatório)
propriedades Propriedades da subscrição do evento EventSubscriptionProperties
tipo O tipo de recurso 'Microsoft.EventGrid/eventSubscriptions'

NumberGreaterThanAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberGreaterThan' (obrigatório)
valor O valor do filtro Int

NumberGreaterThanOrEqualsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberGreaterThanOrEquals' (obrigatório)
valor O valor do filtro Int

NumberInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberIn' (obrigatório)
valores O conjunto de valores de filtro int[]

NumberLessThanAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberLessThan' (obrigatório)
valor O valor do filtro Int

NumberLessThanOrEqualsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberLessThanOrEquals' (obrigatório)
valor O valor do filtro Int

NumberNotInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberNotIn' (obrigatório)
valores O conjunto de valores de filtro int[]

RetryPolicy

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

StorageBlobDeadLetterDestination

Designação Descrição Valor
endpointType Tipo de ponto de extremidade para o destino da letra morta 'StorageBlob' (obrigatório)
propriedades As propriedades do destino de deadletter baseado em Blob de Armazenamento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Designação 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

StorageQueueEventSubscriptionDestination

Designação Descrição Valor
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento 'StorageQueue' (obrigatório)
propriedades Propriedades da fila de armazenamento do destino da assinatura do evento StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Designação 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

StringBeginsWithAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringBeginsWith' (obrigatório)
valores O conjunto de valores de filtro string[]

StringContainsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringContains' (obrigatório)
valores O conjunto de valores de filtro string[]

StringEndsWithAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringEndsWith' (obrigatório)
valores O conjunto de valores de filtro string[]

StringInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringIn' (obrigatório)
valores O conjunto de valores de filtro string[]

StringNotInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringNotIn' (obrigatório)
valores O conjunto de valores de filtro string[]

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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

Modelos de início rápido

Os modelos de início rápido a seguir implantam esse tipo de recurso.

Modelo Descrição
Criar Tópico Personalizado da Grade de Eventos do Azure e de Assinatura de Fila

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de fila de barramento de serviço. Modelo originalmente de autoria de Markus Meyer.
Criar tópico personalizado da grade de eventos do Azure e de assinatura

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs.
Criar de Subscrição de Tópico Personalizado da Grelha de Eventos do Azure

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de tópico do barramento de serviço. Modelo originalmente de autoria de Markus Meyer.
Criar tópico personalizado da Grade de Eventos e manipulador de hub de eventos

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure e um hub de eventos para manipular os eventos.
Criar subscrição da Grelha de Eventos para eventos de recursos

Implantar no Azure
Cria a assinatura da Grade de Eventos para o grupo de recursos ou a assinatura do Azure.
Tópico/assinatura personalizada da grade de eventos do Azure com o CloudEvents

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure, uma assinatura de webhook com esquema CloudEvents e um Aplicativo Lógico como manipulador de eventos. Modelo originalmente criado por Justin Yoo.

Definição de recursos Terraform (provedor AzAPI)

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

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log 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@2018-09-15-preview"
  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
      }
      eventDeliverySchema = "string"
      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 EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para EventHub, use:

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

Para HybridConnection, use:

{
  endpointType = "HybridConnection"
  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"
  ]
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob , use:

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

Valores de propriedade

AdvancedFilter

Designação Descrição Valor
chave A chave de filtro. Representa uma propriedade de evento com até dois níveis de aninhamento. string
Tipo de operador Defina como 'BoolEquals' para o tipo BoolEqualsAdvancedFilter. Defina como 'NumberGreaterThan' para o tipo NumberGreaterThanAdvancedFilter. Defina como 'NumberGreaterThanOrEquals' para o tipo NumberGreaterThanOrEqualsAdvancedFilter. Defina como 'NumberIn' para o tipo NumberInAdvancedFilter. Defina como 'NumberLessThan' para o tipo NumberLessThanAdvancedFilter. Defina como 'NumberLessThanOrEquals' para o tipo NumberLessThanOrEqualsAdvancedFilter. Defina como 'NumberNotIn' para o tipo NumberNotInAdvancedFilter. Defina como 'StringBeginsWith' para o tipo StringBeginsWithAdvancedFilter. Defina como 'StringContains' para o tipo StringContainsAdvancedFilter. Defina como 'StringEndsWith' para o tipo StringEndsWithAdvancedFilter. Defina como 'StringIn' para o tipo StringInAdvancedFilter. Defina como 'StringNotIn' para o tipo StringNotInAdvancedFilter. 'BoolEquals'
'NúmeroMaiorQue'
'NúmeroMaiorThanOrEquals'
'NumberIn'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotIn' (obrigatório)

BoolEqualsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'BoolEquals' (obrigatório)
valor O valor do filtro Bool

DeadLetterDestination

Designação Descrição Valor
endpointType Defina como 'StorageBlob' para o tipo StorageBlobDeadLetterDestination. 'StorageBlob' (obrigatório)

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Designação Descrição Valor
resourceId A Id de Recursos do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. string

EventSubscriptionDestination

Designação Descrição Valor
endpointType Defina como 'EventHub' para o tipo EventHubEventSubscriptionDestination. Defina como 'HybridConnection' para o tipo HybridConnectionEventSubscriptionDestination. Defina como 'StorageQueue' para o tipo StorageQueueEventSubscriptionDestination. Defina como 'WebHook' para o tipo WebHookEventSubscriptionDestination. 'EventHub'
'HybridConnection'
'StorageQueue'
'WebHook' (obrigatório)

EventSubscriptionFilter

Designação Descrição Valor
avançadoFiltros Uma lista de filtros avançados. AdvancedFilter[]
incluídoTipos de Evento Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento.
Se desejar inscrever-se em todos os tipos de evento, a cadeia de caracteres "all" precisa ser especificada como um elemento nesta lista.
string[]
isSubjectCaseSensitive Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro
devem ser comparados de forma sensível a maiúsculas e minúsculas.
Bool
assuntoComeçaCom Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso.
O formato depende do editor dos eventos.
Não há suporte para caracteres curinga neste caminho.
string
assuntoTermina Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo de caminho de recurso.
Não há suporte para caracteres curinga neste caminho.
string

EventSubscriptionProperties

Designação Descrição Valor
deadLetterDestino O destino DeadLetter da assinatura do evento. DeadLetterDestination
destino Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento. EventSubscriptionDestination
eventDeliverySchema O esquema de entrega de eventos para a assinatura do evento. 'CloudEventV01Schema'
'CustomInputSchema'
'EventGridSchema'
expiraçãoTimeUtc Tempo de expiração da subscrição do evento. string
filtrar 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 o tempo de vida dos eventos. RetryPolicy

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

Designação 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

Microsoft.EventGrid/eventSubscriptions

Designação Descrição Valor
Designação O nome do recurso string (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. string (obrigatório)
propriedades Propriedades da subscrição do evento EventSubscriptionProperties
tipo O tipo de recurso "Microsoft.EventGrid/eventSubscriptions@2018-09-15-preview"

NumberGreaterThanAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberGreaterThan' (obrigatório)
valor O valor do filtro Int

NumberGreaterThanOrEqualsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberGreaterThanOrEquals' (obrigatório)
valor O valor do filtro Int

NumberInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberIn' (obrigatório)
valores O conjunto de valores de filtro int[]

NumberLessThanAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberLessThan' (obrigatório)
valor O valor do filtro Int

NumberLessThanOrEqualsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberLessThanOrEquals' (obrigatório)
valor O valor do filtro Int

NumberNotInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'NumberNotIn' (obrigatório)
valores O conjunto de valores de filtro int[]

RetryPolicy

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

StorageBlobDeadLetterDestination

Designação Descrição Valor
endpointType Tipo de ponto de extremidade para o destino da letra morta 'StorageBlob' (obrigatório)
propriedades As propriedades do destino de deadletter baseado em Blob de Armazenamento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Designação 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

StorageQueueEventSubscriptionDestination

Designação Descrição Valor
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento 'StorageQueue' (obrigatório)
propriedades Propriedades da fila de armazenamento do destino da assinatura do evento StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Designação 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

StringBeginsWithAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringBeginsWith' (obrigatório)
valores O conjunto de valores de filtro string[]

StringContainsAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringContains' (obrigatório)
valores O conjunto de valores de filtro string[]

StringEndsWithAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringEndsWith' (obrigatório)
valores O conjunto de valores de filtro string[]

StringInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringIn' (obrigatório)
valores O conjunto de valores de filtro string[]

StringNotInAdvancedFilter

Designação Descrição Valor
Tipo de operador Representa o operador do filtro 'StringNotIn' (obrigatório)
valores O conjunto de valores de filtro string[]

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

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