Microsoft.EventGrid eventSubscriptions

Définition de ressource Bicep

Le type de ressource eventSubscriptions est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la scope propriété sur cette ressource pour définir l’étendue de cette ressource. Consultez Définir l’étendue des ressources d’extension dans Bicep.

Le type de ressource 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/eventSubscriptions, ajoutez le Bicep suivant à votre modèle.

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview' = {
  name: 'string'
  scope: resourceSymbolicName
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    deadLetterWithResourceIdentity: {
      deadLetterDestination: {
        endpointType: 'string'
        // For remaining properties, see DeadLetterDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    eventDeliverySchema: 'string'
    expirationTimeUtc: 'string'
    filter: {
      advancedFilters: [
        {
          key: 'string'
          operatorType: 'string'
          // For remaining properties, see AdvancedFilter objects
        }
      ]
      enableAdvancedFilteringOnArrays: bool
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
    retryPolicy: {
      eventTimeToLiveInMinutes: int
      maxDeliveryAttempts: int
    }
  }
}

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

Objets AdvancedFilter

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

eventSubscriptions

Nom Description Valeur
name Nom de la ressource string (obligatoire)

Limite de caractères : 3-64

Caractères valides :
Caractères alphanumériques et traits d’union.
scope Utilisez lors de la création d’une ressource d’extension dans une étendue différente de l’étendue de déploiement. Ressource cible

Pour Bicep, définissez cette propriété sur le nom symbolique de la ressource pour appliquer la ressource d’extension.
properties Propriétés de l’abonnement aux événements. EventSubscriptionProperties

EventSubscriptionProperties

Nom Description Valeur
deadLetterDestination 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 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.
DeadLetterDestination
deadLetterWithResourceIdentity 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 (rubrique ou domaine) pour acquérir les jetons d’authentification utilisés lors de la remise ou de la 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
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
eventDeliverySchema Schéma de remise d’événements pour l’abonnement aux événements. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Heure d’expiration de l’abonnement aux événements. string
filter Informations sur le filtre de l’abonnement aux événements. EventSubscriptionFilter
étiquettes Liste des étiquettes définies par l’utilisateur. string[]
retryPolicy Stratégie de nouvelle tentative pour les événements. Cela peut être utilisé pour configurer le nombre maximal de tentatives de remise et la durée de vie des événements. RetryPolicy

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

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

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 aux événements. 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 la 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 Temps de message de la file d’attente de stockage à vivre 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 ID ou URI de l’application Azure Active Directory pour obtenir le jeton d’accès qui sera inclus comme 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 de webhook '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Taille de lot préférée en Kilo-octets. int

EventSubscriptionFilter

Nom Description Valeur
advancedFilters Tableau de filtres avancés utilisés pour filtrer les abonnements aux événements. AdvancedFilter[]
enableAdvancedFilteringOnArrays Permet d’évaluer les filtres avancés par rapport à un tableau de valeurs au lieu d’attendre une valeur unique. bool
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[]
isSubjectCaseSensitive Spécifie si les propriétés SubjectBeginsWith et SubjectEndsWith du filtre
doit être comparé de manière sensible à la casse.
bool
subjectBeginsWith Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un préfixe de chemin de ressource.
Le format de cela dépend de l’éditeur des événements.
Les caractères génériques ne sont pas pris en charge dans ce chemin.
string
subjectEndsWith Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un suffixe de chemin de ressource.
Les caractères génériques ne sont pas pris en charge dans ce chemin.
string

AdvancedFilter

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)

BoolEqualsAdvancedFilter

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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[]

NumberInRangeAdvancedFilter

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[][]

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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[]

NumberNotInRangeAdvancedFilter

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[][]

StringBeginsWithAdvancedFilter

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[]

StringContainsAdvancedFilter

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[]

StringEndsWithAdvancedFilter

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[]

StringInAdvancedFilter

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[]

StringNotBeginsWithAdvancedFilter

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[]

StringNotContainsAdvancedFilter

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[]

StringNotEndsWithAdvancedFilter

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[]

StringNotInAdvancedFilter

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[]

RetryPolicy

Nom Description Valeur
eventTimeToLiveInMinutes Durée de vie (en minutes) pour les événements. int
maxDeliveryAttempts Nombre maximal de tentatives de remise pour les événements. int

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Créer Azure Event Grid rubrique personnalisée et un abonnement

