Partilhar via


Microsoft.EventGrid eventSubscriptions

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@2025-04-01-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    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
        }
      ]
      enableAdvancedFilteringOnArrays: bool
      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 AzureFunction, use:

{
  endpointType: 'AzureFunction'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }
}

Para o EventHub, use:

{
  endpointType: 'EventHub'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

Para HybridConnection, use:

{
  endpointType: 'HybridConnection'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

Para MonitorAlert, use:

{
  endpointType: 'MonitorAlert'
  properties: {
    actionGroups: [
      'string'
    ]
    description: 'string'
    severity: 'string'
  }
}

Para NamespaceTopic, use:

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

Para PartnerDestination, use:

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

Para ServiceBusQueue, use:

{
  endpointType: 'ServiceBusQueue'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

Para ServiceBusTopic, use:

{
  endpointType: 'ServiceBusTopic'
  properties: {
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId: 'string'
  }
}

Para StorageQueue, use:

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

Para WebHook, use:

{
  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl: 'string'
    maxEventsPerBatch: int
    minimumTlsVersionAllowed: 'string'
    preferredBatchSizeInKilobytes: int
  }
}

Objetos DeliveryAttributeMapping

Defina a propriedade type para especificar o tipo de objeto.

Para Dynamic, use:

{
  properties: {
    sourceField: 'string'
  }
  type: 'Dynamic'
}

Para estática, use:

{
  properties: {
    isSecret: bool
    value: 'string'
  }
  type: 'Static'
}

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto.

Para BoolEquals, use:

{
  operatorType: 'BoolEquals'
  value: bool
}

Para IsNotNull, use:

{
  operatorType: 'IsNotNull'
}

Para IsNullOrUndefined, use:

{
  operatorType: 'IsNullOrUndefined'
}

Para NumberGreaterThan, use:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

Para NumberGreaterThanOrEquals, use:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

Para NumberIn, use:

{
  operatorType: 'NumberIn'
  values: [
    int
  ]
}

Para NumberInRange, use:

{
  operatorType: 'NumberInRange'
  values: [
    [
      int
    ]
  ]
}

Para NumberLessThan, use:

{
  operatorType: 'NumberLessThan'
  value: int
}

Para NumberLessThanOrEquals, use:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

Para NumberNotIn, use:

{
  operatorType: 'NumberNotIn'
  values: [
    int
  ]
}

Para NumberNotInRange, use:

{
  operatorType: 'NumberNotInRange'
  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 StringNotBeginsWith, use:

{
  operatorType: 'StringNotBeginsWith'
  values: [
    'string'
  ]
}

Para StringNotContains, use:

{
  operatorType: 'StringNotContains'
  values: [
    'string'
  ]
}

Para StringNotEndsWith, use:

{
  operatorType: 'StringNotEndsWith'
  values: [
    'string'
  ]
}

Para StringNotIn, use:

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

Valores de propriedade

Microsoft.EventGrid/eventSubscriptions

Name Description Value
name O nome do recurso string (obrigatório)
properties Propriedades da subscrição do evento. EventSubscriptionProperties
âmbito 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 .

AdvancedFilter

Name Description Value
chave O campo/propriedade no evento com base no qual você deseja filtrar. cadeia (de caracteres)
operatorType Defina como 'BoolEquals' para o tipo BoolEqualsAdvancedFilter. Defina como 'IsNotNull' para o tipo IsNotNullAdvancedFilter. Defina como 'IsNullOrUndefined' para o tipo IsNullOrUndefinedAdvancedFilter. Defina como 'NumberGreaterThan' para o tipo NumberGreaterThanAdvancedFilter. Defina como 'NumberGreaterThanOrEquals' para o tipo NumberGreaterThanOrEqualsAdvancedFilter. Defina como 'NumberIn' para o tipo NumberInAdvancedFilter. Defina como 'NumberInRange' para o tipo NumberInRangeAdvancedFilter. Defina como 'NumberLessThan' para o tipo NumberLessThanAdvancedFilter. Defina como 'NumberLessThanOrEquals' para o tipo NumberLessThanOrEqualsAdvancedFilter. Defina como 'NumberNotIn' para o tipo NumberNotInAdvancedFilter. Defina como 'NumberNotInRange' para o tipo NumberNotInRangeAdvancedFilter. 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 'StringNotBeginsWith' para o tipo StringNotBeginsWithAdvancedFilter. Defina como 'StringNotContains' para o tipo StringNotContainsAdvancedFilter. Defina como 'StringNotEndsWith' para o tipo StringNotEndsWithAdvancedFilter. Defina como 'StringNotIn' para o tipo StringNotInAdvancedFilter. 'BoolEquals'
'IsNotNull'
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (obrigatório)

AzureFunctionEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'AzureFunction' (obrigatório)
properties Propriedades da Função Azure do destino da assinatura do evento. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
maxEventsPerBatch Número máximo de eventos por lote. int
preferredBatchSizeInKilobytes Tamanho de lote preferido em kilobytes. int
resourceId A Id de Recursos do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento. cadeia (de caracteres)

BoolEqualsAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'BoolEquals' (obrigatório)
value O valor do filtro booleano. bool

DeadLetterDestination

Name Description Value
endpointType Defina como 'StorageBlob' para o tipo StorageBlobDeadLetterDestination. 'StorageBlob' (obrigatório)

DeadLetterWithResourceIdentity

Name Description Value
deadLetterDestination Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante o dead-lettering.
DeadLetterDestination
identidade A identidade a ser usada quando eventos de letras mortas. EventSubscriptionIdentity

DeliveryAttributeMapping

Name Description Value
name Nome do atributo de entrega ou cabeçalho. cadeia (de caracteres)
tipo Defina como 'Dynamic' para o tipo DynamicDeliveryAttributeMapping. Defina como 'Static' para o tipo StaticDeliveryAttributeMapping. 'Dynamic'
'Estática' (obrigatório)

DeliveryWithResourceIdentity

Name Description Value
destino Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega.
EventSubscriptionDestination
identidade A identidade a ser usada ao entregar eventos. EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Name Description Value
properties Propriedades do mapeamento dinâmico de atributos de entrega. DynamicDeliveryAttributeMappingProperties
tipo Tipo do atributo de entrega ou nome do cabeçalho. 'Dinâmico' (obrigatório)

DynamicDeliveryAttributeMappingProperties

Name Description Value
sourceField Caminho JSON no evento que contém o valor do atributo. cadeia (de caracteres)

EventHubEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'EventHub' (obrigatório)
properties Propriedades do Hub de Eventos do destino da assinatura do evento. EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
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. cadeia (de caracteres)

EventSubscriptionDestination

Name Description Value
endpointType Defina como 'AzureFunction' para o tipo AzureFunctionEventSubscriptionDestination. Defina como 'EventHub' para o tipo EventHubEventSubscriptionDestination. Defina como 'HybridConnection' para o tipo HybridConnectionEventSubscriptionDestination. Defina como 'MonitorAlert' para o tipo MonitorAlertEventSubscriptionDestination. Defina como 'NamespaceTopic' para o tipo NamespaceTopicEventSubscriptionDestination. Defina como 'PartnerDestination' para o tipo PartnerEventSubscriptionDestination. Defina como 'ServiceBusQueue' para o tipo ServiceBusQueueEventSubscriptionDestination. Defina como 'ServiceBusTopic' para o tipo ServiceBusTopicEventSubscriptionDestination. Defina como 'StorageQueue' para o tipo StorageQueueEventSubscriptionDestination. Defina como 'WebHook' para o tipo WebHookEventSubscriptionDestination. 'AzureFunction'
'EventHub'
'HybridConnection'
'MonitorAlert'
'NamespaceTopic'
'PartnerDestination'
'ServiceBusQueue'
'ServiceBusTopic'
'StorageQueue'
'WebHook' (obrigatório)

EventSubscriptionFilter

Name Description Value
advancedFilters Uma matriz de filtros avançados que são usados para filtrar assinaturas de eventos. AdvancedFilter[]
enableAdvancedFilteringOnArrays Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular. bool
includedEventTypes Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar se inscrever em todos os tipos de evento padrão, defina IncludedEventTypes como null. 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
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 depende do editor dos eventos.
Não há suporte para caracteres curinga neste caminho.
cadeia (de caracteres)
subjectEndsWith 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.
cadeia (de caracteres)

EventSubscriptionIdentity

Name Description Value
federatedIdentityCredentialInfo Os detalhes da Credencial de Identidade Federada (FIC) usada com a entrega do recurso. FederatedIdentityCredentialInfo
tipo O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'. 'SystemAssigned'
'UserAssigned'
userAssignedIdentity A identidade do usuário associada ao recurso. cadeia (de caracteres)

EventSubscriptionProperties

Name Description Value
deadLetterDestination O destino letra morta da assinatura do evento. Qualquer evento que não possa ser entregue no seu destino é enviado para o destino letra morta.
Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
DeadLetterDestination
deadLetterWithResourceIdentity O destino letra morta da assinatura do evento. Qualquer evento que não possa ser entregue no seu destino é enviado para o destino letra morta.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
DeliveryWithResourceIdentity
destino Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
EventSubscriptionDestination
eventDeliverySchema O esquema de entrega de eventos para a assinatura do evento. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Tempo de expiração da subscrição do evento. cadeia (de caracteres)
filtro Informações sobre o filtro para a assinatura do evento. EventSubscriptionFilter
labels 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

FederatedIdentityCredentialInfo

Name Description Value
federatedClientId O Aplicativo de ID Multilocatário do Microsoft Entra ao qual a Credencial de Identidade Federada (FIC) está associada. string

Constraints:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (obrigatório)

HybridConnectionEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'HybridConnection' (obrigatório)
properties Conexão híbrida Propriedades do destino da assinatura do evento. HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
resourceId A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento. cadeia (de caracteres)

IsNotNullAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'IsNotNull' (obrigatório)

IsNullOrUndefinedAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'IsNullOrUndefined' (obrigatório)

MonitorAlertEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'MonitorAlert' (obrigatório)
properties Monitore as propriedades de alerta do destino da assinatura do evento. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Name Description Value
actionGroups A lista de IDs ARM de Grupos de Ação que serão acionados em cada Alerta disparado por meio dessa assinatura de evento.
Cada ID ARM de recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description A descrição que será anexada a cada Alerta disparado através desta subscrição de evento. cadeia (de caracteres)
severity A gravidade que será anexada a cada Alerta disparado por meio dessa assinatura de evento.
Este campo deve ser fornecido.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'NamespaceTopic' (obrigatório)
properties Namespace Propriedades do tópico do destino da assinatura do evento. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Name Description Value
resourceId A ID do recurso do Azure que representa o ponto de extremidade do destino do Tópico de Namespace da Grade de Eventos de uma assinatura de evento.
Este campo é obrigatório e o recurso Tópico de Espaço de Nomes listado já deve existir.
A ID ARM do recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
cadeia (de caracteres)

NumberGreaterThanAdvancedFilter

Name Description Value
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

Name Description Value
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

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberIn' (obrigatório)
values O conjunto de valores de filtro. int[]

NumberInRangeAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberInRange' (obrigatório)
values O conjunto de valores de filtro. int[][]

NumberLessThanAdvancedFilter

Name Description Value
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

Name Description Value
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

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberNotIn' (obrigatório)
values O conjunto de valores de filtro. int[]

NumberNotInRangeAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberNotInRange' (obrigatório)
values O conjunto de valores de filtro. int[][]

PartnerEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'PartnerDestination' (obrigatório)
properties Propriedades de destino do parceiro do destino da assinatura do evento. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Name Description Value
resourceId A Id de Recursos do Azure que representa o ponto de extremidade de um Destino de Parceiro de uma assinatura de evento. cadeia (de caracteres)

RetryPolicy

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

ServiceBusQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'ServiceBusQueue' (obrigatório)
properties Propriedades do Service Bus do destino da assinatura do evento. ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
resourceId A Id de Recurso do Azure que representa o ponto de extremidade do destino do Service Bus de uma assinatura de evento. cadeia (de caracteres)

ServiceBusTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'ServiceBusTopic' (obrigatório)
properties Tópico do Service Bus Propriedades do destino da assinatura do evento. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
resourceId A Id de Recurso do Azure que representa o ponto de extremidade do destino do Tópico do Service Bus de uma assinatura de evento. cadeia (de caracteres)

StaticDeliveryAttributeMapping

Name Description Value
properties Propriedades do mapeamento estático de atributos de entrega. StaticDeliveryAttributeMappingProperties
tipo Tipo do atributo de entrega ou nome do cabeçalho. 'Estática' (obrigatório)

StaticDeliveryAttributeMappingProperties

Name Description Value
isSecret Sinalizador booleano para saber se o atributo contém informações confidenciais. bool
value Valor do atributo delivery. cadeia (de caracteres)

StorageBlobDeadLetterDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da letra morta 'StorageBlob' (obrigatório)
properties As propriedades do destino de deadletter baseado em Blob de Armazenamento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Name Description Value
blobContainerName O nome do contêiner de blob de armazenamento que é o destino dos eventos deadletter cadeia (de caracteres)
resourceId A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos deadletter cadeia (de caracteres)

StorageQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'StorageQueue' (obrigatório)
properties Propriedades da fila de armazenamento do destino da assinatura do evento. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Name Description Value
queueMessageTimeToLiveInSeconds Tempo de vida da mensagem da fila de armazenamento em segundos. Esse valor não pode ser zero ou negativo, com exceção do uso de -1 para indicar que o Tempo de Vida da mensagem é Infinito. int
queueName O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento. cadeia (de caracteres)
resourceId A ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento. cadeia (de caracteres)

StringBeginsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringBeginsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringContainsAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringContains' (obrigatório)
values O conjunto de valores de filtro. string[]

StringEndsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringEndsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringInAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringIn' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotBeginsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotBeginsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotContainsAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotContains' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotEndsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotEndsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotInAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotIn' (obrigatório)
values O conjunto de valores de filtro. string[]

WebHookEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'WebHook' (obrigatório)
properties Propriedades WebHook do destino da assinatura do evento. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri A ID do Aplicativo do Microsoft Entra ID ou URI para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia (de caracteres)
azureActiveDirectoryTenantId O ID de Locatário do Microsoft Entra ID para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia (de caracteres)
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
endpointUrl A URL que representa o ponto de extremidade do destino de uma assinatura de evento. string

Constraints:
Valor sensível. Passe como um parâmetro seguro.
maxEventsPerBatch Número máximo de eventos por lote. int
minimumTlsVersionAllowed Versão mínima do TLS que deve ser suportada pelo ponto de extremidade do webhook '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Tamanho de lote preferido em kilobytes. int

Exemplos de uso

Exemplos de início rápido do Azure

Os seguintes modelos de início rápido do Azure contêm exemplos de Bicep para implantar esse tipo de recurso.

Arquivo Bicep Description
Criar Tópico Personalizado da Grade de Eventos do Azure e 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 e Subscrição da Grelha de Eventos do Azure 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": "2025-04-01-preview",
  "name": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "deadLetterWithResourceIdentity": {
      "deadLetterDestination": {
        "endpointType": "string"
        // For remaining properties, see DeadLetterDestination objects
      },
      "identity": {
        "federatedIdentityCredentialInfo": {
          "federatedClientId": "string"
        },
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "deliveryWithResourceIdentity": {
      "destination": {
        "endpointType": "string"
        // For remaining properties, see EventSubscriptionDestination objects
      },
      "identity": {
        "federatedIdentityCredentialInfo": {
          "federatedClientId": "string"
        },
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "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
      } ],
      "enableAdvancedFilteringOnArrays": "bool",
      "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 AzureFunction, use:

{
  "endpointType": "AzureFunction",
  "properties": {
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "maxEventsPerBatch": "int",
    "preferredBatchSizeInKilobytes": "int",
    "resourceId": "string"
  }
}

Para o EventHub, use:

{
  "endpointType": "EventHub",
  "properties": {
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "resourceId": "string"
  }
}

Para HybridConnection, use:

{
  "endpointType": "HybridConnection",
  "properties": {
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "resourceId": "string"
  }
}

Para MonitorAlert, use:

{
  "endpointType": "MonitorAlert",
  "properties": {
    "actionGroups": [ "string" ],
    "description": "string",
    "severity": "string"
  }
}

Para NamespaceTopic, use:

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

Para PartnerDestination, use:

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

Para ServiceBusQueue, use:

{
  "endpointType": "ServiceBusQueue",
  "properties": {
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "resourceId": "string"
  }
}

Para ServiceBusTopic, use:

{
  "endpointType": "ServiceBusTopic",
  "properties": {
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "resourceId": "string"
  }
}

Para StorageQueue, use:

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

Para WebHook, use:

{
  "endpointType": "WebHook",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string",
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "endpointUrl": "string",
    "maxEventsPerBatch": "int",
    "minimumTlsVersionAllowed": "string",
    "preferredBatchSizeInKilobytes": "int"
  }
}

Objetos DeliveryAttributeMapping

Defina a propriedade type para especificar o tipo de objeto.

Para Dynamic, use:

{
  "properties": {
    "sourceField": "string"
  },
  "type": "Dynamic"
}

Para estática, use:

{
  "properties": {
    "isSecret": "bool",
    "value": "string"
  },
  "type": "Static"
}

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto.

Para BoolEquals, use:

{
  "operatorType": "BoolEquals",
  "value": "bool"
}

Para IsNotNull, use:

{
  "operatorType": "IsNotNull"
}

Para IsNullOrUndefined, use:

{
  "operatorType": "IsNullOrUndefined"
}

Para NumberGreaterThan, use:

{
  "operatorType": "NumberGreaterThan",
  "value": "int"
}

Para NumberGreaterThanOrEquals, use:

{
  "operatorType": "NumberGreaterThanOrEquals",
  "value": "int"
}

Para NumberIn, use:

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

Para NumberInRange, use:

{
  "operatorType": "NumberInRange",
  "values": [
    [ "int" ]
  ]
}

Para NumberLessThan, use:

{
  "operatorType": "NumberLessThan",
  "value": "int"
}

Para NumberLessThanOrEquals, use:

{
  "operatorType": "NumberLessThanOrEquals",
  "value": "int"
}

Para NumberNotIn, use:

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

Para NumberNotInRange, use:

{
  "operatorType": "NumberNotInRange",
  "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 StringNotBeginsWith, use:

{
  "operatorType": "StringNotBeginsWith",
  "values": [ "string" ]
}

Para StringNotContains, use:

{
  "operatorType": "StringNotContains",
  "values": [ "string" ]
}

Para StringNotEndsWith, use:

{
  "operatorType": "StringNotEndsWith",
  "values": [ "string" ]
}

Para StringNotIn, use:

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

Valores de propriedade

Microsoft.EventGrid/eventSubscriptions

Name Description Value
apiVersion A versão api '2025-04-01-preview'
name O nome do recurso string (obrigatório)
properties Propriedades da subscrição do evento. EventSubscriptionProperties
tipo O tipo de recurso 'Microsoft.EventGrid/eventSubscriptions'

AdvancedFilter

Name Description Value
chave O campo/propriedade no evento com base no qual você deseja filtrar. cadeia (de caracteres)
operatorType Defina como 'BoolEquals' para o tipo BoolEqualsAdvancedFilter. Defina como 'IsNotNull' para o tipo IsNotNullAdvancedFilter. Defina como 'IsNullOrUndefined' para o tipo IsNullOrUndefinedAdvancedFilter. Defina como 'NumberGreaterThan' para o tipo NumberGreaterThanAdvancedFilter. Defina como 'NumberGreaterThanOrEquals' para o tipo NumberGreaterThanOrEqualsAdvancedFilter. Defina como 'NumberIn' para o tipo NumberInAdvancedFilter. Defina como 'NumberInRange' para o tipo NumberInRangeAdvancedFilter. Defina como 'NumberLessThan' para o tipo NumberLessThanAdvancedFilter. Defina como 'NumberLessThanOrEquals' para o tipo NumberLessThanOrEqualsAdvancedFilter. Defina como 'NumberNotIn' para o tipo NumberNotInAdvancedFilter. Defina como 'NumberNotInRange' para o tipo NumberNotInRangeAdvancedFilter. 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 'StringNotBeginsWith' para o tipo StringNotBeginsWithAdvancedFilter. Defina como 'StringNotContains' para o tipo StringNotContainsAdvancedFilter. Defina como 'StringNotEndsWith' para o tipo StringNotEndsWithAdvancedFilter. Defina como 'StringNotIn' para o tipo StringNotInAdvancedFilter. 'BoolEquals'
'IsNotNull'
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (obrigatório)

AzureFunctionEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'AzureFunction' (obrigatório)
properties Propriedades da Função Azure do destino da assinatura do evento. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
maxEventsPerBatch Número máximo de eventos por lote. int
preferredBatchSizeInKilobytes Tamanho de lote preferido em kilobytes. int
resourceId A Id de Recursos do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento. cadeia (de caracteres)

BoolEqualsAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'BoolEquals' (obrigatório)
value O valor do filtro booleano. bool

DeadLetterDestination

Name Description Value
endpointType Defina como 'StorageBlob' para o tipo StorageBlobDeadLetterDestination. 'StorageBlob' (obrigatório)

DeadLetterWithResourceIdentity

Name Description Value
deadLetterDestination Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante o dead-lettering.
DeadLetterDestination
identidade A identidade a ser usada quando eventos de letras mortas. EventSubscriptionIdentity

DeliveryAttributeMapping

Name Description Value
name Nome do atributo de entrega ou cabeçalho. cadeia (de caracteres)
tipo Defina como 'Dynamic' para o tipo DynamicDeliveryAttributeMapping. Defina como 'Static' para o tipo StaticDeliveryAttributeMapping. 'Dynamic'
'Estática' (obrigatório)

DeliveryWithResourceIdentity

Name Description Value
destino Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega.
EventSubscriptionDestination
identidade A identidade a ser usada ao entregar eventos. EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Name Description Value
properties Propriedades do mapeamento dinâmico de atributos de entrega. DynamicDeliveryAttributeMappingProperties
tipo Tipo do atributo de entrega ou nome do cabeçalho. 'Dinâmico' (obrigatório)

DynamicDeliveryAttributeMappingProperties

Name Description Value
sourceField Caminho JSON no evento que contém o valor do atributo. cadeia (de caracteres)

EventHubEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'EventHub' (obrigatório)
properties Propriedades do Hub de Eventos do destino da assinatura do evento. EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
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. cadeia (de caracteres)

EventSubscriptionDestination

Name Description Value
endpointType Defina como 'AzureFunction' para o tipo AzureFunctionEventSubscriptionDestination. Defina como 'EventHub' para o tipo EventHubEventSubscriptionDestination. Defina como 'HybridConnection' para o tipo HybridConnectionEventSubscriptionDestination. Defina como 'MonitorAlert' para o tipo MonitorAlertEventSubscriptionDestination. Defina como 'NamespaceTopic' para o tipo NamespaceTopicEventSubscriptionDestination. Defina como 'PartnerDestination' para o tipo PartnerEventSubscriptionDestination. Defina como 'ServiceBusQueue' para o tipo ServiceBusQueueEventSubscriptionDestination. Defina como 'ServiceBusTopic' para o tipo ServiceBusTopicEventSubscriptionDestination. Defina como 'StorageQueue' para o tipo StorageQueueEventSubscriptionDestination. Defina como 'WebHook' para o tipo WebHookEventSubscriptionDestination. 'AzureFunction'
'EventHub'
'HybridConnection'
'MonitorAlert'
'NamespaceTopic'
'PartnerDestination'
'ServiceBusQueue'
'ServiceBusTopic'
'StorageQueue'
'WebHook' (obrigatório)

EventSubscriptionFilter

Name Description Value
advancedFilters Uma matriz de filtros avançados que são usados para filtrar assinaturas de eventos. AdvancedFilter[]
enableAdvancedFilteringOnArrays Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular. bool
includedEventTypes Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar se inscrever em todos os tipos de evento padrão, defina IncludedEventTypes como null. 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
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 depende do editor dos eventos.
Não há suporte para caracteres curinga neste caminho.
cadeia (de caracteres)
subjectEndsWith 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.
cadeia (de caracteres)

EventSubscriptionIdentity

Name Description Value
federatedIdentityCredentialInfo Os detalhes da Credencial de Identidade Federada (FIC) usada com a entrega do recurso. FederatedIdentityCredentialInfo
tipo O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'. 'SystemAssigned'
'UserAssigned'
userAssignedIdentity A identidade do usuário associada ao recurso. cadeia (de caracteres)

EventSubscriptionProperties

Name Description Value
deadLetterDestination O destino letra morta da assinatura do evento. Qualquer evento que não possa ser entregue no seu destino é enviado para o destino letra morta.
Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
DeadLetterDestination
deadLetterWithResourceIdentity O destino letra morta da assinatura do evento. Qualquer evento que não possa ser entregue no seu destino é enviado para o destino letra morta.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
DeliveryWithResourceIdentity
destino Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
EventSubscriptionDestination
eventDeliverySchema O esquema de entrega de eventos para a assinatura do evento. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Tempo de expiração da subscrição do evento. cadeia (de caracteres)
filtro Informações sobre o filtro para a assinatura do evento. EventSubscriptionFilter
labels 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

FederatedIdentityCredentialInfo

Name Description Value
federatedClientId O Aplicativo de ID Multilocatário do Microsoft Entra ao qual a Credencial de Identidade Federada (FIC) está associada. string

Constraints:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (obrigatório)

HybridConnectionEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'HybridConnection' (obrigatório)
properties Conexão híbrida Propriedades do destino da assinatura do evento. HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
resourceId A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento. cadeia (de caracteres)

IsNotNullAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'IsNotNull' (obrigatório)

IsNullOrUndefinedAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'IsNullOrUndefined' (obrigatório)

MonitorAlertEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'MonitorAlert' (obrigatório)
properties Monitore as propriedades de alerta do destino da assinatura do evento. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Name Description Value
actionGroups A lista de IDs ARM de Grupos de Ação que serão acionados em cada Alerta disparado por meio dessa assinatura de evento.
Cada ID ARM de recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description A descrição que será anexada a cada Alerta disparado através desta subscrição de evento. cadeia (de caracteres)
severity A gravidade que será anexada a cada Alerta disparado por meio dessa assinatura de evento.
Este campo deve ser fornecido.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'NamespaceTopic' (obrigatório)
properties Namespace Propriedades do tópico do destino da assinatura do evento. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Name Description Value
resourceId A ID do recurso do Azure que representa o ponto de extremidade do destino do Tópico de Namespace da Grade de Eventos de uma assinatura de evento.
Este campo é obrigatório e o recurso Tópico de Espaço de Nomes listado já deve existir.
A ID ARM do recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
cadeia (de caracteres)

NumberGreaterThanAdvancedFilter

Name Description Value
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

Name Description Value
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

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberIn' (obrigatório)
values O conjunto de valores de filtro. int[]

NumberInRangeAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberInRange' (obrigatório)
values O conjunto de valores de filtro. int[][]

NumberLessThanAdvancedFilter

Name Description Value
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

Name Description Value
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

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberNotIn' (obrigatório)
values O conjunto de valores de filtro. int[]

NumberNotInRangeAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberNotInRange' (obrigatório)
values O conjunto de valores de filtro. int[][]

PartnerEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'PartnerDestination' (obrigatório)
properties Propriedades de destino do parceiro do destino da assinatura do evento. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Name Description Value
resourceId A Id de Recursos do Azure que representa o ponto de extremidade de um Destino de Parceiro de uma assinatura de evento. cadeia (de caracteres)

RetryPolicy

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

ServiceBusQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'ServiceBusQueue' (obrigatório)
properties Propriedades do Service Bus do destino da assinatura do evento. ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
resourceId A Id de Recurso do Azure que representa o ponto de extremidade do destino do Service Bus de uma assinatura de evento. cadeia (de caracteres)

ServiceBusTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'ServiceBusTopic' (obrigatório)
properties Tópico do Service Bus Propriedades do destino da assinatura do evento. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
resourceId A Id de Recurso do Azure que representa o ponto de extremidade do destino do Tópico do Service Bus de uma assinatura de evento. cadeia (de caracteres)

StaticDeliveryAttributeMapping

Name Description Value
properties Propriedades do mapeamento estático de atributos de entrega. StaticDeliveryAttributeMappingProperties
tipo Tipo do atributo de entrega ou nome do cabeçalho. 'Estática' (obrigatório)

StaticDeliveryAttributeMappingProperties

Name Description Value
isSecret Sinalizador booleano para saber se o atributo contém informações confidenciais. bool
value Valor do atributo delivery. cadeia (de caracteres)

StorageBlobDeadLetterDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da letra morta 'StorageBlob' (obrigatório)
properties As propriedades do destino de deadletter baseado em Blob de Armazenamento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Name Description Value
blobContainerName O nome do contêiner de blob de armazenamento que é o destino dos eventos deadletter cadeia (de caracteres)
resourceId A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos deadletter cadeia (de caracteres)

StorageQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'StorageQueue' (obrigatório)
properties Propriedades da fila de armazenamento do destino da assinatura do evento. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Name Description Value
queueMessageTimeToLiveInSeconds Tempo de vida da mensagem da fila de armazenamento em segundos. Esse valor não pode ser zero ou negativo, com exceção do uso de -1 para indicar que o Tempo de Vida da mensagem é Infinito. int
queueName O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento. cadeia (de caracteres)
resourceId A ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento. cadeia (de caracteres)

StringBeginsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringBeginsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringContainsAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringContains' (obrigatório)
values O conjunto de valores de filtro. string[]

StringEndsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringEndsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringInAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringIn' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotBeginsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotBeginsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotContainsAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotContains' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotEndsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotEndsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotInAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotIn' (obrigatório)
values O conjunto de valores de filtro. string[]

WebHookEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'WebHook' (obrigatório)
properties Propriedades WebHook do destino da assinatura do evento. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri A ID do Aplicativo do Microsoft Entra ID ou URI para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia (de caracteres)
azureActiveDirectoryTenantId O ID de Locatário do Microsoft Entra ID para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia (de caracteres)
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
endpointUrl A URL que representa o ponto de extremidade do destino de uma assinatura de evento. string

Constraints:
Valor sensível. Passe como um parâmetro seguro.
maxEventsPerBatch Número máximo de eventos por lote. int
minimumTlsVersionAllowed Versão mínima do TLS que deve ser suportada pelo ponto de extremidade do webhook '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Tamanho de lote preferido em kilobytes. int

Exemplos de uso

Modelos de início rápido do Azure

Os seguintes modelos de início rápido do Azure implantam esse tipo de recurso.

Template Description
Criar Tópico Personalizado da Grade de Eventos do Azure e 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 e Subscrição da Grelha de Eventos do Azure

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 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@2025-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      deadLetterWithResourceIdentity = {
        deadLetterDestination = {
          endpointType = "string"
          // For remaining properties, see DeadLetterDestination objects
        }
        identity = {
          federatedIdentityCredentialInfo = {
            federatedClientId = "string"
          }
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      deliveryWithResourceIdentity = {
        destination = {
          endpointType = "string"
          // For remaining properties, see EventSubscriptionDestination objects
        }
        identity = {
          federatedIdentityCredentialInfo = {
            federatedClientId = "string"
          }
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      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
          }
        ]
        enableAdvancedFilteringOnArrays = bool
        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 AzureFunction, use:

{
  endpointType = "AzureFunction"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    maxEventsPerBatch = int
    preferredBatchSizeInKilobytes = int
    resourceId = "string"
  }
}

Para o EventHub, use:

{
  endpointType = "EventHub"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }
}

Para HybridConnection, use:

{
  endpointType = "HybridConnection"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }
}

Para MonitorAlert, use:

{
  endpointType = "MonitorAlert"
  properties = {
    actionGroups = [
      "string"
    ]
    description = "string"
    severity = "string"
  }
}

Para NamespaceTopic, use:

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

Para PartnerDestination, use:

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

Para ServiceBusQueue, use:

{
  endpointType = "ServiceBusQueue"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }
}

Para ServiceBusTopic, use:

{
  endpointType = "ServiceBusTopic"
  properties = {
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    resourceId = "string"
  }
}

Para StorageQueue, use:

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

Para WebHook, use:

{
  endpointType = "WebHook"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl = "string"
    maxEventsPerBatch = int
    minimumTlsVersionAllowed = "string"
    preferredBatchSizeInKilobytes = int
  }
}

Objetos DeliveryAttributeMapping

Defina a propriedade type para especificar o tipo de objeto.

Para Dynamic, use:

{
  properties = {
    sourceField = "string"
  }
  type = "Dynamic"
}

Para estática, use:

{
  properties = {
    isSecret = bool
    value = "string"
  }
  type = "Static"
}

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto.

Para BoolEquals, use:

{
  operatorType = "BoolEquals"
  value = bool
}

Para IsNotNull, use:

{
  operatorType = "IsNotNull"
}

Para IsNullOrUndefined, use:

{
  operatorType = "IsNullOrUndefined"
}

Para NumberGreaterThan, use:

{
  operatorType = "NumberGreaterThan"
  value = int
}

Para NumberGreaterThanOrEquals, use:

{
  operatorType = "NumberGreaterThanOrEquals"
  value = int
}

Para NumberIn, use:

{
  operatorType = "NumberIn"
  values = [
    int
  ]
}

Para NumberInRange, use:

{
  operatorType = "NumberInRange"
  values = [
    [
      int
    ]
  ]
}

Para NumberLessThan, use:

{
  operatorType = "NumberLessThan"
  value = int
}

Para NumberLessThanOrEquals, use:

{
  operatorType = "NumberLessThanOrEquals"
  value = int
}

Para NumberNotIn, use:

{
  operatorType = "NumberNotIn"
  values = [
    int
  ]
}

Para NumberNotInRange, use:

{
  operatorType = "NumberNotInRange"
  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 StringNotBeginsWith, use:

{
  operatorType = "StringNotBeginsWith"
  values = [
    "string"
  ]
}

Para StringNotContains, use:

{
  operatorType = "StringNotContains"
  values = [
    "string"
  ]
}

Para StringNotEndsWith, use:

{
  operatorType = "StringNotEndsWith"
  values = [
    "string"
  ]
}

Para StringNotIn, use:

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

Valores de propriedade

Microsoft.EventGrid/eventSubscriptions

Name Description Value
name O nome do recurso string (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. string (obrigatório)
properties Propriedades da subscrição do evento. EventSubscriptionProperties
tipo O tipo de recurso "Microsoft.EventGrid/eventSubscriptions@2025-04-01-preview"

AdvancedFilter

Name Description Value
chave O campo/propriedade no evento com base no qual você deseja filtrar. cadeia (de caracteres)
operatorType Defina como 'BoolEquals' para o tipo BoolEqualsAdvancedFilter. Defina como 'IsNotNull' para o tipo IsNotNullAdvancedFilter. Defina como 'IsNullOrUndefined' para o tipo IsNullOrUndefinedAdvancedFilter. Defina como 'NumberGreaterThan' para o tipo NumberGreaterThanAdvancedFilter. Defina como 'NumberGreaterThanOrEquals' para o tipo NumberGreaterThanOrEqualsAdvancedFilter. Defina como 'NumberIn' para o tipo NumberInAdvancedFilter. Defina como 'NumberInRange' para o tipo NumberInRangeAdvancedFilter. Defina como 'NumberLessThan' para o tipo NumberLessThanAdvancedFilter. Defina como 'NumberLessThanOrEquals' para o tipo NumberLessThanOrEqualsAdvancedFilter. Defina como 'NumberNotIn' para o tipo NumberNotInAdvancedFilter. Defina como 'NumberNotInRange' para o tipo NumberNotInRangeAdvancedFilter. 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 'StringNotBeginsWith' para o tipo StringNotBeginsWithAdvancedFilter. Defina como 'StringNotContains' para o tipo StringNotContainsAdvancedFilter. Defina como 'StringNotEndsWith' para o tipo StringNotEndsWithAdvancedFilter. Defina como 'StringNotIn' para o tipo StringNotInAdvancedFilter. 'BoolEquals'
'IsNotNull'
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (obrigatório)

AzureFunctionEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'AzureFunction' (obrigatório)
properties Propriedades da Função Azure do destino da assinatura do evento. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
maxEventsPerBatch Número máximo de eventos por lote. int
preferredBatchSizeInKilobytes Tamanho de lote preferido em kilobytes. int
resourceId A Id de Recursos do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento. cadeia (de caracteres)

BoolEqualsAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'BoolEquals' (obrigatório)
value O valor do filtro booleano. bool

DeadLetterDestination

Name Description Value
endpointType Defina como 'StorageBlob' para o tipo StorageBlobDeadLetterDestination. 'StorageBlob' (obrigatório)

DeadLetterWithResourceIdentity

Name Description Value
deadLetterDestination Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante o dead-lettering.
DeadLetterDestination
identidade A identidade a ser usada quando eventos de letras mortas. EventSubscriptionIdentity

DeliveryAttributeMapping

Name Description Value
name Nome do atributo de entrega ou cabeçalho. cadeia (de caracteres)
tipo Defina como 'Dynamic' para o tipo DynamicDeliveryAttributeMapping. Defina como 'Static' para o tipo StaticDeliveryAttributeMapping. 'Dynamic'
'Estática' (obrigatório)

DeliveryWithResourceIdentity

Name Description Value
destino Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega.
EventSubscriptionDestination
identidade A identidade a ser usada ao entregar eventos. EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Name Description Value
properties Propriedades do mapeamento dinâmico de atributos de entrega. DynamicDeliveryAttributeMappingProperties
tipo Tipo do atributo de entrega ou nome do cabeçalho. 'Dinâmico' (obrigatório)

DynamicDeliveryAttributeMappingProperties

Name Description Value
sourceField Caminho JSON no evento que contém o valor do atributo. cadeia (de caracteres)

EventHubEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'EventHub' (obrigatório)
properties Propriedades do Hub de Eventos do destino da assinatura do evento. EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
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. cadeia (de caracteres)

EventSubscriptionDestination

Name Description Value
endpointType Defina como 'AzureFunction' para o tipo AzureFunctionEventSubscriptionDestination. Defina como 'EventHub' para o tipo EventHubEventSubscriptionDestination. Defina como 'HybridConnection' para o tipo HybridConnectionEventSubscriptionDestination. Defina como 'MonitorAlert' para o tipo MonitorAlertEventSubscriptionDestination. Defina como 'NamespaceTopic' para o tipo NamespaceTopicEventSubscriptionDestination. Defina como 'PartnerDestination' para o tipo PartnerEventSubscriptionDestination. Defina como 'ServiceBusQueue' para o tipo ServiceBusQueueEventSubscriptionDestination. Defina como 'ServiceBusTopic' para o tipo ServiceBusTopicEventSubscriptionDestination. Defina como 'StorageQueue' para o tipo StorageQueueEventSubscriptionDestination. Defina como 'WebHook' para o tipo WebHookEventSubscriptionDestination. 'AzureFunction'
'EventHub'
'HybridConnection'
'MonitorAlert'
'NamespaceTopic'
'PartnerDestination'
'ServiceBusQueue'
'ServiceBusTopic'
'StorageQueue'
'WebHook' (obrigatório)

EventSubscriptionFilter

Name Description Value
advancedFilters Uma matriz de filtros avançados que são usados para filtrar assinaturas de eventos. AdvancedFilter[]
enableAdvancedFilteringOnArrays Permite que filtros avançados sejam avaliados em relação a uma matriz de valores em vez de esperar um valor singular. bool
includedEventTypes Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar se inscrever em todos os tipos de evento padrão, defina IncludedEventTypes como null. 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
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 depende do editor dos eventos.
Não há suporte para caracteres curinga neste caminho.
cadeia (de caracteres)
subjectEndsWith 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.
cadeia (de caracteres)

EventSubscriptionIdentity

Name Description Value
federatedIdentityCredentialInfo Os detalhes da Credencial de Identidade Federada (FIC) usada com a entrega do recurso. FederatedIdentityCredentialInfo
tipo O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'. 'SystemAssigned'
'UserAssigned'
userAssignedIdentity A identidade do usuário associada ao recurso. cadeia (de caracteres)

EventSubscriptionProperties

Name Description Value
deadLetterDestination O destino letra morta da assinatura do evento. Qualquer evento que não possa ser entregue no seu destino é enviado para o destino letra morta.
Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
DeadLetterDestination
deadLetterWithResourceIdentity O destino letra morta da assinatura do evento. Qualquer evento que não possa ser entregue no seu destino é enviado para o destino letra morta.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
DeliveryWithResourceIdentity
destino Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento.
Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.
EventSubscriptionDestination
eventDeliverySchema O esquema de entrega de eventos para a assinatura do evento. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Tempo de expiração da subscrição do evento. cadeia (de caracteres)
filtro Informações sobre o filtro para a assinatura do evento. EventSubscriptionFilter
labels 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

FederatedIdentityCredentialInfo

Name Description Value
federatedClientId O Aplicativo de ID Multilocatário do Microsoft Entra ao qual a Credencial de Identidade Federada (FIC) está associada. string

Constraints:
Comprimento mínimo = 36
Comprimento máximo = 36
Padrão = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$ (obrigatório)

HybridConnectionEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'HybridConnection' (obrigatório)
properties Conexão híbrida Propriedades do destino da assinatura do evento. HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
resourceId A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento. cadeia (de caracteres)

IsNotNullAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'IsNotNull' (obrigatório)

IsNullOrUndefinedAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'IsNullOrUndefined' (obrigatório)

MonitorAlertEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'MonitorAlert' (obrigatório)
properties Monitore as propriedades de alerta do destino da assinatura do evento. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Name Description Value
actionGroups A lista de IDs ARM de Grupos de Ação que serão acionados em cada Alerta disparado por meio dessa assinatura de evento.
Cada ID ARM de recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description A descrição que será anexada a cada Alerta disparado através desta subscrição de evento. cadeia (de caracteres)
severity A gravidade que será anexada a cada Alerta disparado por meio dessa assinatura de evento.
Este campo deve ser fornecido.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'NamespaceTopic' (obrigatório)
properties Namespace Propriedades do tópico do destino da assinatura do evento. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Name Description Value
resourceId A ID do recurso do Azure que representa o ponto de extremidade do destino do Tópico de Namespace da Grade de Eventos de uma assinatura de evento.
Este campo é obrigatório e o recurso Tópico de Espaço de Nomes listado já deve existir.
A ID ARM do recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
cadeia (de caracteres)

NumberGreaterThanAdvancedFilter

Name Description Value
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

Name Description Value
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

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberIn' (obrigatório)
values O conjunto de valores de filtro. int[]

NumberInRangeAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberInRange' (obrigatório)
values O conjunto de valores de filtro. int[][]

NumberLessThanAdvancedFilter

Name Description Value
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

Name Description Value
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

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberNotIn' (obrigatório)
values O conjunto de valores de filtro. int[]

NumberNotInRangeAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'NumberNotInRange' (obrigatório)
values O conjunto de valores de filtro. int[][]

PartnerEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'PartnerDestination' (obrigatório)
properties Propriedades de destino do parceiro do destino da assinatura do evento. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Name Description Value
resourceId A Id de Recursos do Azure que representa o ponto de extremidade de um Destino de Parceiro de uma assinatura de evento. cadeia (de caracteres)

RetryPolicy

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

ServiceBusQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'ServiceBusQueue' (obrigatório)
properties Propriedades do Service Bus do destino da assinatura do evento. ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
resourceId A Id de Recurso do Azure que representa o ponto de extremidade do destino do Service Bus de uma assinatura de evento. cadeia (de caracteres)

ServiceBusTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'ServiceBusTopic' (obrigatório)
properties Tópico do Service Bus Propriedades do destino da assinatura do evento. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Name Description Value
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
resourceId A Id de Recurso do Azure que representa o ponto de extremidade do destino do Tópico do Service Bus de uma assinatura de evento. cadeia (de caracteres)

StaticDeliveryAttributeMapping

Name Description Value
properties Propriedades do mapeamento estático de atributos de entrega. StaticDeliveryAttributeMappingProperties
tipo Tipo do atributo de entrega ou nome do cabeçalho. 'Estática' (obrigatório)

StaticDeliveryAttributeMappingProperties

Name Description Value
isSecret Sinalizador booleano para saber se o atributo contém informações confidenciais. bool
value Valor do atributo delivery. cadeia (de caracteres)

StorageBlobDeadLetterDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da letra morta 'StorageBlob' (obrigatório)
properties As propriedades do destino de deadletter baseado em Blob de Armazenamento StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Name Description Value
blobContainerName O nome do contêiner de blob de armazenamento que é o destino dos eventos deadletter cadeia (de caracteres)
resourceId A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos deadletter cadeia (de caracteres)

StorageQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'StorageQueue' (obrigatório)
properties Propriedades da fila de armazenamento do destino da assinatura do evento. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Name Description Value
queueMessageTimeToLiveInSeconds Tempo de vida da mensagem da fila de armazenamento em segundos. Esse valor não pode ser zero ou negativo, com exceção do uso de -1 para indicar que o Tempo de Vida da mensagem é Infinito. int
queueName O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento. cadeia (de caracteres)
resourceId A ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento. cadeia (de caracteres)

StringBeginsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringBeginsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringContainsAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringContains' (obrigatório)
values O conjunto de valores de filtro. string[]

StringEndsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringEndsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringInAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringIn' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotBeginsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotBeginsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotContainsAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotContains' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotEndsWithAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotEndsWith' (obrigatório)
values O conjunto de valores de filtro. string[]

StringNotInAdvancedFilter

Name Description Value
operatorType O tipo de operador usado para filtragem, por exemplo, NumberIn, StringContains, BoolEquals e outros. 'StringNotIn' (obrigatório)
values O conjunto de valores de filtro. string[]

WebHookEventSubscriptionDestination

Name Description Value
endpointType Tipo de ponto de extremidade para o destino da assinatura do evento. 'WebHook' (obrigatório)
properties Propriedades WebHook do destino da assinatura do evento. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri A ID do Aplicativo do Microsoft Entra ID ou URI para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia (de caracteres)
azureActiveDirectoryTenantId O ID de Locatário do Microsoft Entra ID para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia (de caracteres)
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping[]
endpointUrl A URL que representa o ponto de extremidade do destino de uma assinatura de evento. string

Constraints:
Valor sensível. Passe como um parâmetro seguro.
maxEventsPerBatch Número máximo de eventos por lote. int
minimumTlsVersionAllowed Versão mínima do TLS que deve ser suportada pelo ponto de extremidade do webhook '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Tamanho de lote preferido em kilobytes. int

Exemplos de uso

Amostras Terraform

Um exemplo básico de implantação da EventGrid Event Subscription.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "namespace" {
  type      = "Microsoft.EventHub/namespaces@2022-01-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      disableLocalAuth     = false
      isAutoInflateEnabled = false
      publicNetworkAccess  = "Enabled"
      zoneRedundant        = false
    }
    sku = {
      capacity = 1
      name     = "Standard"
      tier     = "Standard"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2021-09-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
      accessTier                   = "Hot"
      allowBlobPublicAccess        = true
      allowCrossTenantReplication  = true
      allowSharedKeyAccess         = true
      defaultToOAuthAuthentication = false
      encryption = {
        keySource = "Microsoft.Storage"
        services = {
          queue = {
            keyType = "Service"
          }
          table = {
            keyType = "Service"
          }
        }
      }
      isHnsEnabled      = false
      isNfsV3Enabled    = false
      isSftpEnabled     = false
      minimumTlsVersion = "TLS1_2"
      networkAcls = {
        defaultAction = "Allow"
      }
      publicNetworkAccess      = "Enabled"
      supportsHttpsTrafficOnly = true
    }
    sku = {
      name = "Standard_LRS"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "eventhub" {
  type      = "Microsoft.EventHub/namespaces/eventhubs@2021-11-01"
  parent_id = azapi_resource.namespace.id
  name      = var.resource_name
  body = {
    properties = {
      messageRetentionInDays = 1
      partitionCount         = 1
      status                 = "Active"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "eventSubscription" {
  type      = "Microsoft.EventGrid/eventSubscriptions@2021-12-01"
  parent_id = azapi_resource.storageAccount.id
  name      = var.resource_name
  body = {
    properties = {
      deadLetterDestination = null
      destination = {
        endpointType = "EventHub"
        properties = {
          deliveryAttributeMappings = null
          resourceId                = azapi_resource.eventhub.id
        }
      }
      eventDeliverySchema = "EventGridSchema"
      filter = {
        includedEventTypes = [
          "Microsoft.Storage.BlobCreated",
          "Microsoft.Storage.BlobRenamed",
        ]
      }
      labels = [
      ]
      retryPolicy = {
        eventTimeToLiveInMinutes = 144
        maxDeliveryAttempts      = 10
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}