Microsoft.EventGrid namespaces/topics/eventSubscriptions 2024-12-15-preview

Artigo
12/16/2024

Definição de recursos do bíceps

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

Grupos de recursos - Consulte comandos de implantação de grupo de recursos

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/namespaces/topics/eventSubscriptions, adicione o seguinte Bíceps ao seu modelo.

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

Objetos DeadLetterDestination

Defina a propriedade endpointType para especificar o tipo de objeto.

Para StorageBlob , use:

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

Objetos DeliveryAttributeMapping

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

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

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

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

BoolEqualsFilter

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 o 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)

DeliveryConfiguration

Designação	Descrição	Valor
Modo de entrega	Modo de entrega da subscrição do evento.	'Empurrão' 'Fila'
empurrar	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

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 configuração de identidade gerenciada no recurso pai (ou seja, tópico ou domínio) para adquirir os tokens de autenticação que estão sendo usados durante a entrega.	EventSubscriptionDestination
identidade	A identidade a ser usada ao 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 'MonitorAlert' para o tipo MonitorAlertEventSubscriptionDestination. Defina como 'NamespaceTopic' para o tipo NamespaceTopicEventSubscriptionDestination. Defina como 'PartnerDestination' para o tipo PartnerEventSubscriptionDestination. Defina como 'ServiceBusQueue' para o tipo ServiceBusQueueEventSubscriptionDestination. Defina como 'ServiceBusTopic' para o tipo ServiceBusTopicEventSubscriptionDestination. Defina como 'StorageQueue' para o tipo StorageQueueEventSubscriptionDestination. Defina como 'WebHook' para o tipo WebHookEventSubscriptionDestination.	'AzureFunction' 'EventHub' 'HybridConnection' 'MonitorAlert' 'NamespaceTopic' 'DestinoParceiro' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (obrigatório)

EventSubscriptionIdentity

Designação	Descrição	Valor
federatedIdentityCredentialInfo	Os detalhes da Credencial de Identidade Federada (FIC) usada com a entrega do recurso.	FederatedIdentityCredentialInfo
tipo	O tipo de identidade gerenciada usada. Pode ser 'SystemAssigned' ou 'UserAssigned'.	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	A identidade do usuário associada ao recurso.	string

FederatedIdentityCredentialInfo

Designação	Descrição	Valor
federatedClientId	O Aplicativo AAD Multilocatário ao qual a Credencial de Identidade Federada (FIC) está associada.	string Restrições: Comprimento mínimo = 36 Comprimento máximo = 36 Padrão = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (obrigatório)

Filtrar

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 BoolEqualsFilter. Defina como 'IsNotNull' para o tipo IsNotNullFilter. Defina como 'IsNullOrUndefined' para o tipo IsNullOrUndefinedFilter. Defina como 'NumberGreaterThan' para o tipo NumberGreaterThanFilter. Defina como 'NumberGreaterThanOrEquals' para o tipo NumberGreaterThanOrEqualsFilter. Defina como 'NumberIn' para o tipo NumberInFilter. Defina como 'NumberInRange' para o tipo NumberInRangeFilter. Defina como 'NumberLessThan' para o tipo NumberLessThanFilter. Defina como 'NumberLessThanOrEquals' para o tipo NumberLessThanOrEqualsFilter. Defina como 'NumberNotIn' para o tipo NumberNotInFilter. Defina como 'NumberNotInRange' para o tipo NumberNotInRangeFilter. Defina como 'StringBeginsWith' para o tipo StringBeginsWithFilter. Defina como 'StringContains' para o tipo StringContainsFilter. Defina como 'StringEndsWith' para o tipo StringEndsWithFilter. Defina como 'StringIn' para o tipo StringInFilter. Defina como 'StringNotBeginsWith' para o tipo StringNotBeginsWithFilter. Defina como 'StringNotContains' para o tipo StringNotContainsFilter. Defina como 'StringNotEndsWith' para o tipo StringNotEndsWithFilter. Defina como 'StringNotIn' para o tipo StringNotInFilter.	'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NúmeroMaiorQue' 'NúmeroMaiorThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (obrigatório)

FiltrosConfiguração

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

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

IsNotNullFilter

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)

IsNullOrUndefinedFilter

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)