Déployer sur Azure
Crée un Azure Event Grid rubrique personnalisée et un abonnement webhook. Modèle créé à l’origine par John Downs.
Rubrique/abonnement Azure Event Grid personnalisé avec CloudEvents

Déployer sur Azure
Crée une rubrique de Azure Event Grid personnalisée, un abonnement webhook avec un schéma CloudEvents et une application logique en tant que gestionnaire d’événements. Modèle créé à l’origine par Justin Yoo.
Créer une rubrique personnalisée Event Grid et un gestionnaire de hub d’événements

Déployer sur Azure
Crée un Azure Event Grid rubrique personnalisée et un hub d’événements pour gérer les événements.
Créer un abonnement Event Grid pour les événements de ressources

Déployer sur Azure
Crée un abonnement Event Grid pour un groupe de ressources ou un abonnement Azure.
Créer Azure Event Grid abonnement à une rubrique personnalisée et à une file d’attente

Déployer sur Azure
Crée un Azure Event Grid rubrique personnalisée et un abonnement à la file d’attente Service Bus. Modèle créé à l’origine par Markus Meyer.
Créer Azure Event Grid abonnement à une rubrique personnalisée

Déployer sur Azure
Crée un Azure Event Grid rubrique personnalisée et un abonnement à une rubrique Service Bus. Modèle créé à l’origine par Markus Meyer.

Définition de ressources de modèle ARM

Le type de ressource eventSubscriptions est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la scope propriété sur cette ressource pour définir l’étendue de cette ressource. Consultez Définir l’étendue des ressources d’extension dans les modèles ARM.

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

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/eventSubscriptions, ajoutez le code JSON suivant à votre modèle.

{
  "type": "Microsoft.EventGrid/eventSubscriptions",
  "apiVersion": "2023-12-15-preview",
  "name": "string",
  "scope": "string",
  "properties": {
    "deadLetterDestination": {
      "endpointType": "string"
      // For remaining properties, see DeadLetterDestination objects
    },
    "deadLetterWithResourceIdentity": {
      "deadLetterDestination": {
        "endpointType": "string"
        // For remaining properties, see DeadLetterDestination objects
      },
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "deliveryWithResourceIdentity": {
      "destination": {
        "endpointType": "string"
        // For remaining properties, see EventSubscriptionDestination objects
      },
      "identity": {
        "type": "string",
        "userAssignedIdentity": "string"
      }
    },
    "destination": {
      "endpointType": "string"
      // For remaining properties, see EventSubscriptionDestination objects
    },
    "eventDeliverySchema": "string",
    "expirationTimeUtc": "string",
    "filter": {
      "advancedFilters": [
        {
          "key": "string",
          "operatorType": "string"
          // For remaining properties, see AdvancedFilter objects
        }
      ],
      "enableAdvancedFilteringOnArrays": "bool",
      "includedEventTypes": [ "string" ],
      "isSubjectCaseSensitive": "bool",
      "subjectBeginsWith": "string",
      "subjectEndsWith": "string"
    },
    "labels": [ "string" ],
    "retryPolicy": {
      "eventTimeToLiveInMinutes": "int",
      "maxDeliveryAttempts": "int"
    }
  }
}

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

Objets AdvancedFilter

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

eventSubscriptions

Nom Description Valeur
type Type de ressource 'Microsoft.EventGrid/eventSubscriptions'
apiVersion Version de l’API de ressource '2023-12-15-preview'
name Nom de la ressource string (obligatoire)

Limite de caractères : 3-64

Caractères valides :
Caractères alphanumériques et traits d’union.
scope Utilisez lors de la création d’une ressource d’extension dans une étendue différente de l’étendue de déploiement. Ressource cible

Pour JSON, définissez la valeur sur le nom complet de la ressource à laquelle appliquer la ressource d’extension .
properties Propriétés de l’abonnement aux événements. EventSubscriptionProperties

EventSubscriptionProperties

Nom Description Valeur
deadLetterDestination 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 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.
DeadLetterDestination
deadLetterWithResourceIdentity 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, rubrique ou domaine) 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
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
eventDeliverySchema Schéma de remise d’événements pour l’abonnement aux événements. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Heure d’expiration de l’abonnement aux événements. string
filter Informations sur le filtre de l’abonnement aux événements. EventSubscriptionFilter
étiquettes Liste des étiquettes définies par l’utilisateur. string[]
retryPolicy Stratégie de nouvelle tentative pour les événements. Cela peut être utilisé pour configurer le nombre maximal de tentatives de remise et la durée de vie des événements. RetryPolicy

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

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

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 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 aux événements. 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 la 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 Temps de message de la file d’attente de stockage à vivre 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 ID ou URI de l’application Azure Active Directory pour obtenir le jeton d’accès qui sera inclus comme 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 de webhook '1.0'
'1.1'
'1.2'
preferredBatchSizeInKilobytes Taille de lot préférée en Kilo-octets. int

