Partager via


Espaces de noms/rubriques/eventSubscriptions Microsoft.EventGrid

Définition de ressource Bicep

Le type de ressource namespaces/topics/eventSubscriptions peut être déployé avec des opérations qui ciblent :

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

Format des ressources

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

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

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

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

Pour Dynamique, utilisez :

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

Pour Statique, utilisez :

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

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és

namespaces/topics/eventSubscriptions

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.
string (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.
Nom symbolique de la ressource de type : rubriques
properties Propriétés de l’abonnement aux événements. SubscriptionProperties

SubscriptionProperties

Nom Description Valeur
deliveryConfiguration Informations sur la configuration de remise de l’abonnement aux événements. DeliveryConfiguration
eventDeliverySchema Schéma de remise d’événements pour l’abonnement aux événements. 'CloudEventSchemaV1_0'
filtersConfiguration Informations sur le filtre de l’abonnement aux événements. FiltresConfiguration

DeliveryConfiguration

Nom Description Valeur
deliveryMode Mode de remise de l’abonnement aux événements. 'Push'
'File d’attente'
push Cette propriété doit être renseignée lorsque deliveryMode est envoyé (push) et représente des informations sur l’abonnement push. PushInfo
queue Cette propriété doit être renseignée lorsque deliveryMode est file d’attente et représente des informations sur l’abonnement de file d’attente. QueueInfo

PushInfo

Nom Description Valeur
deadLetterDestinationWithResourceIdentity Destination des lettres mortes de l’abonnement aux événements. Tout événement qui ne peut pas être remis à destination est envoyé à la destination des lettres mortes.
Utilise la configuration de l’identité managée sur la ressource parente (à savoir, l’espace de noms) pour acquérir les jetons d’authentification utilisés lors de la remise/de lettres mortes.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity 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 lors de la remise/de lettres mortes.
DeliveryWithResourceIdentity
eventTimeToLive Durée de l’intervalle de temps au format ISO 8601 qui détermine la durée pendant laquelle les messages sont disponibles pour l’abonnement à partir du moment où le message a été publié.
Cette valeur de durée est exprimée au format suivant : 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', où :
- (n) est remplacé par la valeur de chaque élément de temps qui suit le (n).
- P est l’identificateur de durée (ou de période) et est toujours placé au début de la durée.
- Y est l’identificateur d’année et suit la valeur du nombre d’années.
- M est l’identificateur de mois et suit la valeur du nombre de mois.
- W est l’identificateur de semaine et suit la valeur du nombre de semaines.
- D est l’identificateur de jour et suit la valeur du nombre de jours.
- T est l’identificateur de temps, et il précède les composants de temps.
- H est l’identificateur d’heure et suit la valeur du nombre d’heures.
- M est l’identificateur de minute et suit la valeur du nombre de minutes.
- S est le deuxième désignateur et suit la valeur du nombre de secondes.
Cette valeur de durée ne peut pas être supérieure à la valeur EventRetentionInDays de la rubrique. Il s’agit d’un champ facultatif où sa valeur minimale est 1 minute et sa valeur maximale est déterminée
par la valeur EventRetentionInDays de la rubrique. Voici des exemples de valeurs valides :
- « P0DT23H12M » ou « PT23H12M » : pour une durée de 23 heures et 12 minutes.
- « P1D » ou « P1DT0H0M0S » : pour une durée d'1 jour.
string
maxDeliveryCount Nombre maximal de remises des événements. int

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 lors de la remise/de lettres mortes.
DeadLetterDestination
identité Identité à utiliser lors des événements de lettres mortes. EventSubscriptionIdentity

DeadLetterDestination

Nom Description Valeur
endpointType Définir le type d’objet StorageBlob (obligatoire)

StorageBlobDeadLetterDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination des lettres mortes 'StorageBlob' (obligatoire)
properties Propriétés de la destination des lettres mortes basées sur l’objet blob de stockage StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Nom Description Valeur
blobContainerName Nom du conteneur d’objets blob de stockage qui est la destination des événements deadletter string
resourceId ID de ressource Azure du compte de stockage qui est la destination des événements deadletter string

EventSubscriptionIdentity

Nom Description Valeur
type Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité. 'SystemAssigned'
'UserAssigned'
userAssignedIdentity Identité de l’utilisateur associée à la ressource. string

DeliveryWithResourceIdentity

Nom Description Valeur
destination Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements.
Utilise l’identité de Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise ou de la mise en lettres mortes.
EventSubscriptionDestination
identité Identité à utiliser lors de la remise d’événements. EventSubscriptionIdentity

EventSubscriptionDestination

Nom Description Valeur
endpointType Définir le type d’objet AzureFunction
EventHub
HybridConnection
MonitorAlert
Espace de nomsTopic
PartnerDestination
ServiceBusQueue
ServiceBusTopic
StorageQueue
WebHook (obligatoire)

AzureFunctionEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'AzureFunction' (obligatoire)
properties Propriétés de la 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 à un événement. string

DeliveryAttributeMapping

Nom Description Valeur
name Nom de l’attribut de remise ou de l’en-tête. string
type Définir le type d’objet Dynamique
Statique (obligatoire)

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

Nom Description Valeur
isSecret Indicateur booléen pour indiquer si l’attribut contient des informations sensibles. bool
value Valeur de l’attribut de remise. string

EventHubEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'EventHub' (obligatoire)
properties 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. string

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

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

MonitorAlertEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'MonitorAlert' (obligatoire)
properties Surveillez les propriétés d’alerte de la destination de l’abonnement aux événements. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Nom Description Valeur
actionGroups Liste des ID ARM des groupes d’actions qui seront déclenchés sur chaque alerte déclenchée par le biais de cet abonnement aux événements.
Chaque ID ARM de ressource doit suivre ce modèle : /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description Description qui sera attachée à chaque alerte déclenchée par le biais de cet abonnement à l’événement. string
severity Gravité qui sera attachée à chaque alerte déclenchée via cet abonnement à l’événement.
Ce champ doit être fourni.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'NamespaceTopic' (obligatoire)
properties Propriétés de rubrique d’espace de noms de la destination de l’abonnement aux événements. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Nom Description Valeur
resourceId ID de ressource Azure qui représente le point de terminaison de la destination de la rubrique d’espace de noms Event Grid d’un abonnement à un événement.
Ce champ est obligatoire et la ressource rubrique d’espace de noms répertoriée doit déjà exister.
L’ID ARM de ressource doit suivre ce modèle : /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
string

PartnerEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'PartnerDestination' (obligatoire)
properties Propriétés de destination du partenaire de la destination de l’abonnement aux événements. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Nom Description Valeur
resourceId ID de ressource Azure qui représente le point de terminaison d’une destination partenaire d’un abonnement à un événement. string

ServiceBusQueueEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'ServiceBusQueue' (obligatoire)
properties Propriétés Service Bus de la destination de l’abonnement aux événements. ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Nom Description Valeur
deliveryAttributeMappings Détails de l’attribut de remise. DeliveryAttributeMapping[]
resourceId ID de ressource Azure qui représente le point de terminaison de la destination Service Bus d’un abonnement à un événement. string

ServiceBusTopicEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'ServiceBusTopic' (obligatoire)
properties Propriétés de rubrique Service Bus de la destination de l’abonnement aux événements. ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

Nom Description Valeur
deliveryAttributeMappings Détails de l’attribut de remise. DeliveryAttributeMapping[]
resourceId ID de ressource Azure qui représente le point de terminaison de la destination de rubrique Service Bus d’un abonnement à un événement. string

StorageQueueEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'StorageQueue' (obligatoire)
properties Propriétés de la file d’attente de stockage de la destination de l’abonnement aux événements. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Nom Description Valeur
queueMessageTimeToLiveInSeconds Durée de vie des messages de la file d’attente de stockage en secondes. Cette valeur ne peut pas être nulle ou négative, à l’exception de l’utilisation de -1 pour indiquer que la durée de vie du message est infinie. int
queueName Nom de la file d’attente de stockage sous un compte de stockage qui est la destination d’un abonnement aux événements. string
resourceId ID de ressource Azure du compte de stockage qui contient la file d’attente qui est la destination d’un abonnement aux événements. string

WebHookEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'WebHook' (obligatoire)
properties Propriétés webHook de la destination de l’abonnement aux événements. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nom Description Valeur
azureActiveDirectoryApplicationIdOrUri L’ID ou l’URI d’application Azure Active Directory pour obtenir le jeton d’accès qui sera inclus en tant que jeton du porteur dans les demandes de remise. string
azureActiveDirectoryTenantId ID de locataire Azure Active Directory pour obtenir le jeton d’accès qui sera inclus comme jeton du porteur dans les demandes de remise. string
deliveryAttributeMappings Détails de l’attribut de remise. DeliveryAttributeMapping[]
endpointUrl URL qui représente le point de terminaison de la destination d’un abonnement aux événements. string

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.
maxEventsPerBatch Nombre maximal d’événements par lot. int
minimumTlsVersionAllowed Version TLS minimale qui doit être prise en charge par le point de terminaison webhook '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Taille de lot préférée en Kilo-octets. int

QueueInfo

Nom Description Valeur
deadLetterDestinationWithResourceIdentity Destination des lettres mortes de l’abonnement aux événements. Tout événement qui ne peut pas être livré à sa destination est envoyé à la destination de la lettre morte.
Utilise la configuration de l’identité managée sur la ressource parente (à savoir, la rubrique) pour acquérir les jetons d’authentification utilisés lors de la remise/lettre morte.
DeadLetterWithResourceIdentity
eventTimeToLive Durée de l’intervalle de temps au format ISO 8601 qui détermine la durée pendant laquelle les messages sont disponibles pour l’abonnement à partir du moment où le message a été publié.
Cette valeur de durée est exprimée au format suivant : 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', où :
- (n) est remplacé par la valeur de chaque élément de temps qui suit (n).
- P est l’indicateur de durée (ou point) et est toujours placé au début de la durée.
- Y est l’indicateur d’année, et il suit la valeur du nombre d’années.
- M est l’indicateur de mois et suit la valeur du nombre de mois.
- W est l’indicateur de semaine, et il suit la valeur du nombre de semaines.
- D est l’indicateur de jour et suit la valeur du nombre de jours.
- T est l’indicateur de temps, et il précède les composants de temps.
- H est l’indicateur d’heure, et il suit la valeur du nombre d’heures.
- M est l’indicateur de minute et suit la valeur du nombre de minutes.
- S est le deuxième indicateur, et il suit la valeur pour le nombre de secondes.
Cette valeur de durée ne peut pas être définie au-delà de la valeur EventRetentionInDays de la rubrique. Il s’agit d’un champ facultatif où sa valeur minimale est de 1 minute et son maximum est déterminé
par la valeur EventRetentionInDays de la rubrique. Voici des exemples de valeurs valides :
- 'P0DT23H12M' ou 'PT23H12M' : pour une durée de 23 heures et 12 minutes.
- 'P1D' ou 'P1DT0H0M0S' : pour une durée de 1 jour.
string
maxDeliveryCount Nombre maximal de remises des événements. int
receiveLockDurationInSeconds Période maximale en secondes au cours de laquelle une fois que le message est reçu (par le client) et en attente d’acceptation, de libération ou de rejet.
Si ce délai s’est écoulé après la réception d’un message par le client et qu’il n’a pas été converti en accepté (non traité), libéré ou rejeté,
le message est disponible pour redelivery. Il s’agit d’un champ facultatif, où la valeur par défaut est de 60 secondes, le minimum est de 60 secondes et le maximum est de 300 secondes.
int

FiltresConfiguration

Nom Description Valeur
filtres Tableau de filtres utilisés pour filtrer les abonnements aux événements. Filter[]
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 IncludedEventTypes sur null. string[]

Filtrer

Nom Description Valeur
key Champ/propriété dans l’événement en fonction duquel vous souhaitez filtrer. string
operatorType Définir le type d’objet BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberInRange
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
NumberNotInRange
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (obligatoire)

BoolEqualsFilter

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

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)

