Namespaces/tópicos/eventSubscriptions 2023-12-15-preview do Microsoft.EventGrid

Definição de recurso do Bicep

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

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

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

Formato de recurso

Para criar um recurso Microsoft.EventGrid/namespaces/topics/eventSubscriptions, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    deliveryConfiguration: {
      deliveryMode: 'string'
      push: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        deliveryWithResourceIdentity: {
          destination: {
            endpointType: 'string'
            // For remaining properties, see EventSubscriptionDestination objects
          }
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
      }
      queue: {
        deadLetterDestinationWithResourceIdentity: {
          deadLetterDestination: {
            endpointType: 'string'
            // For remaining properties, see DeadLetterDestination objects
          }
          identity: {
            type: 'string'
            userAssignedIdentity: 'string'
          }
        }
        eventTimeToLive: 'string'
        maxDeliveryCount: int
        receiveLockDurationInSeconds: int
      }
    }
    eventDeliverySchema: 'CloudEventSchemaV1_0'
    filtersConfiguration: {
      filters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see Filter objects
        }
      ]
      includedEventTypes: [
        'string'
      ]
    }
  }
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, use:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para AzureFunction, use:

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

Para o EventHub, use:

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

Para HybridConnection, use:

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

Para MonitorAlert, use:

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

Para NamespaceTopic, use:

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

Para PartnerDestination, use:

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

Para ServiceBusQueue, use:

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

Para ServiceBusTopic, use:

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

Para StorageQueue, use:

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

Para WebHook, use:

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

Objetos DeliveryAttributeMapping

Defina a propriedade type para especificar o tipo de objeto.

Para Dinâmico, use:

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

Para Estático, use:

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

Filtrar objetos

Defina a propriedade operatorType para especificar o tipo de objeto .

Para BoolEquals, use:

  operatorType: 'BoolEquals'
  value: bool

Para IsNotNull, use:

  operatorType: 'IsNotNull'

Para IsNullOrUndefined, use:

  operatorType: 'IsNullOrUndefined'

Para NumberGreaterThan, use:

  operatorType: 'NumberGreaterThan'
  value: int

Para NumberGreaterThanOrEquals, use:

  operatorType: 'NumberGreaterThanOrEquals'
  value: int

Para NumberIn, use:

  operatorType: 'NumberIn'
  values: [
    int
  ]

Para NumberInRange, use:

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

Para NumberLessThan, use:

  operatorType: 'NumberLessThan'
  value: int

Para NumberLessThanOrEquals, use:

  operatorType: 'NumberLessThanOrEquals'
  value: int

Para NumberNotIn, use:

  operatorType: 'NumberNotIn'
  values: [
    int
  ]

Para NumberNotInRange, use:

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

Para StringBeginsWith, use:

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

Para StringContains, use:

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

Para StringEndsWith, use:

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

Para StringIn, use:

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

Para StringNotBeginsWith, use:

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

Para StringNotContains, use:

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

Para StringNotEndsWith, use:

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

Para StringNotIn, use:

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

Valores de propriedade

namespaces/topics/eventSubscriptions

