Compartilhar via


Eventos Microsoft.EventGridSubscriptions

Definição de recurso do Bicep

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

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

Formato de recurso

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2024-12-15-preview' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    eventDeliverySchema: 'string'
    expirationTimeUtc: 'string'
    filter: {
      advancedFilters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see AdvancedFilter objects
        }
      ]
      enableAdvancedFilteringOnArrays: bool
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
    retryPolicy: {
      eventTimeToLiveInMinutes: int
      maxDeliveryAttempts: int
    }
  }
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, use:

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

Objetos DeliveryAttributeMapping

Defina a propriedade tipo para especificar o tipo de objeto.

Para Dinâmico, use:

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

Para estático, use:

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

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto.

Para boolEquals, use:

{
  operatorType: 'BoolEquals'
  value: bool
}

Para IsNotNull, use:

{
  operatorType: 'IsNotNull'
}

Para IsNullOrUndefined, use:

{
  operatorType: 'IsNullOrUndefined'
}

Para NumberGreaterThan, use:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

Para NumberGreaterThanOrEquals, use:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

Para NumberIn, use:

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

Para NumberInRange, use:

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

Para NumberLessThan, use:

{
  operatorType: 'NumberLessThan'
  value: int
}

Para NumberLessThanOrEquals, use:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

Para NumberNotIn, use:

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

Para NumberNotInRange, use:

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

Para StringBeginsWith, use:

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

Para StringContains, use:

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

Para StringEndsWith, use:

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

Para StringIn, use:

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

Para StringNotBeginsWith, use:

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

Para StringNotContains, use:

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

Para StringNotEndsWith, use:

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

Para StringNotIn, use:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para do AzureFunction, use:

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

Para do 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
  }
}

Valores de propriedade

AdvancedFilter

Nome Descrição Valor
chave O campo/propriedade no evento com base no qual você deseja filtrar. corda
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. Definir 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

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'AzureFunction' (obrigatório)
Propriedades Propriedades da Função do Azure do destino da assinatura do evento. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

BoolEqualsAdvancedFilter

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

DeadLetterDestination

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

DeadLetterWithResourceIdentity

Nome Descrição Valor
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

Nome Descrição Valor
nome Nome do atributo ou cabeçalho de entrega. corda
tipo Defina como 'Dinâmico' para o tipo DynamicDeliveryAttributeMapping . Defina como 'Estático' para o tipo StaticDeliveryAttributeMapping. 'Dinâmico'
'Estático' (obrigatório)

DeliveryWithResourceIdentity

Nome Descrição Valor
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

Nome Descrição Valor
Propriedades 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

Nome Descrição Valor
sourceField Caminho JSON no evento que contém o valor do atributo. corda

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

EventSubscriptionDestination

Nome Descrição Valor
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

Nome Descrição Valor
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.
corda
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.
corda

EventSubscriptionIdentity

Nome Descrição Valor
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. corda

EventSubscriptionProperties

Nome Descrição Valor
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. corda
filtro Informações sobre o filtro da assinatura do evento. EventSubscriptionFilter
Rótulos Lista de rótulos definidos pelo usuário. string[]
retryPolicy A política de repetição para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida útil para eventos. retryPolicy

FederatedIdentityCredentialInfo

Nome Descrição Valor
federatedClientId O aplicativo AAD multilocatário ao qual a FIC (Federated Identity Credential) está associada. corda

Restrições:
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

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

HybridConnectionEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

Microsoft.EventGrid/eventSubscriptions

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades da assinatura do evento. EventSubscriptionProperties
âmbito Use ao criar um recurso em um escopo diferente do escopo de implantação. Defina essa propriedade como o nome simbólico de um recurso para aplicar o recurso de extensão .

MonitorAlertEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'MonitorAlert' (obrigatório)
Propriedades Monitore as propriedades de alerta do destino da assinatura do evento. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Nome Descrição Valor
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[]
descrição A descrição que será anexada a todos os Alertas disparados por meio dessa assinatura de evento. corda
severidade 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

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'NamespaceTopic' (obrigatório)
Propriedades Propriedades do Tópico do Namespace do destino da assinatura do evento. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Nome Descrição Valor
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}.
corda

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'PartnerDestination' (obrigatório)
Propriedades Propriedades de destino do parceiro do destino da assinatura do evento. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

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

RetryPolicy

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

ServiceBusTopicEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'ServiceBusTopic' (obrigatório)
Propriedades Propriedades do Tópico do Barramento de Serviço do destino da assinatura do evento. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

StaticDeliveryAttributeMapping

Nome Descrição Valor
Propriedades 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