NumberGreaterThanFilter

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

NumberGreaterThanOrEqualsFilter

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

NumberInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'NumberIn' (obligatoire)
values Ensemble de valeurs de filtre. int[]

NumberInRangeFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'NumberInRange' (obligatoire)
values Ensemble de valeurs de filtre. int[][]

NumberLessThanFilter

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

NumberLessThanOrEqualsFilter

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

NumberNotInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'NumberNotIn' (obligatoire)
values Ensemble de valeurs de filtre. int[]

NumberNotInRangeFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'NumberNotInRange' (obligatoire)
values Ensemble de valeurs de filtre. int[][]

StringBeginsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'StringBeginsWith' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringContainsFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'StringContains' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringEndsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. 'StringEndsWith' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. 'StringIn' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotBeginsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. 'StringNotBeginsWith' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotContainsFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. 'StringNotContains' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotEndsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. 'StringNotEndsWith' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. 'StringNotIn' (obligatoire)
values Ensemble de valeurs de filtre. string[]

Définition de ressources de modèle ARM

Le type de ressource namespaces/topics/eventSubscriptions peut être déployé avec des opérations qui ciblent :

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

Format des ressources

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

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

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

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

Pour Dynamique, utilisez :

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

Pour Statique, utilisez :

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

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és

