Microsoft.EventGrid namespaces/topics/eventSubscriptions 2024-06-01-preview

Article
12/17/2024

Définition de ressource Bicep

Les espaces de noms/rubriques/type de ressource eventSubscriptions peuvent être déployés avec des opérations qui ciblent :

groupes de ressources - Consultez commandes de déploiement de groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format de ressource

Pour créer une ressource Microsoft.EventGrid/namespaces/topics/eventSubscriptions, ajoutez le bicep suivant à votre modèle.

resource symbolicname 'Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2024-06-01-preview' = {
  parent: resourceSymbolicName
  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'
          }
        }
        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: {
            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'
      ]
    }
  }
}

Objets EventSubscriptionDestination

Définissez la propriété endpointType pour spécifier le type d’objet.

Pour AzureFunction, utilisez :

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

Pour EventHub, utilisez :

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

Pour HybridConnection, utilisez :

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

Pour MonitorAlert, utilisez :

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

Pour NamespaceTopic, utilisez :

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

Pour PartnerDestination, utilisez :

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

Pour ServiceBusQueue, utilisez :

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

Pour ServiceBusTopic, utilisez :

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

Pour StorageQueue, utilisez :

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

Pour WebHook, utilisez :

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

Objets DeadLetterDestination

Définissez la propriété endpointType pour spécifier le type d’objet.

Pour StorageBlob, utilisez :

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

Objets DeliveryAttributeMapping

Définissez le type propriété pour spécifier le type d’objet.

Pour dynamique, utilisez :

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

Pour statique, utilisez :

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

Filtrer les objets

Définissez la propriété operatorType pour spécifier le type d’objet.

Pour BoolEquals, utilisez :

{
  operatorType: 'BoolEquals'
  value: bool
}

Pour IsNotNull, utilisez :

{
  operatorType: 'IsNotNull'
}

Pour IsNullOrUndefined, utilisez :

{
  operatorType: 'IsNullOrUndefined'
}

Pour NumberGreaterThan, utilisez :

{
  operatorType: 'NumberGreaterThan'
  value: int
}

Pour NumberGreaterThanOrEquals, utilisez :

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

Pour NumberIn, utilisez :

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

Pour NumberInRange, utilisez :

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

Pour NumberLessThan, utilisez :

{
  operatorType: 'NumberLessThan'
  value: int
}

Pour NumberLessThanOrEquals, utilisez :

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

Pour NumberNotIn, utilisez :

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

Pour NumberNotInRange, utilisez :

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

Pour StringBeginsWith, utilisez :

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

Pour StringContains, utilisez :

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

Pour StringEndsWith, utilisez :

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

Pour StringIn, utilisez :

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

Pour StringNotBeginsWith, utilisez :

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

Pour StringNotContains, utilisez :

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

Pour StringNotEndsWith, utilisez :

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

Pour stringNotIn, utilisez :

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

Valeurs de propriété

AzureFunctionEventSubscriptionDestination

Nom	Description	Valeur
endpointType	Type du point de terminaison pour la destination de l’abonnement aux événements.	'AzureFunction' (obligatoire)
Propriétés	Propriétés de fonction Azure de la destination de l’abonnement aux événements.	AzureFunctionEventSubscriptionDestinationProperties

AzureFunctionEventSubscriptionDestinationProperties

Nom	Description	Valeur
deliveryAttributeMappings	Détails de l’attribut de remise.	DeliveryAttributeMapping[]
maxEventsPerBatch	Nombre maximal d’événements par lot.	Int
preferredBatchSizeInKilobytes	Taille de lot préférée en Kilo-octets.	Int
resourceId	ID de ressource Azure qui représente le point de terminaison de la destination de fonction Azure d’un abonnement aux événements.	corde

BoolEqualsFilter

Nom	Description	Valeur
operatorType	Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.	'BoolEquals' (obligatoire)
valeur	Valeur du filtre booléen.	Bool

DeadLetterDestination

Nom	Description	Valeur
endpointType	Défini sur « StorageBlob » pour le type StorageBlobDeadLetterDestination.	'StorageBlob' (obligatoire)

DeadLetterWithResourceIdentity

Nom	Description	Valeur
deadLetterDestination	Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. Utilise la configuration de l’identité managée sur la ressource parente (à savoir, rubrique ou domaine) pour acquérir les jetons d’authentification utilisés pendant la mise en lettres mortes.	DeadLetterDestination
identité	Identité à utiliser lors des événements de lettres mortes.	EventSubscriptionIdentity

DeliveryAttributeMapping

Nom	Description	Valeur
nom	Nom de l’attribut ou de l’en-tête de remise.	corde
type	Défini sur « Dynamic » pour le type DynamicDeliveryAttributeMapping. Défini sur « Static » pour le type StaticDeliveryAttributeMapping.	'Dynamique' 'Static' (obligatoire)

DeliveryConfiguration

Nom	Description	Valeur
deliveryMode	Mode de remise de l’abonnement aux événements.	'Push' 'File d’attente'
pousser	Cette propriété doit être remplie lorsque deliveryMode est push et représente des informations sur l’abonnement Push.	PushInfo
queue	Cette propriété doit être remplie lorsque deliveryMode est en file d’attente et représente des informations sur l’abonnement de file d’attente.	queueInfo

DeliveryWithResourceIdentity

Nom	Description	Valeur
destination	Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements. Utilise la configuration de l’identité managée sur la ressource parente (à savoir, rubrique ou domaine) pour acquérir les jetons d’authentification utilisés pendant la remise.	EventSubscriptionDestination
identité	Identité à utiliser lors de la remise d’événements.	EventSubscriptionIdentity

