Compartilhar via


Microsoft.EventGrid systemTópicos/eventoAssinaturas

Definição de recurso do Bicep

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

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

Formato do recurso

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

resource symbolicname 'Microsoft.EventGrid/systemTopics/eventSubscriptions@2025-04-01-preview' = {
  parent: resourceSymbolicName
  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 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'
  ]
}

Objetos DeliveryAttributeMapping

Defina a propriedade tipo para especificar o tipo de objeto.

Para Dinâmico, use:

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

Para estática, use:

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

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 DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, use:

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

Valores de propriedade

Microsoft.EventGrid/systemTopics/eventSubscriptions

Name Description Value
name O nome do recurso string (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte o recurso filho fora do recurso pai.
Nome simbólico para o recurso do tipo: systemTopics
properties Propriedades da assinatura do evento. EventSubscriptionProperties

AdvancedFilter

Name Description Value
chave O campo/propriedade no evento com base no qual você deseja filtrar. cadeia
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 do ponto de extremidade para o destino da assinatura do evento. 'AzureFunction' (obrigatório)
properties Propriedades da Função do 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 preferencial em Kilobytes. int
resourceId A ID de Recurso do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento. cadeia

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 booliano. 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 em que 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 as mensagens mortas.
DeadLetterDestination
identidade A identidade a ser usada quando eventos de mensagens mortas. EventSubscriptionIdentity

DeliveryAttributeMapping

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

DeliveryWithResourceIdentity

Name Description Value
destino Informações sobre o destino em que 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 fornecer eventos. EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Name Description Value
properties Propriedades do mapeamento de atributo de entrega dinâmica. 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

EventHubEventSubscriptionDestination

Name Description Value
endpointType Tipo do 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 Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. cadeia

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 assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo. string[]
isSubjectCaseSensitive Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro
deve ser comparado de maneira sensível a maiúsculas de minúsculas.
bool
subjectBeginsWith Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso.
O formato disso depende do editor dos eventos.
Não há suporte para caracteres curinga neste caminho.
cadeia
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

EventSubscriptionIdentity

Name Description Value
federatedIdentityCredentialInfo Os detalhes da FIC (Federated Identity Credential) usada com a entrega de recursos. 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

EventSubscriptionProperties

Name Description Value
deadLetterDestination O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta 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/mensagens mortas.
DeadLetterDestination
deadLetterWithResourceIdentity O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta 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/mensagens mortas.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Informações sobre o destino em que 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/mensagens mortas.
DeliveryWithResourceIdentity
destino Informações sobre o destino em que 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/mensagens mortas.
EventSubscriptionDestination
eventDeliverySchema O esquema de entrega de eventos para a assinatura do evento. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Hora de expiração da assinatura do evento. cadeia
filtro Informações sobre o filtro da 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 tempo de vida útil para eventos. RetryPolicy

FederatedIdentityCredentialInfo

Name Description Value
federatedClientId O aplicativo de ID do Microsoft Entra multilocatário ao qual a FIC (Credencial de Identidade Federada) 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 do ponto de extremidade para o destino da assinatura do evento. 'HybridConnection' (obrigatório)
properties Propriedades de conexão híbrida 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

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 do 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 do ARM de Grupos de Ações que serão disparadas em cada alerta disparado por meio dessa assinatura de evento.
Cada ID do ARM de recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description A descrição que será anexada a todos os Alertas disparados por meio dessa assinatura de evento. cadeia
severity A severidade que será anexada a todos os alertas disparados por meio dessa assinatura de evento.
Esse campo deve ser fornecido.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'NamespaceTopic' (obrigatório)
properties Propriedades do Tópico do Namespace 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 do Namespace da Grade de Eventos de uma assinatura de evento.
Esse campo é necessário e o recurso Tópico do Namespace listado já deve existir.
A ID do ARM de recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
cadeia

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 do 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 Recurso do Azure que representa o ponto de extremidade de um destino de parceiro de uma assinatura de evento. cadeia

RetryPolicy

Name Description Value
eventTimeToLiveInMinutes Vida útil (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 do ponto de extremidade para o destino da assinatura do evento. 'ServiceBusQueue' (obrigatório)
properties Propriedades do Barramento de Serviço 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 Barramento de Serviço de uma assinatura de evento. cadeia

ServiceBusTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'ServiceBusTopic' (obrigatório)
properties Propriedades do Tópico do Barramento de Serviço 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 Barramento de Serviço de uma assinatura de evento. cadeia

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

Name Description Value
isSecret Sinalizador booliano para saber se o atributo contém informações confidenciais. bool
value Valor do atributo de entrega. cadeia

StorageBlobDeadLetterDestination

Name Description Value
endpointType Tipo do ponto de extremidade para o destino da letra morta 'StorageBlob' (obrigatório)
properties As propriedades do destino 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 de deadletter cadeia
resourceId A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos de deadletter cadeia

StorageQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo do 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 de usar -1 para indicar que a vida útil da mensagem é Infinita. int
queueName O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento. cadeia
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

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 do ponto de extremidade para o destino da assinatura do evento. 'WebHook' (obrigatório)
properties Propriedades do WebHook do destino da assinatura do evento. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri A ID do aplicativo ou URI da ID do Microsoft Entra para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia
azureActiveDirectoryTenantId A ID do locatário da ID do Microsoft Entra para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia
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 preferencial 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 do Bicep para implantar esse tipo de recurso.

Arquivo Bicep Description
Criar assinatura do Armazenamento de Blobs e da Grade de Eventos para o Blob Cria uma conta de Armazenamento de Blobs do Azure e cria uma assinatura da Grade de Eventos para esse Blob.
Implantar o banco de dados do Azure Data Explorer com a conexão da Grade de Eventos Implantar o banco de dados do Azure Data Explorer com a conexão da Grade de Eventos.

Definição de recurso de modelo do ARM

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

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

Formato do recurso

Para criar um recurso Microsoft.EventGrid/systemTopics/eventSubscriptions, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.EventGrid/systemTopics/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 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" ]
}

Objetos DeliveryAttributeMapping

Defina a propriedade tipo para especificar o tipo de objeto.

Para Dinâmico, use:

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

Para estática, use:

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

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 DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, use:

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

Valores de propriedade

Microsoft.EventGrid/systemTopics/eventSubscriptions

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

AdvancedFilter

Name Description Value
chave O campo/propriedade no evento com base no qual você deseja filtrar. cadeia
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 do ponto de extremidade para o destino da assinatura do evento. 'AzureFunction' (obrigatório)
properties Propriedades da Função do 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 preferencial em Kilobytes. int
resourceId A ID de Recurso do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento. cadeia

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 booliano. 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 em que 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 as mensagens mortas.
DeadLetterDestination
identidade A identidade a ser usada quando eventos de mensagens mortas. EventSubscriptionIdentity

DeliveryAttributeMapping

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

DeliveryWithResourceIdentity

Name Description Value
destino Informações sobre o destino em que 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 fornecer eventos. EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Name Description Value
properties Propriedades do mapeamento de atributo de entrega dinâmica. 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

EventHubEventSubscriptionDestination

Name Description Value
endpointType Tipo do 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 Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. cadeia

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 assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo. string[]
isSubjectCaseSensitive Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro
deve ser comparado de maneira sensível a maiúsculas de minúsculas.
bool
subjectBeginsWith Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso.
O formato disso depende do editor dos eventos.
Não há suporte para caracteres curinga neste caminho.
cadeia
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

EventSubscriptionIdentity

Name Description Value
federatedIdentityCredentialInfo Os detalhes da FIC (Federated Identity Credential) usada com a entrega de recursos. 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

EventSubscriptionProperties

Name Description Value
deadLetterDestination O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta 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/mensagens mortas.
DeadLetterDestination
deadLetterWithResourceIdentity O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta 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/mensagens mortas.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Informações sobre o destino em que 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/mensagens mortas.
DeliveryWithResourceIdentity
destino Informações sobre o destino em que 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/mensagens mortas.
EventSubscriptionDestination
eventDeliverySchema O esquema de entrega de eventos para a assinatura do evento. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Hora de expiração da assinatura do evento. cadeia
filtro Informações sobre o filtro da 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 tempo de vida útil para eventos. RetryPolicy

FederatedIdentityCredentialInfo

Name Description Value
federatedClientId O aplicativo de ID do Microsoft Entra multilocatário ao qual a FIC (Credencial de Identidade Federada) 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 do ponto de extremidade para o destino da assinatura do evento. 'HybridConnection' (obrigatório)
properties Propriedades de conexão híbrida 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

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 do 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 do ARM de Grupos de Ações que serão disparadas em cada alerta disparado por meio dessa assinatura de evento.
Cada ID do ARM de recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description A descrição que será anexada a todos os Alertas disparados por meio dessa assinatura de evento. cadeia
severity A severidade que será anexada a todos os alertas disparados por meio dessa assinatura de evento.
Esse campo deve ser fornecido.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'NamespaceTopic' (obrigatório)
properties Propriedades do Tópico do Namespace 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 do Namespace da Grade de Eventos de uma assinatura de evento.
Esse campo é necessário e o recurso Tópico do Namespace listado já deve existir.
A ID do ARM de recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
cadeia

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 do 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 Recurso do Azure que representa o ponto de extremidade de um destino de parceiro de uma assinatura de evento. cadeia

RetryPolicy

Name Description Value
eventTimeToLiveInMinutes Vida útil (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 do ponto de extremidade para o destino da assinatura do evento. 'ServiceBusQueue' (obrigatório)
properties Propriedades do Barramento de Serviço 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 Barramento de Serviço de uma assinatura de evento. cadeia

ServiceBusTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'ServiceBusTopic' (obrigatório)
properties Propriedades do Tópico do Barramento de Serviço 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 Barramento de Serviço de uma assinatura de evento. cadeia

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

Name Description Value
isSecret Sinalizador booliano para saber se o atributo contém informações confidenciais. bool
value Valor do atributo de entrega. cadeia

StorageBlobDeadLetterDestination

Name Description Value
endpointType Tipo do ponto de extremidade para o destino da letra morta 'StorageBlob' (obrigatório)
properties As propriedades do destino 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 de deadletter cadeia
resourceId A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos de deadletter cadeia

StorageQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo do 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 de usar -1 para indicar que a vida útil da mensagem é Infinita. int
queueName O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento. cadeia
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

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 do ponto de extremidade para o destino da assinatura do evento. 'WebHook' (obrigatório)
properties Propriedades do WebHook do destino da assinatura do evento. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri A ID do aplicativo ou URI da ID do Microsoft Entra para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia
azureActiveDirectoryTenantId A ID do locatário da ID do Microsoft Entra para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia
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 preferencial 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 assinatura do Armazenamento de Blobs e da Grade de Eventos para o Blob

Implantar no Azure
Cria uma conta de Armazenamento de Blobs do Azure e cria uma assinatura da Grade de Eventos para esse Blob.
Implantar o banco de dados do Azure Data Explorer com a conexão da Grade de Eventos

Implantar no Azure
Implantar o banco de dados do Azure Data Explorer com a conexão da Grade de Eventos.

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

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

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/systemTopics/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 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"
  ]
}