EventSubscriptionFilter

Nom Description Valeur
advancedFilters Tableau de filtres avancés utilisés pour filtrer les abonnements aux événements. AdvancedFilter[]
enableAdvancedFilteringOnArrays Permet d’évaluer les filtres avancés par rapport à un tableau de valeurs au lieu d’attendre une valeur unique. bool
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[]
isSubjectCaseSensitive Spécifie si les propriétés SubjectBeginsWith et SubjectEndsWith du filtre
doit être comparé de manière sensible à la casse.
bool
subjectBeginsWith Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un préfixe de chemin de ressource.
Le format de cela dépend de l’éditeur des événements.
Les caractères génériques ne sont pas pris en charge dans ce chemin.
string
subjectEndsWith Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un suffixe de chemin de ressource.
Les caractères génériques ne sont pas pris en charge dans ce chemin.
string

AdvancedFilter

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)

BoolEqualsAdvancedFilter

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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[]

NumberInRangeAdvancedFilter

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[][]

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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[]

NumberNotInRangeAdvancedFilter

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[][]

StringBeginsWithAdvancedFilter

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[]

StringContainsAdvancedFilter

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[]

StringEndsWithAdvancedFilter

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[]

StringInAdvancedFilter

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[]

StringNotBeginsWithAdvancedFilter

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[]

StringNotContainsAdvancedFilter

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[]

StringNotEndsWithAdvancedFilter

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[]

StringNotInAdvancedFilter

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[]

RetryPolicy

Nom Description Valeur
eventTimeToLiveInMinutes Durée de vie (en minutes) des événements. int
maxDeliveryAttempts Nombre maximal de tentatives de remise pour les événements. int

Modèles de démarrage rapide

Les modèles de démarrage rapide suivants déploient ce type de ressource.

Modèle Description
Créer Azure Event Grid rubrique personnalisée et un abonnement

Déployer sur Azure
Crée un Azure Event Grid rubrique personnalisée et un abonnement webhook. Modèle créé à l’origine par John Downs.
Rubrique/abonnement de Azure Event Grid personnalisé avec CloudEvents

Déployer sur Azure
Crée une rubrique de Azure Event Grid personnalisée, un abonnement webhook avec un schéma CloudEvents et une application logique en tant que gestionnaire d’événements. Modèle créé à l’origine par Justin Yoo.
Créer une rubrique personnalisée Event Grid et un gestionnaire de hub d’événements

Déployer sur Azure
Crée un Azure Event Grid rubrique personnalisée et un hub d’événements pour gérer les événements.
Créer un abonnement Event Grid pour les événements de ressource

Déployer sur Azure
Crée un abonnement Event Grid pour un groupe de ressources ou un abonnement Azure.
Créer Azure Event Grid abonnement de rubrique et de file d’attente personnalisé

Déployer sur Azure
Crée un Azure Event Grid rubrique personnalisée et un abonnement de file d’attente Service Bus. Modèle créé à l’origine par Markus Meyer.
Créer Azure Event Grid abonnement à une rubrique personnalisée

Déployer sur Azure
Crée un Azure Event Grid rubrique personnalisée et un abonnement à une rubrique Service Bus. Modèle créé à l’origine par Markus Meyer.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource eventSubscriptions est une ressource d’extension, ce qui signifie que vous pouvez l’appliquer à une autre ressource.

