Microsoft.EventGrid eventSubscriptions 2022-06-15

Artigo
12/16/2024

Definição de recursos do bíceps

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

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

Formato do recurso

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2022-06-15' = {
  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: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        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 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 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 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
    preferredBatchSizeInKilobytes: int
  }
}

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob , use:

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

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto.

Para BoolEquals, use:

{
  operatorType: 'BoolEquals'
  value: bool
}

Para IsNotNull, use:

{
  operatorType: 'IsNotNull'
}

Para IsNullOrUndefined, use:

{
  operatorType: 'IsNullOrUndefined'
}

Para NumberGreaterThan, use:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

Para NumberGreaterThanOrEquals , use:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

Para NumberIn, use:

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

Para NumberInRange, use:

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

Para NumberLessThan , use:

{
  operatorType: 'NumberLessThan'
  value: int
}

Para NumberLessThanOrEquals , use:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

Para NumberNotIn , use:

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

Para NumberNotInRange, use:

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

Para StringBeginsWith, use:

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

Para StringContains, use:

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

Para StringEndsWith, use:

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

Para StringIn , use:

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

Para StringNotBeginsWith, use:

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

Para StringNotContains, use:

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

Para StringNotEndsWith, use:

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

Para StringNotIn , use:

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

Objetos DeliveryAttributeMapping

Defina a propriedade type 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'
}

Valores de propriedade

AdvancedFilter

Designação	Descrição	Valor
chave	O campo/propriedade no evento com base no qual você deseja filtrar.	string
Tipo de operador	Defina como 'BoolEquals' para o tipo BoolEqualsAdvancedFilter. Defina como 'IsNotNull' para o tipo IsNotNullAdvancedFilter. Defina como 'IsNullOrUndefined' para o tipo IsNullOrUndefinedAdvancedFilter. Defina como 'NumberGreaterThan' para o tipo NumberGreaterThanAdvancedFilter. Defina como 'NumberGreaterThanOrEquals' para o tipo NumberGreaterThanOrEqualsAdvancedFilter. Defina como 'NumberIn' para o tipo NumberInAdvancedFilter. Defina como 'NumberInRange' para o tipo NumberInRangeAdvancedFilter. Defina como 'NumberLessThan' para o tipo NumberLessThanAdvancedFilter. Defina como 'NumberLessThanOrEquals' para o tipo NumberLessThanOrEqualsAdvancedFilter. Defina como 'NumberNotIn' para o tipo NumberNotInAdvancedFilter. Defina como 'NumberNotInRange' para o tipo NumberNotInRangeAdvancedFilter. Defina como 'StringBeginsWith' para o tipo StringBeginsWithAdvancedFilter. Defina como 'StringContains' para o tipo StringContainsAdvancedFilter. Defina como 'StringEndsWith' para o tipo StringEndsWithAdvancedFilter. Defina como 'StringIn' para o tipo StringInAdvancedFilter. Defina como 'StringNotBeginsWith' para o tipo StringNotBeginsWithAdvancedFilter. Defina como 'StringNotContains' para o tipo StringNotContainsAdvancedFilter. Defina como 'StringNotEndsWith' para o tipo StringNotEndsWithAdvancedFilter. Defina como 'StringNotIn' para o tipo StringNotInAdvancedFilter.	'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NúmeroMaiorQue' 'NúmeroMaiorThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (obrigatório)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

Designação	Descrição	Valor
deliveryAttributeMappings	Detalhes do atributo de entrega.	DeliveryAttributeMapping []
maxEventsPerBatch	Número máximo de eventos por lote.	Int
preferredBatchSizeInKilobytes	Tamanho de lote preferido em kilobytes.	Int
resourceId	A Id de Recursos do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento.	string

BoolEqualsAdvancedFilter

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

DeadLetterDestination

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

DeadLetterWithResourceIdentity

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

DeliveryAttributeMapping

Designação	Descrição	Valor
Designação	Nome do atributo de entrega ou cabeçalho.	string
tipo	Defina como 'Dynamic' para o tipo DynamicDeliveryAttributeMapping. Defina como 'Static' para o tipo StaticDeliveryAttributeMapping.	'Dinâmico' 'Estática' (obrigatório)

DeliveryWithResourceIdentity

Designação	Descrição	Valor
destino	Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.	EventSubscriptionDestination
identidade	A identidade a ser usada ao entregar eventos.	EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Designação	Descrição	Valor
propriedades	Propriedades do mapeamento dinâmico de atributos de entrega.	DynamicDeliveryAttributeMappingProperties
tipo	Tipo do atributo de entrega ou nome do cabeçalho.	'Dinâmico' (obrigatório)

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Designação	Descrição	Valor
deliveryAttributeMappings	Detalhes do atributo de entrega.	DeliveryAttributeMapping []
resourceId	A Id de Recursos do Azure que representa o ponto de extremidade de um destino do Hub de Eventos de uma assinatura de evento.	string

EventSubscriptionDestination

Designação	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 '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' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (obrigatório)

EventSubscriptionFilter

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

EventSubscriptionIdentity

Designação	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 'Nenhum' removerá qualquer identidade.	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	A identidade do usuário associada ao recurso.	string

EventSubscriptionProperties

Designação	Descrição	Valor
deadLetterDestino	O destino letra morta da assinatura do evento. Qualquer evento que não possa ser entregue no seu destino é enviado para o destino letra morta. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.	DeadLetterDestination
deadLetterWithResourceIdentity	O destino letra morta da assinatura do evento. Qualquer evento que não possa ser entregue no seu destino é enviado para o destino letra morta. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.	DeliveryWithResourceIdentity
destino	Informações sobre o destino onde os eventos devem ser entregues para a assinatura do evento. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/dead-lettering.	EventSubscriptionDestination
eventDeliverySchema	O esquema de entrega de eventos para a assinatura do evento.	'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema'
expiraçãoTimeUtc	Tempo de expiração da subscrição do evento.	string
filtrar	Informações sobre o filtro para a assinatura do evento.	EventSubscriptionFilter
rótulos	Lista de rótulos definidos pelo usuário.	string[]
retryPolicy	A política de repetição para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e o tempo de vida dos eventos.	RetryPolicy

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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