Objetos DeliveryAttributeMapping

Defina a propriedade tipo para especificar o tipo de objeto.

Para Dinâmico, use:

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

Para estática, use:

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

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 DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, use:

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

Valores de propriedade

Microsoft.EventGrid/systemTopics/eventSubscriptions

Name Description Value
name O nome do recurso string (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: systemTopics
properties Propriedades da assinatura do evento. EventSubscriptionProperties
tipo O tipo de recurso "Microsoft.EventGrid/systemTopics/eventSubscriptions@2025-04-01-preview"

AdvancedFilter

Name Description Value
chave O campo/propriedade no evento com base no qual você deseja filtrar. cadeia
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 do ponto de extremidade para o destino da assinatura do evento. 'AzureFunction' (obrigatório)
properties Propriedades da Função do 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 preferencial em Kilobytes. int
resourceId A ID de Recurso do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento. cadeia

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 booliano. 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 em que 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 as mensagens mortas.
DeadLetterDestination
identidade A identidade a ser usada quando eventos de mensagens mortas. EventSubscriptionIdentity

DeliveryAttributeMapping

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

DeliveryWithResourceIdentity

Name Description Value
destino Informações sobre o destino em que 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 fornecer eventos. EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Name Description Value
properties Propriedades do mapeamento de atributo de entrega dinâmica. 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

EventHubEventSubscriptionDestination

Name Description Value
endpointType Tipo do 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 Recurso do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento. cadeia

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 assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo. string[]
isSubjectCaseSensitive Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro
deve ser comparado de maneira sensível a maiúsculas de minúsculas.
bool
subjectBeginsWith Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso.
O formato disso depende do editor dos eventos.
Não há suporte para caracteres curinga neste caminho.
cadeia
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

EventSubscriptionIdentity

Name Description Value
federatedIdentityCredentialInfo Os detalhes da FIC (Federated Identity Credential) usada com a entrega de recursos. 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

EventSubscriptionProperties

Name Description Value
deadLetterDestination O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta 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/mensagens mortas.
DeadLetterDestination
deadLetterWithResourceIdentity O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta 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/mensagens mortas.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity Informações sobre o destino em que 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/mensagens mortas.
DeliveryWithResourceIdentity
destino Informações sobre o destino em que 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/mensagens mortas.
EventSubscriptionDestination
eventDeliverySchema O esquema de entrega de eventos para a assinatura do evento. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Hora de expiração da assinatura do evento. cadeia
filtro Informações sobre o filtro da 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 tempo de vida útil para eventos. RetryPolicy

FederatedIdentityCredentialInfo

Name Description Value
federatedClientId O aplicativo de ID do Microsoft Entra multilocatário ao qual a FIC (Credencial de Identidade Federada) 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 do ponto de extremidade para o destino da assinatura do evento. 'HybridConnection' (obrigatório)
properties Propriedades de conexão híbrida 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

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 do 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 do ARM de Grupos de Ações que serão disparadas em cada alerta disparado por meio dessa assinatura de evento.
Cada ID do ARM de recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description A descrição que será anexada a todos os Alertas disparados por meio dessa assinatura de evento. cadeia
severity A severidade que será anexada a todos os alertas disparados por meio dessa assinatura de evento.
Esse campo deve ser fornecido.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'NamespaceTopic' (obrigatório)
properties Propriedades do Tópico do Namespace 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 do Namespace da Grade de Eventos de uma assinatura de evento.
Esse campo é necessário e o recurso Tópico do Namespace listado já deve existir.
A ID do ARM de recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
cadeia

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 do 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 Recurso do Azure que representa o ponto de extremidade de um destino de parceiro de uma assinatura de evento. cadeia

RetryPolicy

Name Description Value
eventTimeToLiveInMinutes Vida útil (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 do ponto de extremidade para o destino da assinatura do evento. 'ServiceBusQueue' (obrigatório)
properties Propriedades do Barramento de Serviço 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 Barramento de Serviço de uma assinatura de evento. cadeia

ServiceBusTopicEventSubscriptionDestination

Name Description Value
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'ServiceBusTopic' (obrigatório)
properties Propriedades do Tópico do Barramento de Serviço 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 Barramento de Serviço de uma assinatura de evento. cadeia

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

Name Description Value
isSecret Sinalizador booliano para saber se o atributo contém informações confidenciais. bool
value Valor do atributo de entrega. cadeia

StorageBlobDeadLetterDestination

Name Description Value
endpointType Tipo do ponto de extremidade para o destino da letra morta 'StorageBlob' (obrigatório)
properties As propriedades do destino 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 de deadletter cadeia
resourceId A ID de Recurso do Azure da conta de armazenamento que é o destino dos eventos de deadletter cadeia

StorageQueueEventSubscriptionDestination

Name Description Value
endpointType Tipo do 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 de usar -1 para indicar que a vida útil da mensagem é Infinita. int
queueName O nome da fila de armazenamento em uma conta de armazenamento que é o destino de uma assinatura de evento. cadeia
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

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 do ponto de extremidade para o destino da assinatura do evento. 'WebHook' (obrigatório)
properties Propriedades do WebHook do destino da assinatura do evento. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri A ID do aplicativo ou URI da ID do Microsoft Entra para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia
azureActiveDirectoryTenantId A ID do locatário da ID do Microsoft Entra para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. cadeia
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 preferencial em Kilobytes. int

Exemplos de uso

Exemplos do Terraform

Um exemplo básico de implantação da Assinatura de Evento de Tópico do Sistema EventGrid.

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 = "westus"
}

locals {
  system_topic_name        = "${var.resource_name}-st"
  storage_account_name     = "${var.resource_name}sa01"
  queue_name               = "${var.resource_name}queue"
  event_subscription1_name = "${var.resource_name}-es1"
  event_subscription2_name = "${var.resource_name}-es2"
}

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

resource "azapi_resource" "systemTopic" {
  type      = "Microsoft.EventGrid/systemTopics@2022-06-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = local.system_topic_name
  # For resource group source, system topic location must be global
  location = "global"
  body = {
    properties = {
      source    = azapi_resource.resourceGroup.id
      topicType = "Microsoft.Resources.ResourceGroups"
    }
  }
}

resource "azapi_resource" "storageAccount" {
  type      = "Microsoft.Storage/storageAccounts@2023-05-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = local.storage_account_name
  location  = var.location
  body = {
    kind = "StorageV2"
    properties = {
      accessTier                   = "Hot"
      allowBlobPublicAccess        = true
      allowCrossTenantReplication  = false
      allowSharedKeyAccess         = true
      defaultToOAuthAuthentication = false
      dnsEndpointType              = "Standard"
      encryption = {
        keySource = "Microsoft.Storage"
        services = {
          queue = { keyType = "Service" }
          table = { keyType = "Service" }
        }
      }
      isHnsEnabled       = false
      isLocalUserEnabled = true
      isNfsV3Enabled     = false
      isSftpEnabled      = false
      minimumTlsVersion  = "TLS1_2"
      networkAcls = {
        bypass              = "AzureServices"
        defaultAction       = "Allow"
        ipRules             = []
        resourceAccessRules = []
        virtualNetworkRules = []
      }
      publicNetworkAccess      = "Enabled"
      supportsHttpsTrafficOnly = true
    }
    sku = { name = "Standard_LRS" }
  }
  tags = { environment = "staging" }
}

# Create a queue in the storage account for the event subscription destination
locals { queue_service_id = "${azapi_resource.storageAccount.id}/queueServices/default" }

resource "azapi_resource" "queue" {
  type       = "Microsoft.Storage/storageAccounts/queueServices/queues@2023-05-01"
  parent_id  = local.queue_service_id
  name       = local.queue_name
  body       = {}
  depends_on = [azapi_resource.storageAccount]
}

resource "azapi_resource" "eventSubscription" {
  type      = "Microsoft.EventGrid/systemTopics/eventSubscriptions@2022-06-15"
  parent_id = azapi_resource.systemTopic.id
  name      = local.event_subscription1_name
  body = {
    properties = {
      deadLetterDestination = null
      destination = {
        endpointType = "StorageQueue"
        properties = {
          queueName  = local.queue_name
          resourceId = azapi_resource.storageAccount.id
        }
      }
      eventDeliverySchema = "EventGridSchema"
      filter = {
        advancedFilters = [{
          key          = "subject"
          operatorType = "StringBeginsWith"
          values       = ["foo"]
        }]
      }
      labels = []
    }
  }
  depends_on = [azapi_resource.queue]
}

resource "azapi_resource" "eventSubscription_1" {
  type      = "Microsoft.EventGrid/systemTopics/eventSubscriptions@2022-06-15"
  parent_id = azapi_resource.systemTopic.id
  name      = local.event_subscription2_name
  body = {
    properties = {
      deadLetterDestination = null
      destination = {
        endpointType = "StorageQueue"
        properties = {
          queueName  = local.queue_name
          resourceId = azapi_resource.storageAccount.id
        }
      }
      eventDeliverySchema = "EventGridSchema"
      filter = {
        advancedFilters = [{
          key          = "subject"
          operatorType = "StringEndsWith"
          values       = ["bar"]
        }]
      }
      labels = []
    }
  }
  depends_on = [azapi_resource.queue]
}