espaces de noms/rubriques/eventSubscriptions

Nom Description Valeur
type Type de ressource « Microsoft.EventGrid/namespaces/topics/eventSubscriptions »
apiVersion Version de l’API de ressource « 2023-12-15-preview »
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.
chaîne (obligatoire)
properties Propriétés de l’abonnement aux événements. SubscriptionProperties

SubscriptionProperties

Nom Description Valeur
deliveryConfiguration Informations sur la configuration de remise de l’abonnement aux événements. DeliveryConfiguration
eventDeliverySchema Schéma de remise d’événements pour l’abonnement aux événements. 'CloudEventSchemaV1_0'
filtresConfiguration Informations sur le filtre de l’abonnement aux événements. FiltresConfiguration

DeliveryConfiguration

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

PushInfo

Nom Description Valeur
deadLetterDestinationWithResourceIdentity Destination de lettre morte de l’abonnement aux événements. Tout événement qui ne peut pas être livré à sa destination est envoyé à la destination de la lettre morte.
Utilise la configuration de l’identité managée sur la ressource parente (à savoir, l’espace de noms) pour acquérir les jetons d’authentification utilisés lors de la remise/lettre morte.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity 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 (rubrique ou domaine) pour acquérir les jetons d’authentification utilisés lors de la remise ou de la lettre morte.
DeliveryWithResourceIdentity
eventTimeToLive Durée de l’intervalle de temps au format ISO 8601 qui détermine la durée pendant laquelle les messages sont disponibles pour l’abonnement à partir du moment où le message a été publié.
Cette valeur de durée est exprimée au format suivant : 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', où :
- (n) est remplacé par la valeur de chaque élément de temps qui suit (n).
- P est l’indicateur de durée (ou point) et est toujours placé au début de la durée.
- Y est l’indicateur d’année, et il suit la valeur du nombre d’années.
- M est l’indicateur de mois et suit la valeur du nombre de mois.
- W est l’indicateur de semaine, et il suit la valeur du nombre de semaines.
- D est l’indicateur de jour et suit la valeur du nombre de jours.
- T est l’indicateur de temps, et il précède les composants de temps.
- H est l’indicateur d’heure, et il suit la valeur du nombre d’heures.
- M est l’indicateur de minute et suit la valeur du nombre de minutes.
- S est le deuxième indicateur, et il suit la valeur pour le nombre de secondes.
Cette valeur de durée ne peut pas être définie au-delà de la valeur EventRetentionInDays de la rubrique. Il s’agit d’un champ facultatif où sa valeur minimale est de 1 minute et son maximum est déterminé
par la valeur EventRetentionInDays de la rubrique. Voici des exemples de valeurs valides :
- 'P0DT23H12M' ou 'PT23H12M' : pour une durée de 23 heures et 12 minutes.
- 'P1D' ou 'P1DT0H0M0S' : pour une durée de 1 jour.
string
maxDeliveryCount Nombre maximal de remises des événements. int

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 (rubrique ou domaine) pour acquérir les jetons d’authentification utilisés lors de la remise ou de la lettre morte.
DeadLetterDestination
identité Identité à utiliser lors d’événements de lettres mortes. EventSubscriptionIdentity