DynamicDeliveryAttributeMapping

Nom	Description	Valeur
Propriétés	Propriétés du mappage d’attributs de remise dynamique.	DynamicDeliveryAttributeMappingProperties
type	Type de l’attribut de remise ou du nom d’en-tête.	'Dynamic' (obligatoire)

DynamicDeliveryAttributeMappingProperties

Nom	Description	Valeur
sourceField	Chemin JSON dans l’événement qui contient la valeur d’attribut.	corde

EventHubEventSubscriptionDestination

Nom	Description	Valeur
endpointType	Type du point de terminaison pour la destination de l’abonnement aux événements.	'EventHub' (obligatoire)
Propriétés	Propriétés event Hub de la destination de l’abonnement aux événements.	EventHubEventSubscriptionDestinationProperties

EventHubEventSubscriptionDestinationProperties

Nom	Description	Valeur
deliveryAttributeMappings	Détails de l’attribut de remise.	DeliveryAttributeMapping[]
resourceId	ID de ressource Azure qui représente le point de terminaison d’une destination Event Hub d’un abonnement aux événements.	corde

EventSubscriptionDestination

Nom	Description	Valeur
endpointType	Défini sur « AzureFunction » pour le type AzureFunctionEventSubscriptionDestination. Défini sur « EventHub » pour le type EventHubEventSubscriptionDestination. Défini sur « HybridConnection » pour le type HybridConnectionEventSubscriptionDestination. Défini sur « MonitorAlert » pour le type MonitorAlertEventSubscriptionDestination. Défini sur « NamespaceTopic » pour le type NamespaceTopicEventSubscriptionDestination. Défini sur « PartnerDestination » pour le type PartnerEventSubscriptionDestination. Défini sur « ServiceBusQueue » pour le type ServiceBusQueueEventSubscriptionDestination. Défini sur « ServiceBusTopic » pour le type ServiceBusTopicEventSubscriptionDestination. Défini sur « StorageQueue » pour le type StorageQueueEventSubscriptionDestination. Défini sur « WebHook » pour le type WebHookEventSubscriptionDestination.	'AzureFunction' 'EventHub' 'HybridConnection' 'MonitorAlert' 'NamespaceTopic' 'PartnerDestination' 'ServiceBusQueue' 'ServiceBusTopic' 'StorageQueue' 'WebHook' (obligatoire)

EventSubscriptionIdentity

Nom	Description	Valeur
type	Type d’identité managée utilisée. Peut être « SystemAssigned » ou « UserAssigned ».	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	Identité de l’utilisateur associée à la ressource.	corde

Filtre

Nom	Description	Valeur
clé	Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.	corde
operatorType	Défini sur « BoolEquals » pour le type BoolEqualsFilter. Défini sur « IsNotNull » pour le type IsNotNullFilter. Défini sur « IsNullOrUndefined » pour le type IsNullOrUndefinedFilter. Défini sur « NumberGreaterThan » pour le type NumberGreaterThanFilter. Affectez la valeur « NumberGreaterThanOrEquals » pour le type NumberGreaterThanOrEqualsFilter. Défini sur « NumberIn » pour le type NumberInFilter. Défini sur « NumberInRange » pour le type NumberInRangeFilter. Défini sur « NumberLessThan » pour le type NumberLessThanFilter. Défini sur « NumberLessThanOrEquals » pour le type NumberLessThanOrEqualsFilter. Défini sur « NumberNotIn » pour le type NumberNotInFilter. Défini sur « NumberNotInRange » pour le type NumberNotInRangeFilter. Défini sur « StringBeginsWith » pour le type StringBeginsWithFilter. Défini sur « StringContains » pour le type StringContainsFilter. Défini sur « StringEndsWith » pour le type StringEndsWithFilter. Défini sur « StringIn » pour le type StringInFilter. Défini sur « StringNotBeginsWith » pour le type StringNotBeginsWithFilter. Défini sur « StringNotContains » pour le type StringNotContainsFilter. Défini sur « StringNotEndsWith » pour le type StringNotEndsWithFilter. Défini sur « StringNotIn » pour le type StringNotInFilter.	'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (obligatoire)

FiltersConfiguration

Nom	Description	Valeur
Filtres	Tableau de filtres utilisés pour filtrer les abonnements aux événements.	filtre[]
includedEventTypes	Liste des types d’événements applicables qui doivent faire partie de l’abonnement aux événements. Si vous souhaitez vous abonner à tous les types d’événements par défaut, définissez les IncludedEventTypes sur Null.	string[]

HybridConnectionEventSubscriptionDestination

Nom	Description	Valeur
endpointType	Type du point de terminaison pour la destination de l’abonnement aux événements.	'HybridConnection' (obligatoire)
Propriétés	Propriétés de connexion hybrides de la destination de l’abonnement aux événements.	HybridConnectionEventSubscriptionDestinationProperties

HybridConnectionEventSubscriptionDestinationProperties

Nom	Description	Valeur
deliveryAttributeMappings	Détails de l’attribut de remise.	DeliveryAttributeMapping[]
resourceId	ID de ressource Azure d’une connexion hybride qui est la destination d’un abonnement aux événements.	corde

IsNotNullFilter

Nom	Description	Valeur
operatorType	Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.	'IsNotNull' (obligatoire)

IsNullOrUndefinedFilter

Nom	Description	Valeur
operatorType	Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres.	'IsNullOrUndefined' (obligatoire)