Nome	Descrição	Valor
name	O nome do recurso Veja como definir nomes e tipos para recursos filho no Bicep.	cadeia de caracteres (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 Recurso filho fora do recurso pai.	Nome simbólico para o recurso do tipo: tópicos
properties	Propriedades da assinatura do evento.	SubscriptionProperties

SubscriptionProperties

Nome	Descrição	Valor
deliveryConfiguration	Informações sobre a configuração de entrega da assinatura do evento.	DeliveryConfiguration
eventDeliverySchema	O esquema de entrega de eventos para a assinatura do evento.	'CloudEventSchemaV1_0'
filtersConfiguration	Informações sobre o filtro para a assinatura do evento.	FiltersConfiguration

DeliveryConfiguration

Nome	Descrição	Valor
deliveryMode	Modo de entrega da assinatura do evento.	'Push' 'Fila'
efetuar push	Essa propriedade deve ser preenchida quando deliveryMode é push e representa informações sobre a assinatura push.	PushInfo
fila	Essa propriedade deve ser preenchida quando deliveryMode é fila e representa informações sobre a assinatura da fila.	QueueInfo

PushInfo

Nome	Descrição	Valor
deadLetterDestinationWithResourceIdentity	O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. Usa a configuração de identidade gerenciada no recurso pai (ou seja, namespace) 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 precisam 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
eventTimeToLive	Duração do intervalo de tempo no formato ISO 8601 que determina por quanto tempo as mensagens estão disponíveis para a assinatura a partir do momento em que a mensagem foi publicada. Esse valor de duração é expresso usando o seguinte formato: 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', em que: - (n) é substituído pelo valor de cada elemento time que segue o (n). - P é o designador de duração (ou Período) e é sempre colocado no início da duração. - Y é o designador de ano e segue o valor do número de anos. - M é o designador de mês e segue o valor do número de meses. - W é o designador de semana e segue o valor do número de semanas. - D é o designador de dia e segue o valor do número de dias. - T é o designador de hora e precede os componentes de tempo. - H é o designador de hora e segue o valor do número de horas. - M é o designador de minuto e segue o valor do número de minutos. - S é o segundo designador e segue o valor para o número de segundos. Esse valor de duração não pode ser definido como eventRetentionInDays do tópico. É um campo opcional em que seu valor mínimo é de 1 minuto e seu máximo é determinado pelo valor eventRetentionInDays do tópico. Veja a seguir exemplos de valores válidos: - 'P0DT23H12M' ou 'PT23H12M': por 23 horas e 12 minutos. - 'P1D' ou 'P1DT0H0M0S': durante 1 dia.	string
maxDeliveryCount	A contagem máxima de entrega dos eventos.	INT

DeadLetterWithResourceIdentity

Nome	Descrição	Valor
deadLetterDestination	Informações sobre o destino em que os eventos precisam 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.	DeadLetterDestination
identidade	A identidade a ser usada quando eventos de mensagens mortas.	EventSubscriptionIdentity

DeadLetterDestination

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

EventSubscriptionIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade.	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	A identidade do usuário associada ao recurso.	string

DeliveryWithResourceIdentity

Nome	Descrição	Valor
destino	Informações sobre o destino em que os eventos precisam ser entregues para a assinatura do evento. Usa a identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.	EventSubscriptionDestination
identidade	A identidade a ser usada ao entregar eventos.	EventSubscriptionIdentity

EventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento.	'AzureFunction' (obrigatório)
properties	Propriedades da Função do Azure do destino da assinatura de 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.	string

DeliveryAttributeMapping

Nome	Descrição	Valor
name	Nome do atributo ou cabeçalho de entrega.	string
type	Definir o tipo de objeto	Dinâmico Estático (obrigatório)

DynamicDeliveryAttributeMapping

Nome	Descrição	Valor
tipo	Tipo do atributo de entrega ou nome do cabeçalho.	'Dynamic' (obrigatório)
properties	Propriedades do mapeamento de atributo de entrega dinâmica.	DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

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

StaticDeliveryAttributeMapping

Nome	Descrição	Valor
tipo	Tipo do atributo de entrega ou nome do cabeçalho.	'Static' (obrigatório)
properties	Propriedades do mapeamento de atributo de entrega estático.	StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

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.	string

MonitorAlertEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento.	'MonitorAlert' (obrigatório)
properties	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 todos os alertas disparados 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 cada alerta disparado por meio dessa assinatura de evento.	string
severidade	A gravidade que será anexada a cada alerta disparado 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 de evento.	'NamespaceTopic' (obrigatório)
properties	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 do recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.	string

PartnerEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento.	'PartnerDestination' (obrigatório)
properties	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.	string

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationPropertie...

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.	string

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationPropertie...

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.	string

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

Nome	Descrição	Valor
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.	string
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.	string
deliveryAttributeMappings	Detalhes do atributo de entrega.	DeliveryAttributeMapping[]
endpointUrl	A URL que representa o ponto de extremidade do destino de uma assinatura de evento.	string 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 compatível com o ponto de extremidade do webhook	'1.0' '1.1' '1.2'
preferredBatchSizeInKilobytes	Tamanho de lote preferencial em Kilobytes.	INT

QueueInfo

Nome	Descrição	Valor
deadLetterDestinationWithResourceIdentity	O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.	DeadLetterWithResourceIdentity
eventTimeToLive	Duração do intervalo de tempo no formato ISO 8601 que determina por quanto tempo as mensagens estão disponíveis para a assinatura a partir do momento em que a mensagem foi publicada. Esse valor de duração é expresso usando o seguinte formato: 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', em que: - (n) é substituído pelo valor de cada elemento time que segue o (n). - P é o designador de duração (ou Período) e é sempre colocado no início da duração. - Y é o designador de ano e segue o valor do número de anos. - M é o designador de mês e segue o valor do número de meses. - W é o designador de semana e segue o valor do número de semanas. - D é o designador de dia e segue o valor do número de dias. - T é o designador de hora e precede os componentes de tempo. - H é o designador de hora e segue o valor do número de horas. - M é o designador de minutos e segue o valor do número de minutos. - S é o segundo designador e segue o valor do número de segundos. Esse valor de duração não pode ser definido maior que EventRetentionInDays do tópico. É um campo opcional em que seu valor mínimo é de 1 minuto e seu máximo é determinado pelo valor EventRetentionInDays do tópico. Veja a seguir exemplos de valores válidos: - 'P0DT23H12M' ou 'PT23H12M': por 23 horas e 12 minutos. - 'P1D' ou 'P1DT0H0M0S': durante um dia.	string
maxDeliveryCount	A contagem máxima de entrega dos eventos.	INT
receiveLockDurationInSeconds	Período máximo em segundos em que uma vez que a mensagem esteja no estado recebido (pelo cliente) e aguardando para ser aceita, liberada ou rejeitada. Se esse tempo tiver decorrido depois que uma mensagem tiver sido recebida pelo cliente e não tiver sido transferida para aceita (não processada), liberada ou rejeitada, a mensagem está disponível para resgate. Esse é um campo opcional, em que o padrão é de 60 segundos, o mínimo é de 60 segundos e o máximo é de 300 segundos.	INT

FiltersConfiguration

Nome	Descrição	Valor
filtros	Uma matriz de filtros que são usados para filtrar assinaturas de evento.	Filter[]
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[]

Filtrar

Nome	Descrição	Valor
chave	O campo/propriedade no evento com base no qual você deseja filtrar.	string
operatorType	Definir o tipo de objeto	BoolEquals Isnotnull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (obrigatório)

BoolEqualsFilter

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

IsNotNullFilter

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

IsNullOrUndefinedFilter

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

NumberGreaterThanFilter

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

NumberGreaterThanOrEqualsFilter

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

NumberInFilter

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[]

NumberInRangeFilter

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[][]

NumberLessThanFilter

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

NumberLessThanOrEqualsFilter

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

NumberNotInFilter

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[]

NumberNotInRangeFilter

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[][]

StringBeginsWithFilter

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[]

StringContainsFilter

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[]

StringEndsWithFilter

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[]

StringInFilter

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[]

StringNotBeginsWithFilter

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[]

StringNotContainsFilter

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[]

StringNotEndsWithFilter

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[]

StringNotInFilter

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[]

Definição de recurso de modelo do ARM

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

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

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

Formato de recurso

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

{
  "type": "Microsoft.EventGrid/namespaces/topics/eventSubscriptions",
  "apiVersion": "2023-12-15-preview",
  "name": "string",
  "properties": {
    "deliveryConfiguration": {
      "deliveryMode": "string",
      "push": {
        "deadLetterDestinationWithResourceIdentity": {
          "deadLetterDestination": {
            "endpointType": "string"
            // For remaining properties, see DeadLetterDestination objects
          },
          "identity": {
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "deliveryWithResourceIdentity": {
          "destination": {
            "endpointType": "string"
            // For remaining properties, see EventSubscriptionDestination objects
          },
          "identity": {
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "eventTimeToLive": "string",
        "maxDeliveryCount": "int"
      },
      "queue": {
        "deadLetterDestinationWithResourceIdentity": {
          "deadLetterDestination": {
            "endpointType": "string"
            // For remaining properties, see DeadLetterDestination objects
          },
          "identity": {
            "type": "string",
            "userAssignedIdentity": "string"
          }
        },
        "eventTimeToLive": "string",
        "maxDeliveryCount": "int",
        "receiveLockDurationInSeconds": "int"
      }
    },
    "eventDeliverySchema": "CloudEventSchemaV1_0",
    "filtersConfiguration": {
      "filters": [
        {
          "key": "string",
          "operatorType": "string"
          // For remaining properties, see Filter objects
        }
      ],
      "includedEventTypes": [ "string" ]
    }
  }
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, use:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para AzureFunction, use:

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

Para o EventHub, use:

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

Para HybridConnection, use:

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

Para MonitorAlert, use:

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

Para NamespaceTopic, use:

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

Para PartnerDestination, use:

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

Para ServiceBusQueue, use:

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

Para ServiceBusTopic, use:

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

Para StorageQueue, use:

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

Para WebHook, use:

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

Objetos DeliveryAttributeMapping

Defina a propriedade type para especificar o tipo de objeto.

Para Dinâmico, use:

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

Para Estático, use:

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

Filtrar objetos

Defina a propriedade operatorType para especificar o tipo de objeto.

Para BoolEquals, use:

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

Para IsNotNull, use:

  "operatorType": "IsNotNull"

Para IsNullOrUndefined, use:

  "operatorType": "IsNullOrUndefined"

Para NumberGreaterThan, use:

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

Para NumberGreaterThanOrEquals, use:

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

Para NumberIn, use:

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

Para NumberInRange, use:

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

Para NumberLessThan, use:

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

Para NumberLessThanOrEquals, use:

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

Para NumberNotIn, use:

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

Para NumberNotInRange, use:

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

Para StringBeginsWith, use:

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

Para StringContains, use:

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

Para StringEndsWith, use:

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

Para StringIn, use:

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

Para StringNotBeginsWith, use:

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

Para StringNotContains, use:

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

Para StringNotEndsWith, use:

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

Para StringNotIn, use:

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

Valores de propriedade

namespaces/topics/eventSubscriptions

Nome	Descrição	Valor
tipo	O tipo de recurso	'Microsoft.EventGrid/namespaces/topics/eventSubscriptions'
apiVersion	A versão da API de recursos	'2023-12-15-preview'
name	O nome do recurso Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.	cadeia de caracteres (obrigatório)
properties	Propriedades da assinatura do evento.	SubscriptionProperties

SubscriptionProperties

Nome	Descrição	Valor
deliveryConfiguration	Informações sobre a configuração de entrega da assinatura do evento.	DeliveryConfiguration
eventDeliverySchema	O esquema de entrega de eventos para a assinatura do evento.	'CloudEventSchemaV1_0'
filtersConfiguration	Informações sobre o filtro para a assinatura do evento.	FiltersConfiguration

DeliveryConfiguration

Nome	Descrição	Valor
deliveryMode	Modo de entrega da assinatura do evento.	'Push' 'Fila'
efetuar push	Essa propriedade deve ser preenchida quando deliveryMode é push e representa informações sobre a assinatura push.	PushInfo
fila	Essa propriedade deve ser preenchida quando deliveryMode é fila e representa informações sobre a assinatura da fila.	QueueInfo

PushInfo

Nome	Descrição	Valor
deadLetterDestinationWithResourceIdentity	O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. Usa a configuração de identidade gerenciada no recurso pai (ou seja, namespace) 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
eventTimeToLive	Duração do intervalo de tempo no formato ISO 8601 que determina por quanto tempo as mensagens estão disponíveis para a assinatura a partir do momento em que a mensagem foi publicada. Esse valor de duração é expresso usando o seguinte formato: 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', em que: - (n) é substituído pelo valor de cada elemento time que segue o (n). - P é o designador de duração (ou Período) e é sempre colocado no início da duração. - Y é o designador de ano e segue o valor do número de anos. - M é o designador de mês e segue o valor do número de meses. - W é o designador de semana e segue o valor do número de semanas. - D é o designador de dia e segue o valor do número de dias. - T é o designador de hora e precede os componentes de tempo. - H é o designador de hora e segue o valor do número de horas. - M é o designador de minutos e segue o valor do número de minutos. - S é o segundo designador e segue o valor do número de segundos. Esse valor de duração não pode ser definido maior que EventRetentionInDays do tópico. É um campo opcional em que seu valor mínimo é de 1 minuto e seu máximo é determinado pelo valor EventRetentionInDays do tópico. Veja a seguir exemplos de valores válidos: - 'P0DT23H12M' ou 'PT23H12M': por 23 horas e 12 minutos. - 'P1D' ou 'P1DT0H0M0S': durante um dia.	string
maxDeliveryCount	A contagem máxima de entrega dos eventos.	INT

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 a entrega/mensagens mortas.	DeadLetterDestination
identidade	A identidade a ser usada quando eventos de mensagens mortas.	EventSubscriptionIdentity

DeadLetterDestination

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

EventSubscriptionIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade gerenciada usada. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade.	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	A identidade do usuário associada ao recurso.	string

DeliveryWithResourceIdentity

Nome	Descrição	Valor
destino	Informações sobre o destino em que os eventos precisam ser entregues para a assinatura do evento. Usa a identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.	EventSubscriptionDestination
identidade	A identidade a ser usada ao entregar eventos.	EventSubscriptionIdentity

EventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento.	'AzureFunction' (obrigatório)
properties	Propriedades da Função do Azure do destino da assinatura de 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.	string

DeliveryAttributeMapping

Nome	Descrição	Valor
name	Nome do atributo ou cabeçalho de entrega.	string
type	Definir o tipo de objeto	Dinâmico Estático (obrigatório)

DynamicDeliveryAttributeMapping

Nome	Descrição	Valor
tipo	Tipo do atributo de entrega ou do nome do cabeçalho.	'Dynamic' (obrigatório)
properties	Propriedades do mapeamento de atributo de entrega dinâmica.	DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

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

StaticDeliveryAttributeMapping

Nome	Descrição	Valor
tipo	Tipo do atributo de entrega ou do nome do cabeçalho.	'Static' (obrigatório)
properties	Propriedades do mapeamento de atributo de entrega estático.	StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

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

MonitorAlertEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento.	'MonitorAlert' (obrigatório)
properties	Monitorar propriedades de alerta do destino da assinatura de 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 este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.	string[]
descrição	A descrição que será anexada a cada Alerta disparado por meio dessa assinatura de evento.	string
severidade	A gravidade que será anexada a cada Alerta disparado 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 de evento.	'NamespaceTopic' (obrigatório)
properties	Propriedades do Tópico do Namespace do destino da assinatura de 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 do recurso deve seguir este padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.	string

PartnerEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento.	'PartnerDestination' (obrigatório)
properties	Propriedades de Destino do Parceiro do destino da assinatura de 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.	string

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationPropertie...

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.	string

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationPropertie...

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.	string

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

Nome	Descrição	Valor
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.	string
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.	string
deliveryAttributeMappings	Detalhes do atributo de entrega.	DeliveryAttributeMapping[]
endpointUrl	A URL que representa o ponto de extremidade do destino de uma assinatura de evento.	string 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 compatível com o ponto de extremidade do webhook	'1.0' '1.1' '1.2'
preferredBatchSizeInKilobytes	Tamanho de lote preferencial em Kilobytes.	INT

QueueInfo

Nome	Descrição	Valor
deadLetterDestinationWithResourceIdentity	O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.	DeadLetterWithResourceIdentity
eventTimeToLive	Duração do intervalo de tempo no formato ISO 8601 que determina por quanto tempo as mensagens estão disponíveis para a assinatura a partir do momento em que a mensagem foi publicada. Esse valor de duração é expresso usando o seguinte formato: 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', em que: - (n) é substituído pelo valor de cada elemento time que segue o (n). - P é o designador de duração (ou Período) e é sempre colocado no início da duração. - Y é o designador de ano e segue o valor do número de anos. - M é o designador de mês e segue o valor do número de meses. - W é o designador de semana e segue o valor do número de semanas. - D é o designador de dia e segue o valor do número de dias. - T é o designador de hora e precede os componentes de tempo. - H é o designador de hora e segue o valor do número de horas. - M é o designador de minuto e segue o valor do número de minutos. - S é o segundo designador e segue o valor para o número de segundos. Esse valor de duração não pode ser definido como eventRetentionInDays do tópico. É um campo opcional em que seu valor mínimo é de 1 minuto e seu máximo é determinado pelo valor eventRetentionInDays do tópico. Veja a seguir exemplos de valores válidos: - 'P0DT23H12M' ou 'PT23H12M': por 23 horas e 12 minutos. - 'P1D' ou 'P1DT0H0M0S': durante 1 dia.	string
maxDeliveryCount	A contagem máxima de entrega dos eventos.	INT
receiveLockDurationInSeconds	Período máximo em segundos em que uma vez que a mensagem está no estado recebido (pelo cliente) e aguardando para ser aceita, liberada ou rejeitada. Se esse tempo tiver decorrido depois que uma mensagem tiver sido recebida pelo cliente e não tiver sido transferida para aceita (não processada), liberada ou rejeitada, a mensagem está disponível para nova entrega. Esse é um campo opcional, em que o padrão é 60 segundos, o mínimo é de 60 segundos e o máximo é de 300 segundos.	INT

FiltersConfiguration

Nome	Descrição	Valor
filtros	Uma matriz de filtros que são usados para filtrar assinaturas de evento.	Filter[]
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[]

Filtrar

Nome	Descrição	Valor
chave	O campo/propriedade no evento com base no qual você deseja filtrar.	string
operatorType	Definir o tipo de objeto	BoolEquals Isnotnull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (obrigatório)

BoolEqualsFilter

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

IsNotNullFilter

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

IsNullOrUndefinedFilter

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

NumberGreaterThanFilter

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

NumberGreaterThanOrEqualsFilter

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

NumberInFilter

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[]

NumberInRangeFilter

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[][]

NumberLessThanFilter

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

NumberLessThanOrEqualsFilter

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

NumberNotInFilter

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[]

NumberNotInRangeFilter

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[][]

StringBeginsWithFilter

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[]

StringContainsFilter

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[]

StringEndsWithFilter

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[]

StringInFilter

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[]

StringNotBeginsWithFilter

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[]

StringNotContainsFilter

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[]

StringNotEndsWithFilter

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[]

StringNotInFilter

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[]

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

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

• Grupos de recursos

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deliveryConfiguration = {
        deliveryMode = "string"
        push = {
          deadLetterDestinationWithResourceIdentity = {
            deadLetterDestination = {
              endpointType = "string"
              // For remaining properties, see DeadLetterDestination objects
            }
            identity = {
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          deliveryWithResourceIdentity = {
            destination = {
              endpointType = "string"
              // For remaining properties, see EventSubscriptionDestination objects
            }
            identity = {
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          eventTimeToLive = "string"
          maxDeliveryCount = int
        }
        queue = {
          deadLetterDestinationWithResourceIdentity = {
            deadLetterDestination = {
              endpointType = "string"
              // For remaining properties, see DeadLetterDestination objects
            }
            identity = {
              type = "string"
              userAssignedIdentity = "string"
            }
          }
          eventTimeToLive = "string"
          maxDeliveryCount = int
          receiveLockDurationInSeconds = int
        }
      }
      eventDeliverySchema = "CloudEventSchemaV1_0"
      filtersConfiguration = {
        filters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see Filter objects
          }
        ]
        includedEventTypes = [
          "string"
        ]
      }
    }
  })
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, use:

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

Objetos EventSubscriptionDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para AzureFunction, use:

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

Para o EventHub, use:

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

Para HybridConnection, use:

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

Para MonitorAlert, use:

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

Para NamespaceTopic, use:

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

Para PartnerDestination, use:

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

Para ServiceBusQueue, use:

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

Para ServiceBusTopic, use:

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

Para StorageQueue, use:

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

Para WebHook, use:

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

Objetos DeliveryAttributeMapping

Defina a propriedade type para especificar o tipo de objeto.

Para Dinâmico, use:

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

Para Estático, use:

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

Filtrar objetos

Defina a propriedade operatorType para especificar o tipo de objeto .

Para BoolEquals, use:

  operatorType = "BoolEquals"
  value = bool

Para IsNotNull, use:

  operatorType = "IsNotNull"

Para IsNullOrUndefined, use:

  operatorType = "IsNullOrUndefined"

Para NumberGreaterThan, use:

  operatorType = "NumberGreaterThan"
  value = int

Para NumberGreaterThanOrEquals, use:

  operatorType = "NumberGreaterThanOrEquals"
  value = int

Para NumberIn, use:

  operatorType = "NumberIn"
  values = [
    int
  ]

Para NumberInRange, use:

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

Para NumberLessThan, use:

  operatorType = "NumberLessThan"
  value = int

Para NumberLessThanOrEquals, use:

  operatorType = "NumberLessThanOrEquals"
  value = int

Para NumberNotIn, use:

  operatorType = "NumberNotIn"
  values = [
    int
  ]

Para NumberNotInRange, use:

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

Para StringBeginsWith, use:

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

Para StringContains, use:

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

Para StringEndsWith, use:

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

Para StringIn, use:

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

Para StringNotBeginsWith, use:

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

Para StringNotContains, use:

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

Para StringNotEndsWith, use:

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

Para StringNotIn, use:

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

Valores de propriedade

namespaces/topics/eventSubscriptions

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview"
name	O nome do recurso	cadeia de caracteres (obrigatório)
parent_id	A ID do recurso que é o pai desse recurso.	ID do recurso do tipo: tópicos
properties	Propriedades da assinatura do evento.	SubscriptionProperties

SubscriptionProperties

Nome	Descrição	Valor
deliveryConfiguration	Informações sobre a configuração de entrega da assinatura do evento.	DeliveryConfiguration
eventDeliverySchema	O esquema de entrega de eventos para a assinatura do evento.	"CloudEventSchemaV1_0"
filtersConfiguration	Informações sobre o filtro para a assinatura do evento.	FiltersConfiguration

DeliveryConfiguration

Nome	Descrição	Valor
deliveryMode	Modo de entrega da assinatura do evento.	"Push" "Fila"
efetuar push	Essa propriedade deve ser preenchida quando deliveryMode é push e representa informações sobre a assinatura push.	PushInfo
fila	Essa propriedade deve ser preenchida quando deliveryMode é fila e representa informações sobre a assinatura da fila.	QueueInfo

PushInfo

Nome	Descrição	Valor
deadLetterDestinationWithResourceIdentity	O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. Usa a configuração de identidade gerenciada no recurso pai (ou seja, namespace) 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
eventTimeToLive	Duração do intervalo de tempo no formato ISO 8601 que determina por quanto tempo as mensagens estão disponíveis para a assinatura a partir do momento em que a mensagem foi publicada. Esse valor de duração é expresso usando o seguinte formato: 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', em que: - (n) é substituído pelo valor de cada elemento time que segue o (n). - P é o designador de duração (ou Período) e é sempre colocado no início da duração. - Y é o designador de ano e segue o valor do número de anos. - M é o designador de mês e segue o valor do número de meses. - W é o designador de semana e segue o valor do número de semanas. - D é o designador de dia e segue o valor do número de dias. - T é o designador de hora e precede os componentes de tempo. - H é o designador de hora e segue o valor do número de horas. - M é o designador de minutos e segue o valor do número de minutos. - S é o segundo designador e segue o valor do número de segundos. Esse valor de duração não pode ser definido maior que EventRetentionInDays do tópico. É um campo opcional em que seu valor mínimo é de 1 minuto e seu máximo é determinado pelo valor EventRetentionInDays do tópico. Veja a seguir exemplos de valores válidos: - 'P0DT23H12M' ou 'PT23H12M': por 23 horas e 12 minutos. - 'P1D' ou 'P1DT0H0M0S': durante um dia.	string
maxDeliveryCount	A contagem máxima de entrega dos eventos.	INT

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 a entrega/mensagens mortas.	DeadLetterDestination
identidade	A identidade a ser usada quando eventos de mensagens mortas.	EventSubscriptionIdentity

DeadLetterDestination

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

StorageBlobDeadLetterDestination

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

StorageBlobDeadLetterDestinationProperties

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

EventSubscriptionIdentity

Nome	Descrição	Valor
tipo	O tipo de identidade gerenciada usada. O tipo "SystemAssigned, UserAssigned" inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá qualquer identidade.	"SystemAssigned" "UserAssigned"
userAssignedIdentity	A identidade do usuário associada ao recurso.	string

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 identidade do Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.	EventSubscriptionDestination
identidade	A identidade a ser usada ao fornecer eventos.	EventSubscriptionIdentity

EventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento.	"AzureFunction" (obrigatório)
properties	Propriedades da Função do Azure do destino da assinatura de 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.	string

DeliveryAttributeMapping

Nome	Descrição	Valor
name	Nome do atributo ou cabeçalho de entrega.	string
type	Definir o tipo de objeto	Dinâmico Estático (obrigatório)

DynamicDeliveryAttributeMapping

Nome	Descrição	Valor
tipo	Tipo do atributo de entrega ou do nome do cabeçalho.	"Dinâmico" (obrigatório)
properties	Propriedades do mapeamento de atributo de entrega dinâmica.	DynamicDeliveryAttributeMappingProperties

DynamicDeliveryAttributeMappingProperties

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

StaticDeliveryAttributeMapping

Nome	Descrição	Valor
tipo	Tipo do atributo de entrega ou do nome do cabeçalho.	"Estático" (obrigatório)
properties	Propriedades do mapeamento de atributo de entrega estático.	StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

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.	string

MonitorAlertEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento.	"MonitorAlert" (obrigatório)
properties	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 todos os alertas disparados 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 cada alerta disparado por meio dessa assinatura de evento.	string
severidade	A gravidade que será anexada a cada alerta disparado 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 de evento.	"NamespaceTopic" (obrigatório)
properties	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 do recurso deve seguir esse padrão: /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.	string

PartnerEventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Tipo do ponto de extremidade para o destino da assinatura de evento.	"PartnerDestination" (obrigatório)
properties	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.	string

ServiceBusQueueEventSubscriptionDestination

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

ServiceBusQueueEventSubscriptionDestinationPropertie...

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.	string

ServiceBusTopicEventSubscriptionDestination

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

ServiceBusTopicEventSubscriptionDestinationPropertie...

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.	string

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

Nome	Descrição	Valor
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.	string
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.	string
deliveryAttributeMappings	Detalhes do atributo de entrega.	DeliveryAttributeMapping[]
endpointUrl	A URL que representa o ponto de extremidade do destino de uma assinatura de evento.	string 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 compatível com o ponto de extremidade do webhook	"1.0" "1.1" "1.2"
preferredBatchSizeInKilobytes	Tamanho de lote preferencial em Kilobytes.	INT

QueueInfo

Nome	Descrição	Valor
deadLetterDestinationWithResourceIdentity	O destino de mensagens mortas da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino de mensagens mortas. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.	DeadLetterWithResourceIdentity
eventTimeToLive	Duração do intervalo de tempo no formato ISO 8601 que determina por quanto tempo as mensagens estão disponíveis para a assinatura a partir do momento em que a mensagem foi publicada. Esse valor de duração é expresso usando o seguinte formato: 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', em que: - (n) é substituído pelo valor de cada elemento time que segue o (n). - P é o designador de duração (ou Período) e é sempre colocado no início da duração. - Y é o designador de ano e segue o valor do número de anos. - M é o designador de mês e segue o valor do número de meses. - W é o designador de semana e segue o valor do número de semanas. - D é o designador de dia e segue o valor do número de dias. - T é o designador de hora e precede os componentes de tempo. - H é o designador de hora e segue o valor do número de horas. - M é o designador de minutos e segue o valor do número de minutos. - S é o segundo designador e segue o valor do número de segundos. Esse valor de duração não pode ser definido maior que EventRetentionInDays do tópico. É um campo opcional em que seu valor mínimo é de 1 minuto e seu máximo é determinado pelo valor EventRetentionInDays do tópico. Veja a seguir exemplos de valores válidos: - 'P0DT23H12M' ou 'PT23H12M': por 23 horas e 12 minutos. - 'P1D' ou 'P1DT0H0M0S': durante um dia.	string
maxDeliveryCount	A contagem máxima de entrega dos eventos.	INT
receiveLockDurationInSeconds	Período máximo em segundos em que uma vez que a mensagem esteja no estado recebido (pelo cliente) e aguardando para ser aceita, liberada ou rejeitada. Se esse tempo tiver decorrido depois que uma mensagem tiver sido recebida pelo cliente e não tiver sido transferida para aceita (não processada), liberada ou rejeitada, a mensagem está disponível para resgate. Esse é um campo opcional, em que o padrão é de 60 segundos, o mínimo é de 60 segundos e o máximo é de 300 segundos.	INT

FiltersConfiguration

Nome	Descrição	Valor
filtros	Uma matriz de filtros que são usados para filtrar assinaturas de evento.	Filter[]
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[]

Filtrar

Nome	Descrição	Valor
chave	O campo/propriedade no evento com base no qual você deseja filtrar.	string
operatorType	Definir o tipo de objeto	BoolEquals Isnotnull IsNullOrUndefined NumberGreaterThan NumberGreaterThanOrEquals NumberIn NumberInRange NumberLessThan NumberLessThanOrEquals NumberNotIn NumberNotInRange StringBeginsWith StringContains StringEndsWith StringIn StringNotBeginsWith StringNotContains StringNotEndsWith StringNotIn (obrigatório)

BoolEqualsFilter

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

IsNotNullFilter

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

IsNullOrUndefinedFilter

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

NumberGreaterThanFilter

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

NumberGreaterThanOrEqualsFilter

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

NumberInFilter

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[]

NumberInRangeFilter

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[][]

NumberLessThanFilter

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

NumberLessThanOrEqualsFilter

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

NumberNotInFilter

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[]

NumberNotInRangeFilter

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[][]

StringBeginsWithFilter

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[]

StringContainsFilter

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[]

StringEndsWithFilter

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[]

StringInFilter

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[]

StringNotBeginsWithFilter

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[]

StringNotContainsFilter

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[]

StringNotEndsWithFilter

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[]

StringNotInFilter

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[]