Utilisez la parent_id propriété sur cette ressource pour définir l’étendue de cette ressource.

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

  • Groupes de ressources
  • Abonnements

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/eventSubscriptions, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      deadLetterDestination = {
        endpointType = "string"
        // For remaining properties, see DeadLetterDestination objects
      }
      deadLetterWithResourceIdentity = {
        deadLetterDestination = {
          endpointType = "string"
          // For remaining properties, see DeadLetterDestination objects
        }
        identity = {
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      deliveryWithResourceIdentity = {
        destination = {
          endpointType = "string"
          // For remaining properties, see EventSubscriptionDestination objects
        }
        identity = {
          type = "string"
          userAssignedIdentity = "string"
        }
      }
      destination = {
        endpointType = "string"
        // For remaining properties, see EventSubscriptionDestination objects
      }
      eventDeliverySchema = "string"
      expirationTimeUtc = "string"
      filter = {
        advancedFilters = [
          {
            key = "string"
            operatorType = "string"
            // For remaining properties, see AdvancedFilter objects
          }
        ]
        enableAdvancedFilteringOnArrays = bool
        includedEventTypes = [
          "string"
        ]
        isSubjectCaseSensitive = bool
        subjectBeginsWith = "string"
        subjectEndsWith = "string"
      }
      labels = [
        "string"
      ]
      retryPolicy = {
        eventTimeToLiveInMinutes = int
        maxDeliveryAttempts = int
      }
    }
  })
}

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

Objets AdvancedFilter

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

eventSubscriptions

Nom Description Valeur
type Type de ressource « Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview »
name Nom de la ressource string (obligatoire)

Limite de caractères : 3-64

Caractères valides :
Caractères alphanumériques et traits d’union.
parent_id ID de la ressource à laquelle appliquer cette ressource d’extension. string (obligatoire)
properties Propriétés de l’abonnement aux événements. EventSubscriptionProperties

EventSubscriptionProperties

Nom Description Valeur
deadLetterDestination 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 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.
DeadLetterDestination
deadLetterWithResourceIdentity 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, rubrique ou domaine) 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
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
eventDeliverySchema Schéma de remise d’événements pour l’abonnement aux événements. « CloudEventSchemaV1_0 »
« CustomInputSchema »
« EventGridSchema »
expirationTimeUtc Heure d’expiration de l’abonnement aux événements. string
filter Informations sur le filtre de l’abonnement aux événements. EventSubscriptionFilter
étiquettes Liste des étiquettes définies par l’utilisateur. string[]
retryPolicy Stratégie de nouvelle tentative pour les événements. Cela peut être utilisé pour configurer le nombre maximal de tentatives de remise et la durée de vie des événements. RetryPolicy

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

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

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

EventSubscriptionFilter

Nom Description Valeur
advancedFilters Tableau de filtres avancés utilisés pour filtrer les abonnements aux événements. AdvancedFilter[]
enableAdvancedFilteringOnArrays Permet aux filtres avancés d’être évalués par rapport à un tableau de valeurs au lieu d’attendre une valeur unique. bool
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[]
isSubjectCaseSensitive Spécifie si les propriétés SubjectBeginsWith et SubjectEndsWith du filtre
doit être comparé de manière sensible à la casse.
bool
subjectBeginsWith Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un préfixe de chemin de ressource.
Le format de cela dépend de l’éditeur des événements.
Les caractères génériques ne sont pas pris en charge dans ce chemin.
string
subjectEndsWith Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un suffixe de chemin de ressource.
Les caractères génériques ne sont pas pris en charge dans ce chemin.
string

AdvancedFilter

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)

BoolEqualsAdvancedFilter

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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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[]

NumberInRangeAdvancedFilter

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[][]

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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[]

NumberNotInRangeAdvancedFilter

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[][]

StringBeginsWithAdvancedFilter

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[]

StringContainsAdvancedFilter

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[]

StringEndsWithAdvancedFilter

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[]

StringInAdvancedFilter

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[]

StringNotBeginsWithAdvancedFilter

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[]

StringNotContainsAdvancedFilter

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[]

StringNotEndsWithAdvancedFilter

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[]

StringNotInAdvancedFilter

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[]

RetryPolicy

Nom Description Valeur
eventTimeToLiveInMinutes Durée de vie (en minutes) des événements. int
maxDeliveryAttempts Nombre maximal de tentatives de remise pour les événements. int