DeadLetterDestination

Nom Description Valeur
endpointType Définir le type d’objet StorageBlob (obligatoire)

StorageBlobDeadLetterDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination des lettres mortes 'StorageBlob' (obligatoire)
properties Propriétés de la destination deadletter d’objet blob de stockage StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Nom Description Valeur
blobContainerName Nom du conteneur d’objets blob de stockage qui est la destination des événements deadletter string
resourceId ID de ressource Azure du compte de stockage qui est la destination des événements deadletter string

EventSubscriptionIdentity

Nom Description Valeur
type Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité implicitement créée et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité. 'SystemAssigned'
'UserAssigned'
userAssignedIdentity Identité d’utilisateur associée à la ressource. string

DeliveryWithResourceIdentity

Nom Description Valeur
destination Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements.
Utilise l’identité de Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise ou de la lettre morte.
EventSubscriptionDestination
identité Identité à utiliser lors de la remise d’événements. EventSubscriptionIdentity

EventSubscriptionDestination

Nom Description Valeur
endpointType Définir le type d’objet AzureFunction
EventHub
HybridConnection
MonitorAlert
Espace de nomsTopic
PartnerDestination
ServiceBusQueue
ServiceBusTopic
StorageQueue
WebHook (obligatoire)

AzureFunctionEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'AzureFunction' (obligatoire)
properties Propriétés de la 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 à un événement. string

DeliveryAttributeMapping

Nom Description Valeur
name Nom de l’attribut de remise ou de l’en-tête. string
type Définir le type d’objet Dynamique
Statique (obligatoire)

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

Nom Description Valeur
isSecret Indicateur booléen pour indiquer si l’attribut contient des informations sensibles. bool
value Valeur de l’attribut de remise. string

EventHubEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'EventHub' (obligatoire)
properties 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. string

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperti...

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

MonitorAlertEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'MonitorAlert' (obligatoire)
properties Surveillez les propriétés d’alerte de la destination de l’abonnement aux événements. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Nom Description Valeur
actionGroups Liste des ID ARM des groupes d’actions qui seront déclenchés sur chaque alerte déclenchée par le biais de cet abonnement aux événements.
Chaque ID ARM de ressource doit suivre ce modèle : /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description Description qui sera attachée à chaque alerte déclenchée par le biais de cet abonnement à l’événement. string
severity Gravité qui sera attachée à chaque alerte déclenchée via cet abonnement à l’événement.
Ce champ doit être fourni.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'NamespaceTopic' (obligatoire)
properties Propriétés de rubrique d’espace de noms de la destination de l’abonnement aux événements. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Nom Description Valeur
resourceId ID de ressource Azure qui représente le point de terminaison de la destination de la rubrique d’espace de noms Event Grid d’un abonnement à un événement.
Ce champ est obligatoire et la ressource rubrique d’espace de noms répertoriée doit déjà exister.
L’ID ARM de ressource doit suivre ce modèle : /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
string

PartnerEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'PartnerDestination' (obligatoire)
properties Propriétés de destination du partenaire de la destination de l’abonnement aux événements. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Nom Description Valeur
resourceId ID de ressource Azure qui représente le point de terminaison d’une destination partenaire d’un abonnement à un événement. string

ServiceBusQueueEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'ServiceBusQueue' (obligatoire)
properties Propriétés Service Bus de la destination de l’abonnement aux événements. ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Nom Description Valeur
deliveryAttributeMappings Détails de l’attribut de remise. DeliveryAttributeMapping[]
resourceId ID de ressource Azure qui représente le point de terminaison de la destination Service Bus d’un abonnement à un événement. string

ServiceBusTopicEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'ServiceBusTopic' (obligatoire)
properties Propriétés de rubrique Service Bus de la destination de l’abonnement aux événements. ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

Nom Description Valeur
deliveryAttributeMappings Détails de l’attribut de remise. DeliveryAttributeMapping[]
resourceId ID de ressource Azure qui représente le point de terminaison de la destination de rubrique Service Bus d’un abonnement à un événement. string

StorageQueueEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'StorageQueue' (obligatoire)
properties Propriétés de la file d’attente de stockage de la destination de l’abonnement aux événements. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Nom Description Valeur
queueMessageTimeToLiveInSeconds Durée de vie des messages de la file d’attente de stockage en secondes. Cette valeur ne peut pas être nulle ou négative, à l’exception de l’utilisation de -1 pour indiquer que la durée de vie du message est infinie. int
queueName Nom de la file d’attente de stockage sous un compte de stockage qui est la destination d’un abonnement aux événements. string
resourceId ID de ressource Azure du compte de stockage qui contient la file d’attente qui est la destination d’un abonnement aux événements. string

WebHookEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'WebHook' (obligatoire)
properties Propriétés webHook de la destination de l’abonnement aux événements. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nom Description Valeur
azureActiveDirectoryApplicationIdOrUri L’ID ou l’URI d’application Azure Active Directory pour obtenir le jeton d’accès qui sera inclus en tant que jeton du porteur dans les demandes de remise. string
azureActiveDirectoryTenantId ID de locataire Azure Active Directory pour obtenir le jeton d’accès qui sera inclus comme jeton du porteur dans les demandes de remise. string
deliveryAttributeMappings Détails de l’attribut de remise. DeliveryAttributeMapping[]
endpointUrl URL qui représente le point de terminaison de la destination d’un abonnement aux événements. string

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.
maxEventsPerBatch Nombre maximal d’événements par lot. int
minimumTlsVersionAllowed Version TLS minimale qui doit être prise en charge par le point de terminaison webhook '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Taille de lot préférée en Kilo-octets. int

QueueInfo

Nom Description Valeur
deadLetterDestinationWithResourceIdentity Destination des lettres mortes de l’abonnement aux événements. Tout événement qui ne peut pas être remis à destination est envoyé à la destination des lettres mortes.
Utilise la configuration de l’identité managée sur la ressource parente (rubrique) pour acquérir les jetons d’authentification utilisés lors de la remise/de lettres mortes.
DeadLetterWithResourceIdentity
eventTimeToLive Durée de l’intervalle de temps au format ISO 8601 qui détermine la durée pendant laquelle les messages sont disponibles pour l’abonnement à partir du moment où le message a été publié.
Cette valeur de durée est exprimée au format suivant : 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', où :
- (n) est remplacé par la valeur de chaque élément de temps qui suit le (n).
- P est l’identificateur de durée (ou de période) et est toujours placé au début de la durée.
- Y est l’identificateur d’année et suit la valeur du nombre d’années.
- M est l’identificateur de mois et suit la valeur du nombre de mois.
- W est l’identificateur de semaine et suit la valeur du nombre de semaines.
- D est l’identificateur de jour et suit la valeur du nombre de jours.
- T est l’identificateur de temps, et il précède les composants de temps.
- H est l’identificateur d’heure et suit la valeur du nombre d’heures.
- M est l’identificateur de minute et suit la valeur du nombre de minutes.
- S est le deuxième désignateur et suit la valeur du nombre de secondes.
Cette valeur de durée ne peut pas être supérieure à la valeur EventRetentionInDays de la rubrique. Il s’agit d’un champ facultatif où sa valeur minimale est 1 minute et sa valeur maximale est déterminée
par la valeur EventRetentionInDays de la rubrique. Voici des exemples de valeurs valides :
- « P0DT23H12M » ou « PT23H12M » : pour une durée de 23 heures et 12 minutes.
- « P1D » ou « P1DT0H0M0S » : pour une durée d'1 jour.
string
maxDeliveryCount Nombre maximal de remises des événements. int
receiveLockDurationInSeconds Période maximale en secondes pendant laquelle le message est reçu (par le client) et en attente d’acceptation, de libération ou de rejet.
Si ce temps s’est écoulé après qu’un message a été reçu par le client et qu’il n’a pas été converti en accepté (non traité), libéré ou rejeté,
le message est disponible pour redelivery. Il s’agit d’un champ facultatif, où la valeur par défaut est 60 secondes, la valeur minimale est 60 secondes et la valeur maximale est de 300 secondes.
int

FiltresConfiguration

Nom Description Valeur
filtres Tableau de filtres utilisés pour filtrer les abonnements aux événements. Filter[]
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 IncludedEventTypes sur null. string[]

Filtrer

Nom Description Valeur
key Champ/propriété dans l’événement en fonction duquel vous souhaitez filtrer. string
operatorType Définir le type d’objet BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberInRange
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
NumberNotInRange
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (obligatoire)

BoolEqualsFilter

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

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)

NumberGreaterThanFilter

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

NumberGreaterThanOrEqualsFilter

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

NumberInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'NumberIn' (obligatoire)
values Ensemble de valeurs de filtre. int[]

NumberInRangeFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'NumberInRange' (obligatoire)
values Ensemble de valeurs de filtre. int[][]

NumberLessThanFilter

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

NumberLessThanOrEqualsFilter

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

NumberNotInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'NumberNotIn' (obligatoire)
values Ensemble de valeurs de filtre. int[]

NumberNotInRangeFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'NumberNotInRange' (obligatoire)
values Ensemble de valeurs de filtre. int[][]

StringBeginsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'StringBeginsWith' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringContainsFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'StringContains' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringEndsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'StringEndsWith' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'StringIn' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotBeginsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'StringNotBeginsWith' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotContainsFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'StringNotContains' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotEndsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'StringNotEndsWith' (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. 'StringNotIn' (obligatoire)
values Ensemble de valeurs de filtre. string[]

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource namespaces/topics/eventSubscriptions peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

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

Format des ressources

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

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"
        ]
      }
    }
  })
}

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

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

