Microsoft.EventGrid systemTopics/eventSubscriptions 2020-04-01-preview

Artigo
12/17/2024

Definição de recurso do Bicep

O tipo de recurso systemTopics/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 de log de alterações.

Formato de recurso

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

resource symbolicname 'Microsoft.EventGrid/systemTopics/eventSubscriptions@2020-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        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
        }
      ]
      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 do AzureFunction, use:

{
  endpointType: 'AzureFunction'
  properties: {
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }
}

Para do EventHub, use:

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

Para HybridConnection, use:

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

Para ServiceBusQueue, use:

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

Para ServiceBusTopic, use:

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

Para StorageQueue, use:

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

Para webhook, use:

{
  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    endpointUrl: 'string'
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
  }
}

Objetos AdvancedFilter

Defina a propriedade operatorType para especificar o tipo de objeto.

Para boolEquals, use:

{
  operatorType: 'BoolEquals'
  value: bool
}

Para NumberGreaterThan, use:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

Para NumberGreaterThanOrEquals, use:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

Para NumberIn, use:

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

Para NumberLessThan, use:

{
  operatorType: 'NumberLessThan'
  value: int
}

Para NumberLessThanOrEquals, use:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

Para NumberNotIn, use:

{
  operatorType: 'NumberNotIn'
  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 StringNotIn, use:

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

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob, use:

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

Valores de propriedade

AdvancedFilter

Nome	Descrição	Valor
chave	O campo/propriedade no evento com base no qual você deseja filtrar.	corda
operatorType	Defina como 'BoolEquals' para o tipo BoolEqualsAdvancedFilter. Defina como 'NumberGreaterThan' para o tipo NumberGreaterThanAdvancedFilter. Defina como 'NumberGreaterThanOrEquals' para o tipo NumberGreaterThanOrEqualsAdvancedFilter. Defina como 'NumberIn' para o tipo NumberInAdvancedFilter. Defina como 'NumberLessThan' para o tipo NumberLessThanAdvancedFilter. Defina como 'NumberLessThanOrEquals' para o tipo NumberLessThanOrEqualsAdvancedFilter. Defina como 'NumberNotIn' para o tipo NumberNotInAdvancedFilter. Defina como 'StringBeginsWith' para o tipo StringBeginsWithAdvancedFilter. Defina como 'StringContains' para o tipo StringContainsAdvancedFilter. Defina como 'StringEndsWith' para o tipo StringEndsWithAdvancedFilter. Definir como 'StringIn' para o tipo StringInAdvancedFilter. Defina como 'StringNotIn' para o tipo StringNotInAdvancedFilter.	'BoolEquals' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotIn' (obrigatório)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

Nome	Descrição	Valor
maxEventsPerBatch	Número máximo de eventos por lote.	int
preferredBatchSizeInKilobytes	Tamanho de lote preferencial em Kilobytes.	int
resourceId	A ID de Recurso do Azure que representa o ponto de extremidade do destino da Função do Azure de uma assinatura de evento.	corda

BoolEqualsAdvancedFilter

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

DeadLetterDestination

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

DeadLetterWithResourceIdentity

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

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 da 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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

Nome	Descrição	Valor
endpointType	Defina como 'AzureFunction' para o tipo AzureFunctionEventSubscriptionDestination. Defina como 'EventHub' para o tipo EventHubEventSubscriptionDestination. Defina como 'HybridConnection' para o tipo HybridConnectionEventSubscriptionDestination. Defina como '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

Nome	Descrição	Valor
advancedFilters	Uma matriz de filtros avançados que são usados para filtrar assinaturas de eventos.	AdvancedFilter[]
includedEventTypes	Uma lista de tipos de eventos aplicáveis que precisam fazer parte da assinatura do evento. Se desejar assinar todos os tipos de evento padrão, defina IncludedEventTypes como nulo.	string[]
isSubjectCaseSensitive	Especifica se as propriedades SubjectBeginsWith e SubjectEndsWith do filtro deve ser comparado de maneira sensível a maiúsculas de minúsculas.	Bool
subjectBeginsWith	Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um prefixo de caminho de recurso. O formato disso depende do editor dos eventos. Não há suporte para caracteres curinga neste caminho.	corda
subjectEndsWith	Uma cadeia de caracteres opcional para filtrar eventos para uma assinatura de evento com base em um sufixo de caminho de recurso. Não há suporte para caracteres curinga neste caminho.	corda

EventSubscriptionIdentity

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

EventSubscriptionProperties

Nome	Descrição	Valor
deadLetterDestination	O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta morta. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.	DeadLetterDestination
deadLetterWithResourceIdentity	O destino da carta morta da assinatura do evento. Qualquer evento que não possa ser entregue ao seu destino é enviado para o destino da carta morta. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.	DeadLetterWithResourceIdentity
deliveryWithResourceIdentity	Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.	DeliveryWithResourceIdentity
destino	Informações sobre o destino em que os eventos devem ser entregues para a assinatura do evento. Usa a identidade da Grade de Eventos do Azure para adquirir os tokens de autenticação que estão sendo usados durante a entrega/mensagens mortas.	eventSubscriptionDestination
eventDeliverySchema	O esquema de entrega de eventos para a assinatura do evento.	'CloudEventSchemaV1_0' 'CustomInputSchema' 'EventGridSchema'
expirationTimeUtc	Hora de expiração da assinatura do evento.	corda
filtro	Informações sobre o filtro da assinatura do evento.	EventSubscriptionFilter
Rótulos	Lista de rótulos definidos pelo usuário.	string[]
retryPolicy	A política de repetição para eventos. Isso pode ser usado para configurar o número máximo de tentativas de entrega e tempo de vida útil para eventos.	retryPolicy

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

Nome	Descrição	Valor
resourceId	A ID de Recurso do Azure de uma conexão híbrida que é o destino de uma assinatura de evento.	corda