Nome Descrição Valor
isSecret Sinalizador booliano para saber se o atributo contém informações confidenciais. Bool
valor Valor do atributo de entrega. corda

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda
resourceId A ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento. corda

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter

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

StringNotInAdvancedFilter

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

Nome Descrição Valor
azureActiveDirectoryApplicationIdOrUri A ID ou o URI do Aplicativo do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. corda
azureActiveDirectoryTenantId A ID do Locatário do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. corda
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping []
endpointUrl A URL que representa o ponto de extremidade do destino de uma assinatura de evento. corda

Restrições:
Valor confidencial. 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 início rápido

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

Arquivo Bicep Descrição
criar o tópico personalizado da Grade de Eventos do Azure e a assinatura da fila Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de fila do barramento de serviço. Modelo originalmente criado por Markus Meyer.
Criar tópico personalizado e de assinatura da Grade de Eventos do Azure Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs.

Definição de recurso de modelo do ARM

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

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

Formato de recurso

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

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2024-12-15-preview",
  "name": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "deadLetterWithResourceIdentity": {
      "deadLetterDestination": {
        "endpointType": "string"
        // For remaining properties, see DeadLetterDestination objects
      },
      "identity": {
        "federatedIdentityCredentialInfo": {
          "federatedClientId": "string"
        },
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "deliveryWithResourceIdentity": {
      "destination": {
        "endpointType": "string"
        // For remaining properties, see EventSubscriptionDestination objects
      },
      "identity": {
        "federatedIdentityCredentialInfo": {
          "federatedClientId": "string"
        },
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "eventDeliverySchema": "string",
    "expirationTimeUtc": "string",
    "filter": {
      "advancedFilters": [ {
        "key": "string",
        "operatorType": "string"
        // For remaining properties, see AdvancedFilter objects
      } ],
      "enableAdvancedFilteringOnArrays": "bool",
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ],
    "retryPolicy": {
      "eventTimeToLiveInMinutes": "int",
      "maxDeliveryAttempts": "int"
    }
  }
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, use:

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

Objetos DeliveryAttributeMapping

Defina a propriedade tipo para especificar o tipo de objeto.

Para Dinâmico, use:

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

Para estático, use:

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

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto.

Para boolEquals, use:

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

Para IsNotNull, use:

{
  "operatorType": "IsNotNull"
}

Para IsNullOrUndefined, use:

{
  "operatorType": "IsNullOrUndefined"
}

Para NumberGreaterThan, use:

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

Para NumberGreaterThanOrEquals, use:

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

Para NumberIn, use:

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

Para NumberInRange, use:

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

Para NumberLessThan, use:

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

Para NumberLessThanOrEquals, use:

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

Para NumberNotIn, use:

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

Para NumberNotInRange, use:

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

Para StringBeginsWith, use:

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

Para StringContains, use:

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

Para StringEndsWith, use:

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

Para StringIn, use:

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

Para StringNotBeginsWith, use:

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

Para StringNotContains, use:

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

Para StringNotEndsWith, use:

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

Para StringNotIn, use:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para do AzureFunction, use:

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

Para do 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"
  }
}

Valores de propriedade

AdvancedFilter

Nome Descrição Valor
chave O campo/propriedade no evento com base no qual você deseja filtrar. corda
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. Definir 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

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'AzureFunction' (obrigatório)
Propriedades Propriedades da Função do Azure do destino da assinatura do evento. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

BoolEqualsAdvancedFilter

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

DeadLetterDestination

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

DeadLetterWithResourceIdentity

Nome Descrição Valor
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

Nome Descrição Valor
nome Nome do atributo ou cabeçalho de entrega. corda
tipo Defina como 'Dinâmico' para o tipo DynamicDeliveryAttributeMapping . Defina como 'Estático' para o tipo StaticDeliveryAttributeMapping. 'Dinâmico'
'Estático' (obrigatório)

DeliveryWithResourceIdentity

Nome Descrição Valor
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

Nome Descrição Valor
Propriedades 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

Nome Descrição Valor
sourceField Caminho JSON no evento que contém o valor do atributo. corda

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

EventSubscriptionDestination

Nome Descrição Valor
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

Nome Descrição Valor
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.
corda
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.
corda

EventSubscriptionIdentity

Nome Descrição Valor
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. corda

EventSubscriptionProperties

Nome Descrição Valor
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. corda
filtro Informações sobre o filtro da assinatura do evento. EventSubscriptionFilter
Rótulos Lista de rótulos definidos pelo usuário. string[]
retryPolicy A política de repetição para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida útil para eventos. retryPolicy

FederatedIdentityCredentialInfo

Nome Descrição Valor
federatedClientId O aplicativo AAD multilocatário ao qual a FIC (Federated Identity Credential) está associada. corda

Restrições:
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

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

HybridConnectionEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

Microsoft.EventGrid/eventSubscriptions

Nome Descrição Valor
apiVersion A versão da API '2024-12-15-preview'
nome O nome do recurso cadeia de caracteres (obrigatório)
Propriedades Propriedades da assinatura do evento. EventSubscriptionProperties
tipo O tipo de recurso 'Microsoft.EventGrid/eventSubscriptions'

MonitorAlertEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'MonitorAlert' (obrigatório)
Propriedades Monitore as propriedades de alerta do destino da assinatura do evento. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Nome Descrição Valor
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[]
descrição A descrição que será anexada a todos os Alertas disparados por meio dessa assinatura de evento. corda
severidade 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

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'NamespaceTopic' (obrigatório)
Propriedades Propriedades do Tópico do Namespace do destino da assinatura do evento. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Nome Descrição Valor
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}.
corda

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'PartnerDestination' (obrigatório)
Propriedades Propriedades de destino do parceiro do destino da assinatura do evento. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

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