Pour Dynamic, utilisez :

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

Pour Statique, utilisez :

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

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és

espaces de noms/rubriques/eventSubscriptions

Nom Description Valeur
type Type de ressource « Microsoft.EventGrid/namespaces/topics/eventSubscriptions@2023-12-15-preview »
name Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : rubriques
properties Propriétés de l’abonnement aux événements. SubscriptionProperties

SubscriptionProperties

Nom Description Valeur
deliveryConfiguration Informations sur la configuration de remise de l’abonnement aux événements. DeliveryConfiguration
eventDeliverySchema Schéma de remise d’événements pour l’abonnement aux événements. « CloudEventSchemaV1_0 »
filtresConfiguration Informations sur le filtre de l’abonnement aux événements. FiltresConfiguration

DeliveryConfiguration

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

PushInfo

Nom Description Valeur
deadLetterDestinationWithResourceIdentity Destination de lettre morte de l’abonnement aux événements. Tout événement qui ne peut pas être remis à destination est envoyé à la destination des lettres mortes.
Utilise la configuration de l’identité managée sur la ressource parente (à savoir, l’espace de noms) pour acquérir les jetons d’authentification utilisés lors de la remise/de lettres mortes.
DeadLetterWithResourceIdentity
deliveryWithResourceIdentity 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 lors de la remise/de lettres mortes.
DeliveryWithResourceIdentity
eventTimeToLive Durée de l’intervalle de temps au format ISO 8601 qui détermine la durée pendant laquelle les messages sont disponibles pour l’abonnement à partir du moment où le message a été publié.
Cette valeur de durée est exprimée au format suivant : 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', où :
- (n) est remplacé par la valeur de chaque élément de temps qui suit le (n).
- P est l’identificateur de durée (ou de période) et est toujours placé au début de la durée.
- Y est l’identificateur d’année et suit la valeur du nombre d’années.
- M est l’identificateur de mois et suit la valeur du nombre de mois.
- W est l’identificateur de semaine et suit la valeur du nombre de semaines.
- D est l’identificateur de jour et suit la valeur du nombre de jours.
- T est l’identificateur de temps, et il précède les composants de temps.
- H est l’identificateur d’heure et suit la valeur du nombre d’heures.
- M est l’identificateur de minute et suit la valeur du nombre de minutes.
- S est le deuxième désignateur et suit la valeur du nombre de secondes.
Cette valeur de durée ne peut pas être supérieure à la valeur EventRetentionInDays de la rubrique. Il s’agit d’un champ facultatif où sa valeur minimale est 1 minute et sa valeur maximale est déterminée
par la valeur EventRetentionInDays de la rubrique. Voici des exemples de valeurs valides :
- « P0DT23H12M » ou « PT23H12M » : pour une durée de 23 heures et 12 minutes.
- « P1D » ou « P1DT0H0M0S » : pour une durée d'1 jour.
string
maxDeliveryCount Nombre maximal de remises des événements. int

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 lors de la remise/de lettres mortes.
DeadLetterDestination
identité Identité à utiliser lors des événements de lettres mortes. EventSubscriptionIdentity

DeadLetterDestination

Nom Description Valeur
endpointType Définir le type d’objet StorageBlob (obligatoire)

StorageBlobDeadLetterDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination des lettres mortes « StorageBlob » (obligatoire)
properties Propriétés de la destination des lettres mortes basées sur l’objet blob de stockage StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Nom Description Valeur
blobContainerName Nom du conteneur d’objets blob de stockage qui est la destination des événements deadletter string
resourceId ID de ressource Azure du compte de stockage qui est la destination des événements deadletter string

EventSubscriptionIdentity

Nom Description Valeur
type Type d’identité managée utilisée. Le type « SystemAssigned, UserAssigned » inclut à la fois une identité créée implicitement et un ensemble d’identités affectées par l’utilisateur. Le type « None » supprime toute identité. « SystemAssigned »
« UserAssigned »
userAssignedIdentity Identité de l’utilisateur associée à la ressource. string

DeliveryWithResourceIdentity

Nom Description Valeur
destination Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements.
Utilise l’identité de Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise ou de la mise en lettres mortes.
EventSubscriptionDestination
identité Identité à utiliser lors de la remise d’événements. EventSubscriptionIdentity

EventSubscriptionDestination

Nom Description Valeur
endpointType Définir le type d’objet AzureFunction
EventHub
HybridConnection
MonitorAlert
Espace de nomsTopic
PartnerDestination
ServiceBusQueue
ServiceBusTopic
StorageQueue
WebHook (obligatoire)

AzureFunctionEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. « AzureFunction » (obligatoire)
properties Propriétés de la 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 à un événement. string

DeliveryAttributeMapping

Nom Description Valeur
name Nom de l’attribut de remise ou de l’en-tête. string
type Définir le type d’objet Dynamique
Statique (obligatoire)

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

StaticDeliveryAttributeMapping

Nom Description Valeur
type Type de l’attribut de remise ou du nom d’en-tête. « Statique » (obligatoire)
properties Propriétés du mappage d’attributs de remise statique. StaticDeliveryAttributeMappingProperties

StaticDeliveryAttributeMappingProperties

Nom Description Valeur
isSecret Indicateur booléen pour indiquer si l’attribut contient des informations sensibles. bool
value Valeur de l’attribut de remise. string

EventHubEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. « EventHub » (obligatoire)
properties 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. string

HybridConnectionEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. « HybridConnection » (obligatoire)
properties Propriétés de la connexion hybride de la destination de l’abonnement aux événements. HybridConnectionEventSubscriptionDestinationProperti...

HybridConnectionEventSubscriptionDestinationProperti...

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

MonitorAlertEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. « MonitorAlert » (obligatoire)
properties Surveiller les propriétés d’alerte de la destination de l’abonnement aux événements. MonitorAlertEventSubscriptionDestinationProperties

MonitorAlertEventSubscriptionDestinationProperties

Nom Description Valeur
actionGroups Liste des ID ARM des groupes d’actions qui seront déclenchés sur chaque alerte déclenchée via cet abonnement aux événements.
Chaque ID ARM de ressource doit suivre ce modèle : /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Insights/actionGroups/{ActionGroupName}.
string[]
description Description qui sera attachée à chaque alerte déclenchée via cet abonnement aux événements. string
severity Gravité qui sera attachée à chaque alerte déclenchée via cet abonnement aux événements.
Ce champ doit être fourni.
« Sev0 »
« Sev1 »
« Sev2 »
« Sev3 »
« Sev4 »

NamespaceTopicEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. « NamespaceTopic » (obligatoire)
properties Propriétés de rubrique d’espace de noms de la destination de l’abonnement aux événements. NamespaceTopicEventSubscriptionDestinationProperties

NamespaceTopicEventSubscriptionDestinationProperties

Nom Description Valeur
resourceId ID de ressource Azure qui représente le point de terminaison de la destination de la rubrique d’espace de noms Event Grid d’un abonnement aux événements.
Ce champ est obligatoire et la ressource rubrique d’espace de noms répertoriée doit déjà exister.
L’ID ARM de ressource doit suivre ce modèle : /subscriptions/{AzureSubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.EventGrid/namespaces/{NamespaceName}/topics/{TopicName}.
string

PartnerEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. « PartnerDestination » (obligatoire)
properties Propriétés de destination partenaire de la destination de l’abonnement aux événements. PartnerEventSubscriptionDestinationProperties

PartnerEventSubscriptionDestinationProperties

Nom Description Valeur
resourceId ID de ressource Azure qui représente le point de terminaison d’une destination partenaire d’un abonnement aux événements. string

ServiceBusQueueEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. « ServiceBusQueue » (obligatoire)
properties Propriétés Service Bus de la destination de l’abonnement aux événements. ServiceBusQueueEventSubscriptionDestinationPropertie...

ServiceBusQueueEventSubscriptionDestinationPropertie...

Nom Description Valeur
deliveryAttributeMappings Détails de l’attribut de remise. DeliveryAttributeMapping[]
resourceId ID de ressource Azure qui représente le point de terminaison de la destination Service Bus d’un abonnement à un événement. string

ServiceBusTopicEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. « ServiceBusTopic » (obligatoire)
properties Propriétés de rubrique Service Bus de la destination de l’abonnement aux événements. ServiceBusTopicEventSubscriptionDestinationPropertie...

ServiceBusTopicEventSubscriptionDestinationPropertie...

Nom Description Valeur
deliveryAttributeMappings Détails de l’attribut de remise. DeliveryAttributeMapping[]
resourceId ID de ressource Azure qui représente le point de terminaison de la destination de rubrique Service Bus d’un abonnement à un événement. string

StorageQueueEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. « StorageQueue » (obligatoire)
properties Propriétés de la file d’attente de stockage de la destination de l’abonnement aux événements. StorageQueueEventSubscriptionDestinationProperties

StorageQueueEventSubscriptionDestinationProperties

Nom Description Valeur
queueMessageTimeToLiveInSeconds Durée de vie des messages de la file d’attente de stockage en secondes. Cette valeur ne peut pas être nulle ou négative, à l’exception de l’utilisation de -1 pour indiquer que la durée de vie du message est infinie. int
queueName Nom de la file d’attente de stockage sous un compte de stockage qui est la destination d’un abonnement aux événements. string
resourceId ID de ressource Azure du compte de stockage qui contient la file d’attente qui est la destination d’un abonnement aux événements. string

WebHookEventSubscriptionDestination

Nom Description Valeur
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. « WebHook » (obligatoire)
properties Propriétés webHook de la destination de l’abonnement aux événements. WebHookEventSubscriptionDestinationProperties

WebHookEventSubscriptionDestinationProperties

Nom Description Valeur
azureActiveDirectoryApplicationIdOrUri L’ID ou l’URI d’application Azure Active Directory pour obtenir le jeton d’accès qui sera inclus en tant que jeton du porteur dans les demandes de remise. string
azureActiveDirectoryTenantId ID de locataire Azure Active Directory pour obtenir le jeton d’accès qui sera inclus comme jeton du porteur dans les demandes de remise. string
deliveryAttributeMappings Détails de l’attribut de remise. DeliveryAttributeMapping[]
endpointUrl URL qui représente le point de terminaison de la destination d’un abonnement aux événements. string

Contraintes :
Valeur sensible. Passez en tant que paramètre sécurisé.
maxEventsPerBatch Nombre maximal d’événements par lot. int
minimumTlsVersionAllowed Version TLS minimale qui doit être prise en charge par le point de terminaison webhook "1.0"
"1.1"
"1.2"
preferredBatchSizeInKilobytes Taille de lot préférée en Kilo-octets. int

QueueInfo

Nom Description Valeur
deadLetterDestinationWithResourceIdentity Destination des lettres mortes de l’abonnement aux événements. Tout événement qui ne peut pas être remis à destination est envoyé à la destination des lettres mortes.
Utilise la configuration de l’identité managée sur la ressource parente (rubrique) pour acquérir les jetons d’authentification utilisés lors de la remise/de lettres mortes.
DeadLetterWithResourceIdentity
eventTimeToLive Durée de l’intervalle de temps au format ISO 8601 qui détermine la durée pendant laquelle les messages sont disponibles pour l’abonnement à partir du moment où le message a été publié.
Cette valeur de durée est exprimée au format suivant : 'P(n)Y(n)M(n)DT(n)H(n)M(n)S', où :
- (n) est remplacé par la valeur de chaque élément de temps qui suit le (n).
- P est l’identificateur de durée (ou de période) et est toujours placé au début de la durée.
- Y est l’identificateur d’année et suit la valeur du nombre d’années.
- M est l’identificateur de mois et suit la valeur du nombre de mois.
- W est l’identificateur de semaine et suit la valeur du nombre de semaines.
- D est l’identificateur de jour et suit la valeur du nombre de jours.
- T est l’identificateur de temps, et il précède les composants de temps.
- H est l’identificateur d’heure et suit la valeur du nombre d’heures.
- M est l’identificateur de minute et suit la valeur du nombre de minutes.
- S est le deuxième désignateur et suit la valeur du nombre de secondes.
Cette valeur de durée ne peut pas être supérieure à la valeur EventRetentionInDays de la rubrique. Il s’agit d’un champ facultatif où sa valeur minimale est 1 minute et sa valeur maximale est déterminée
par la valeur EventRetentionInDays de la rubrique. Voici des exemples de valeurs valides :
- « P0DT23H12M » ou « PT23H12M » : pour une durée de 23 heures et 12 minutes.
- « P1D » ou « P1DT0H0M0S » : pour une durée d'1 jour.
string
maxDeliveryCount Nombre maximal de remises des événements. int
receiveLockDurationInSeconds Période maximale en secondes pendant laquelle le message est reçu (par le client) et en attente d’acceptation, de libération ou de rejet.
Si ce temps s’est écoulé après qu’un message a été reçu par le client et qu’il n’a pas été converti en accepté (non traité), libéré ou rejeté,
le message est disponible pour redelivery. Il s’agit d’un champ facultatif, où la valeur par défaut est 60 secondes, la valeur minimale est 60 secondes et la valeur maximale est de 300 secondes.
int

FiltresConfiguration

Nom Description Valeur
filtres Tableau de filtres utilisés pour filtrer les abonnements aux événements. Filter[]
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 IncludedEventTypes sur null. string[]

Filtrer

Nom Description Valeur
key Champ/propriété dans l’événement en fonction duquel vous souhaitez filtrer. string
operatorType Définir le type d’objet BoolEquals
IsNotNull
IsNullOrUndefined
NumberGreaterThan
NumberGreaterThanOrEquals
NumberIn
NumberInRange
NumberLessThan
NumberLessThanOrEquals
NumberNotIn
NumberNotInRange
StringBeginsWith
StringContains
StringEndsWith
StringIn
StringNotBeginsWith
StringNotContains
StringNotEndsWith
StringNotIn (obligatoire)

BoolEqualsFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « BoolEquals » (obligatoire)
value Valeur de filtre booléen. bool

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)

NumberGreaterThanFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « NumberGreaterThan » (obligatoire)
value Valeur de filtre. int

NumberGreaterThanOrEqualsFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « NumberGreaterThanOrEquals » (obligatoire)
value Valeur de filtre. int

NumberInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « NumberIn » (obligatoire)
values Ensemble de valeurs de filtre. int[]

NumberInRangeFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « NumberInRange » (obligatoire)
values Ensemble de valeurs de filtre. int[][]

NumberLessThanFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « NumberLessThan » (obligatoire)
value Valeur de filtre. int

NumberLessThanOrEqualsFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « NumberLessThanOrEquals » (obligatoire)
value Valeur de filtre. int

NumberNotInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « NumberNotIn » (obligatoire)
values Ensemble de valeurs de filtre. int[]

NumberNotInRangeFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « NumberNotInRange » (obligatoire)
values Ensemble de valeurs de filtre. int[][]

StringBeginsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « StringBeginsWith » (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringContainsFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « StringContains » (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringEndsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple NumberIn, StringContains, BoolEquals et autres. « StringEndsWith » (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. « StringIn » (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotBeginsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. « StringNotBeginsWith » (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotContainsFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. « StringNotContains » (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotEndsWithFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. « StringNotEndsWith » (obligatoire)
values Ensemble de valeurs de filtre. string[]

StringNotInFilter

Nom Description Valeur
operatorType Type d’opérateur utilisé pour le filtrage, par exemple, NumberIn, StringContains, BoolEquals et autres. « StringNotIn » (obligatoire)
values Ensemble de valeurs de filtre. string[]