RetryPolicy

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

ServiceBusTopicEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'ServiceBusTopic' (obrigatório)
Propriedades Propriedades do Tópico do Barramento de Serviço do destino da assinatura do evento. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

StaticDeliveryAttributeMapping

Nome Descrição Valor
Propriedades 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

Nome Descrição Valor
isSecret Sinalizador booliano para saber se o atributo contém informações confidenciais. Bool
valor Valor do atributo de entrega. corda

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda
resourceId A ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento. corda

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter

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

StringNotInAdvancedFilter

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

Nome Descrição Valor
azureActiveDirectoryApplicationIdOrUri A ID ou o URI do Aplicativo do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. corda
azureActiveDirectoryTenantId A ID do Locatário do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. corda
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping []
endpointUrl A URL que representa o ponto de extremidade do destino de uma assinatura de evento. corda

Restrições:
Valor confidencial. 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

Modelos de início rápido

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

Modelo Descrição
criar o tópico personalizado da Grade de Eventos do Azure e a assinatura da fila

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

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure e uma assinatura de webhook. Modelo originalmente criado por John Downs.
criar assinatura de tópico personalizado da Grade de Eventos do Azure

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

Implantar no Azure
Cria um tópico personalizado da Grade de Eventos do Azure e um hub de eventos para lidar com os eventos.
criar assinatura da Grade de Eventos para eventos de recurso

Implantar no Azure
Cria uma assinatura da Grade de Eventos para o grupo de recursos ou a assinatura do Azure.
tópico/assinatura personalizado da Grade de Eventos do Azure com o CloudEvents

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

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

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

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2024-12-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      deadLetterWithResourceIdentity = {
        deadLetterDestination = {
          endpointType = "string"
          // For remaining properties, see DeadLetterDestination objects
        }
        identity = {
          federatedIdentityCredentialInfo = {
            federatedClientId = "string"
          }
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      deliveryWithResourceIdentity = {
        destination = {
          endpointType = "string"
          // For remaining properties, see EventSubscriptionDestination objects
        }
        identity = {
          federatedIdentityCredentialInfo = {
            federatedClientId = "string"
          }
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      destination = {
        endpointType = "string"
        // For remaining properties, see EventSubscriptionDestination objects
      }
      eventDeliverySchema = "string"
      expirationTimeUtc = "string"
      filter = {
        advancedFilters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see AdvancedFilter objects
          }
        ]
        enableAdvancedFilteringOnArrays = bool
        includedEventTypes = [
          "string"
        ]
        isSubjectCaseSensitive = bool
        subjectBeginsWith = "string"
        subjectEndsWith = "string"
      }
      labels = [
        "string"
      ]
      retryPolicy = {
        eventTimeToLiveInMinutes = int
        maxDeliveryAttempts = int
      }
    }
  })
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, use:

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

Objetos DeliveryAttributeMapping

Defina a propriedade tipo para especificar o tipo de objeto.

Para Dinâmico, use:

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

Para estático, use:

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

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto.

Para boolEquals, use:

{
  operatorType = "BoolEquals"
  value = bool
}

Para IsNotNull, use:

{
  operatorType = "IsNotNull"
}

Para IsNullOrUndefined, use:

{
  operatorType = "IsNullOrUndefined"
}

Para NumberGreaterThan, use:

{
  operatorType = "NumberGreaterThan"
  value = int
}

Para NumberGreaterThanOrEquals, use:

{
  operatorType = "NumberGreaterThanOrEquals"
  value = int
}

Para NumberIn, use:

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

Para NumberInRange, use:

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

Para NumberLessThan, use:

{
  operatorType = "NumberLessThan"
  value = int
}

Para NumberLessThanOrEquals, use:

{
  operatorType = "NumberLessThanOrEquals"
  value = int
}

Para NumberNotIn, use:

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

Para NumberNotInRange, use:

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

Para StringBeginsWith, use:

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

Para StringContains, use:

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

Para StringEndsWith, use:

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

Para StringIn, use:

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

Para StringNotBeginsWith, use:

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

Para StringNotContains, use:

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

Para StringNotEndsWith, use:

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

Para StringNotIn, use:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para do AzureFunction, use:

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

Para do 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
  }
}

Valores de propriedade

AdvancedFilter

Nome Descrição Valor
chave O campo/propriedade no evento com base no qual você deseja filtrar. corda
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. Definir 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

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'AzureFunction' (obrigatório)
Propriedades Propriedades da Função do Azure do destino da assinatura do evento. AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

BoolEqualsAdvancedFilter

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

DeadLetterDestination

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

DeadLetterWithResourceIdentity

Nome Descrição Valor
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

Nome Descrição Valor
nome Nome do atributo ou cabeçalho de entrega. corda
tipo Defina como 'Dinâmico' para o tipo DynamicDeliveryAttributeMapping . Defina como 'Estático' para o tipo StaticDeliveryAttributeMapping. 'Dinâmico'
'Estático' (obrigatório)

DeliveryWithResourceIdentity

Nome Descrição Valor
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

Nome Descrição Valor
Propriedades 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

Nome Descrição Valor
sourceField Caminho JSON no evento que contém o valor do atributo. corda

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

EventSubscriptionDestination

Nome Descrição Valor
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

Nome Descrição Valor
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.
corda
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.
corda

EventSubscriptionIdentity

Nome Descrição Valor
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. corda

EventSubscriptionProperties

Nome Descrição Valor
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. corda
filtro Informações sobre o filtro da assinatura do evento. EventSubscriptionFilter
Rótulos Lista de rótulos definidos pelo usuário. string[]
retryPolicy A política de repetição para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida útil para eventos. retryPolicy

FederatedIdentityCredentialInfo

Nome Descrição Valor
federatedClientId O aplicativo AAD multilocatário ao qual a FIC (Federated Identity Credential) está associada. corda

Restrições:
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

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

HybridConnectionEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

Microsoft.EventGrid/eventSubscriptions

Nome Descrição Valor
nome O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso ao qual aplicar esse recurso de extensão. cadeia de caracteres (obrigatório)
Propriedades Propriedades da assinatura do evento. EventSubscriptionProperties
tipo O tipo de recurso "Microsoft.EventGrid/eventSubscriptions@2024-12-15-preview"

MonitorAlertEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'MonitorAlert' (obrigatório)
Propriedades Monitore as propriedades de alerta do destino da assinatura do evento. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Nome Descrição Valor
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[]
descrição A descrição que será anexada a todos os Alertas disparados por meio dessa assinatura de evento. corda
severidade 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

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'NamespaceTopic' (obrigatório)
Propriedades Propriedades do Tópico do Namespace do destino da assinatura do evento. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Nome Descrição Valor
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}.
corda

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'PartnerDestination' (obrigatório)
Propriedades Propriedades de destino do parceiro do destino da assinatura do evento. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

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

RetryPolicy

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

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

ServiceBusTopicEventSubscriptionDestination

Nome Descrição Valor
endpointType Tipo do ponto de extremidade para o destino da assinatura do evento. 'ServiceBusTopic' (obrigatório)
Propriedades Propriedades do Tópico do Barramento de Serviço do destino da assinatura do evento. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda

StaticDeliveryAttributeMapping

Nome Descrição Valor
Propriedades 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

Nome Descrição Valor
isSecret Sinalizador booliano para saber se o atributo contém informações confidenciais. Bool
valor Valor do atributo de entrega. corda

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

Nome Descrição Valor
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. corda
resourceId A ID de Recurso do Azure da conta de armazenamento que contém a fila que é o destino de uma assinatura de evento. corda

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter

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

StringNotInAdvancedFilter

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

Nome Descrição Valor
azureActiveDirectoryApplicationIdOrUri A ID ou o URI do Aplicativo do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. corda
azureActiveDirectoryTenantId A ID do Locatário do Azure Active Directory para obter o token de acesso que será incluído como o token de portador nas solicitações de entrega. corda
deliveryAttributeMappings Detalhes do atributo de entrega. DeliveryAttributeMapping []
endpointUrl A URL que representa o ponto de extremidade do destino de uma assinatura de evento. corda

Restrições:
Valor confidencial. 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