Partager via


Microsoft.EventGrid eventSubscriptions 2023-12-15-preview

Définition de ressource Bicep

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

For a list of changed properties in each API version, see change log.

Resource format

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

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

DeadLetterDestination objects

Set the endpointType property to specify the type of object.

For StorageBlob, use:

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

AdvancedFilter objects

Set the operatorType property to specify the type of object.

For BoolEquals, use:

{
  operatorType: 'BoolEquals'
  value: bool
}

For IsNotNull, use:

{
  operatorType: 'IsNotNull'
}

For IsNullOrUndefined, use:

{
  operatorType: 'IsNullOrUndefined'
}

For NumberGreaterThan, use:

{
  operatorType: 'NumberGreaterThan'
  value: int
}

For NumberGreaterThanOrEquals, use:

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

For NumberIn, use:

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

For NumberInRange, use:

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

For NumberLessThan, use:

{
  operatorType: 'NumberLessThan'
  value: int
}

For NumberLessThanOrEquals, use:

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

For NumberNotIn, use:

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

For NumberNotInRange, use:

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

For StringBeginsWith, use:

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

For StringContains, use:

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

For StringEndsWith, use:

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

For StringIn, use:

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

For StringNotBeginsWith, use:

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

For StringNotContains, use:

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

For StringNotEndsWith, use:

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

For StringNotIn, use:

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

EventSubscriptionDestination objects

Set the endpointType property to specify the type of object.

For AzureFunction, use:

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

For EventHub, use:

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

For HybridConnection, use:

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

For MonitorAlert, use:

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

For NamespaceTopic, use:

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

For PartnerDestination, use:

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

For ServiceBusQueue, use:

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

For ServiceBusTopic, use:

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

For StorageQueue, use:

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

For WebHook, use:

{
  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    deliveryAttributeMappings: [
      {
        name: 'string'
        type: 'string'
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl: 'string'
    maxEventsPerBatch: int
    minimumTlsVersionAllowed: 'string'
    preferredBatchSizeInKilobytes: int
  }
}

DeliveryAttributeMapping objects

Set the type property to specify the type of object.

For Dynamic, use:

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

For Static, use:

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

Property Values

Microsoft.EventGrid/eventSubscriptions

Name Description Value
name Nom de la ressource string (required)
properties Propriétés de l’abonnement aux événements. EventSubscriptionProperties
scope Utilisez-la lors de la création d’une ressource dans une étendue différente de l’étendue de déploiement. Set this property to the symbolic name of a resource to apply the extension resource.

AdvancedFilter

Name Description Value
key Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer. string
operatorType Set to 'BoolEquals' for type BoolEqualsAdvancedFilter. Set to 'IsNotNull' for type IsNotNullAdvancedFilter. Set to 'IsNullOrUndefined' for type IsNullOrUndefinedAdvancedFilter. Set to 'NumberGreaterThan' for type NumberGreaterThanAdvancedFilter. Set to 'NumberGreaterThanOrEquals' for type NumberGreaterThanOrEqualsAdvancedFilter. Set to 'NumberIn' for type NumberInAdvancedFilter. Set to 'NumberInRange' for type NumberInRangeAdvancedFilter. Set to 'NumberLessThan' for type NumberLessThanAdvancedFilter. Set to 'NumberLessThanOrEquals' for type NumberLessThanOrEqualsAdvancedFilter. Set to 'NumberNotIn' for type NumberNotInAdvancedFilter. Set to 'NumberNotInRange' for type NumberNotInRangeAdvancedFilter. Set to 'StringBeginsWith' for type StringBeginsWithAdvancedFilter. Set to 'StringContains' for type StringContainsAdvancedFilter. Set to 'StringEndsWith' for type StringEndsWithAdvancedFilter. Set to 'StringIn' for type StringInAdvancedFilter. Set to 'StringNotBeginsWith' for type StringNotBeginsWithAdvancedFilter. Set to 'StringNotContains' for type StringNotContainsAdvancedFilter. Set to 'StringNotEndsWith' for type StringNotEndsWithAdvancedFilter. Set to 'StringNotIn' for type StringNotInAdvancedFilter. 'BoolEquals'
'IsNotNull'
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (required)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

DeadLetterDestination

Name Description Value
endpointType Set to 'StorageBlob' for type StorageBlobDeadLetterDestination. 'StorageBlob' (required)

DeadLetterWithResourceIdentity

Name Description Value
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 la lettre morte.
DeadLetterDestination
identity Identité à utiliser lors des événements de lettres mortes. EventSubscriptionIdentity

DeliveryAttributeMapping

Name Description Value
name Nom de l’attribut ou de l’en-tête de remise. string
type Set to 'Dynamic' for type DynamicDeliveryAttributeMapping. Set to 'Static' for type StaticDeliveryAttributeMapping. 'Dynamic'
'Static' (required)

DeliveryWithResourceIdentity

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

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Name Description Value
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

EventSubscriptionDestination

Name Description Value
endpointType Set to 'AzureFunction' for type AzureFunctionEventSubscriptionDestination. Set to 'EventHub' for type EventHubEventSubscriptionDestination. Set to 'HybridConnection' for type HybridConnectionEventSubscriptionDestination. Set to 'MonitorAlert' for type MonitorAlertEventSubscriptionDestination. Set to 'NamespaceTopic' for type NamespaceTopicEventSubscriptionDestination. Set to 'PartnerDestination' for type PartnerEventSubscriptionDestination. Set to 'ServiceBusQueue' for type ServiceBusQueueEventSubscriptionDestination. Set to 'ServiceBusTopic' for type ServiceBusTopicEventSubscriptionDestination. Set to 'StorageQueue' for type StorageQueueEventSubscriptionDestination. Set to 'WebHook' for type WebHookEventSubscriptionDestination. 'AzureFunction'
'EventHub'
'HybridConnection'
'MonitorAlert'
'NamespaceTopic'
'PartnerDestination'
'ServiceBusQueue'
'ServiceBusTopic'
'StorageQueue'
'WebHook' (required)

EventSubscriptionFilter

Name Description Value
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 singulière. 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 les 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 d’accès aux ressources.
Le format de ce paramètre dépend de l’éditeur des événements.
Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès.
string
subjectEndsWith Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un suffixe de chemin d’accès aux ressources.
Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès.
string

EventSubscriptionIdentity

Name Description Value
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

EventSubscriptionProperties

Name Description Value
deadLetterDestination Destination de la lettre morte de l’abonnement à l’événement. Tout événement qui ne peut pas être remis à sa destination est envoyé à la destination de la lettre morte.
Utilise l’identité d’Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/lettres mortes.
DeadLetterDestination
deadLetterWithResourceIdentity Destination de la lettre morte de l’abonnement à l’événement. Tout événement qui ne peut pas être remis à sa destination est envoyé à la destination de la lettre morte.
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 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 (à savoir, rubrique ou domaine) pour acquérir les jetons d’authentification utilisés lors de la remise/ 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é d’Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/lettres mortes.
EventSubscriptionDestination
eventDeliverySchema Schéma de remise d’événements pour l’abonnement aux événements. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Délai d’expiration de l’abonnement à l’événement. string
filter Informations sur le filtre de l’abonnement aux événements. EventSubscriptionFilter
labels 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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

Name Description Value
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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

MonitorAlertEventSubscriptionDestination

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

MonitorAlertEventSubscriptionDestinationProperties

Name Description Value
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 d’é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 d’événements. string
severity Gravité qui sera attachée à chaque alerte déclenchée par le biais de cet abonnement d’événements.
Ce champ doit être fourni.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

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

NamespaceTopicEventSubscriptionDestinationProperties

Name Description Value
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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination

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

PartnerEventSubscriptionDestinationProperties

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

RetryPolicy

Name Description Value
eventTimeToLiveInMinutes Time To Live (en minutes) pour les événements. int
maxDeliveryAttempts Nombre maximal de tentatives de remise pour les événements. int

ServiceBusQueueEventSubscriptionDestination

Name Description Value
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'ServiceBusQueue' (required)
properties Propriétés Service Bus de la destination de l’abonnement aux événements. ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

Name Description Value
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

Name Description Value
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'ServiceBusTopic' (required)
properties Propriétés de la rubrique Service Bus de la destination de l’abonnement aux événements. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Name Description Value
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 aux événements. string

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

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

StorageBlobDeadLetterDestination

Name Description Value
endpointType Type du point de terminaison pour la destination de lettre morte 'StorageBlob' (required)
properties Propriétés de la destination du deadletter basé sur les objets blob de stockage StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Name Description Value
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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

Name Description Value
queueMessageTimeToLiveInSeconds Durée de vie des messages de file d’attente du stockage en secondes. Cette valeur ne peut pas être nulle ou négative à l’exception de l’utilisation de -1 pour indiquer que le temps de vie du message est Infini. 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

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter

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

StringNotInAdvancedFilter

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri ID d’application Azure Active Directory ou URI 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 en tant que 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 à un événement. string

Constraints:
Sensitive value. 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

Usage Examples

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Bicep File Description
Créer une rubrique personnalisée Azure Event Grid et un abonnement file d’attente Crée une rubrique personnalisée Azure Event Grid et un abonnement de file d’attente Service Bus. Modèle créé à l’origine par Markus Meyer.
Créer une rubrique et un abonnement personnalisés Azure Event Grid Crée une rubrique personnalisée Azure Event Grid et un abonnement webhook. Modèle créé à l’origine par John Downs.

Définition de ressource de modèle ARM

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

For a list of changed properties in each API version, see change log.

Resource format

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

DeadLetterDestination objects

Set the endpointType property to specify the type of object.

For StorageBlob, use:

{
  "endpointType": "StorageBlob",
  "properties": {
    "blobContainerName": "string",
    "resourceId": "string"
  }
}

AdvancedFilter objects

Set the operatorType property to specify the type of object.

For BoolEquals, use:

{
  "operatorType": "BoolEquals",
  "value": "bool"
}

For IsNotNull, use:

{
  "operatorType": "IsNotNull"
}

For IsNullOrUndefined, use:

{
  "operatorType": "IsNullOrUndefined"
}

For NumberGreaterThan, use:

{
  "operatorType": "NumberGreaterThan",
  "value": "int"
}

For NumberGreaterThanOrEquals, use:

{
  "operatorType": "NumberGreaterThanOrEquals",
  "value": "int"
}

For NumberIn, use:

{
  "operatorType": "NumberIn",
  "values": [ "int" ]
}

For NumberInRange, use:

{
  "operatorType": "NumberInRange",
  "values": [
    [ "int" ]
  ]
}

For NumberLessThan, use:

{
  "operatorType": "NumberLessThan",
  "value": "int"
}

For NumberLessThanOrEquals, use:

{
  "operatorType": "NumberLessThanOrEquals",
  "value": "int"
}

For NumberNotIn, use:

{
  "operatorType": "NumberNotIn",
  "values": [ "int" ]
}

For NumberNotInRange, use:

{
  "operatorType": "NumberNotInRange",
  "values": [
    [ "int" ]
  ]
}

For StringBeginsWith, use:

{
  "operatorType": "StringBeginsWith",
  "values": [ "string" ]
}

For StringContains, use:

{
  "operatorType": "StringContains",
  "values": [ "string" ]
}

For StringEndsWith, use:

{
  "operatorType": "StringEndsWith",
  "values": [ "string" ]
}

For StringIn, use:

{
  "operatorType": "StringIn",
  "values": [ "string" ]
}

For StringNotBeginsWith, use:

{
  "operatorType": "StringNotBeginsWith",
  "values": [ "string" ]
}

For StringNotContains, use:

{
  "operatorType": "StringNotContains",
  "values": [ "string" ]
}

For StringNotEndsWith, use:

{
  "operatorType": "StringNotEndsWith",
  "values": [ "string" ]
}

For StringNotIn, use:

{
  "operatorType": "StringNotIn",
  "values": [ "string" ]
}

EventSubscriptionDestination objects

Set the endpointType property to specify the type of object.

For AzureFunction, use:

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

For EventHub, use:

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

For HybridConnection, use:

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

For MonitorAlert, use:

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

For NamespaceTopic, use:

{
  "endpointType": "NamespaceTopic",
  "properties": {
    "resourceId": "string"
  }
}

For PartnerDestination, use:

{
  "endpointType": "PartnerDestination",
  "properties": {
    "resourceId": "string"
  }
}

For ServiceBusQueue, use:

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

For ServiceBusTopic, use:

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

For StorageQueue, use:

{
  "endpointType": "StorageQueue",
  "properties": {
    "queueMessageTimeToLiveInSeconds": "int",
    "queueName": "string",
    "resourceId": "string"
  }
}

For WebHook, use:

{
  "endpointType": "WebHook",
  "properties": {
    "azureActiveDirectoryApplicationIdOrUri": "string",
    "azureActiveDirectoryTenantId": "string",
    "deliveryAttributeMappings": [ {
      "name": "string",
      "type": "string"
      // For remaining properties, see DeliveryAttributeMapping objects
    } ],
    "endpointUrl": "string",
    "maxEventsPerBatch": "int",
    "minimumTlsVersionAllowed": "string",
    "preferredBatchSizeInKilobytes": "int"
  }
}

DeliveryAttributeMapping objects

Set the type property to specify the type of object.

For Dynamic, use:

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

For Static, use:

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

Property Values

Microsoft.EventGrid/eventSubscriptions

Name Description Value
apiVersion Version de l’API '2023-12-15-preview'
name Nom de la ressource string (required)
properties Propriétés de l’abonnement aux événements. EventSubscriptionProperties
type Type de ressource 'Microsoft.EventGrid/eventSubscriptions'

AdvancedFilter

Name Description Value
key Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer. string
operatorType Set to 'BoolEquals' for type BoolEqualsAdvancedFilter. Set to 'IsNotNull' for type IsNotNullAdvancedFilter. Set to 'IsNullOrUndefined' for type IsNullOrUndefinedAdvancedFilter. Set to 'NumberGreaterThan' for type NumberGreaterThanAdvancedFilter. Set to 'NumberGreaterThanOrEquals' for type NumberGreaterThanOrEqualsAdvancedFilter. Set to 'NumberIn' for type NumberInAdvancedFilter. Set to 'NumberInRange' for type NumberInRangeAdvancedFilter. Set to 'NumberLessThan' for type NumberLessThanAdvancedFilter. Set to 'NumberLessThanOrEquals' for type NumberLessThanOrEqualsAdvancedFilter. Set to 'NumberNotIn' for type NumberNotInAdvancedFilter. Set to 'NumberNotInRange' for type NumberNotInRangeAdvancedFilter. Set to 'StringBeginsWith' for type StringBeginsWithAdvancedFilter. Set to 'StringContains' for type StringContainsAdvancedFilter. Set to 'StringEndsWith' for type StringEndsWithAdvancedFilter. Set to 'StringIn' for type StringInAdvancedFilter. Set to 'StringNotBeginsWith' for type StringNotBeginsWithAdvancedFilter. Set to 'StringNotContains' for type StringNotContainsAdvancedFilter. Set to 'StringNotEndsWith' for type StringNotEndsWithAdvancedFilter. Set to 'StringNotIn' for type StringNotInAdvancedFilter. 'BoolEquals'
'IsNotNull'
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (required)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

DeadLetterDestination

Name Description Value
endpointType Set to 'StorageBlob' for type StorageBlobDeadLetterDestination. 'StorageBlob' (required)

DeadLetterWithResourceIdentity

Name Description Value
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 la lettre morte.
DeadLetterDestination
identity Identité à utiliser lors des événements de lettres mortes. EventSubscriptionIdentity

DeliveryAttributeMapping

Name Description Value
name Nom de l’attribut ou de l’en-tête de remise. string
type Set to 'Dynamic' for type DynamicDeliveryAttributeMapping. Set to 'Static' for type StaticDeliveryAttributeMapping. 'Dynamic'
'Static' (required)

DeliveryWithResourceIdentity

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

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Name Description Value
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

EventSubscriptionDestination

Name Description Value
endpointType Set to 'AzureFunction' for type AzureFunctionEventSubscriptionDestination. Set to 'EventHub' for type EventHubEventSubscriptionDestination. Set to 'HybridConnection' for type HybridConnectionEventSubscriptionDestination. Set to 'MonitorAlert' for type MonitorAlertEventSubscriptionDestination. Set to 'NamespaceTopic' for type NamespaceTopicEventSubscriptionDestination. Set to 'PartnerDestination' for type PartnerEventSubscriptionDestination. Set to 'ServiceBusQueue' for type ServiceBusQueueEventSubscriptionDestination. Set to 'ServiceBusTopic' for type ServiceBusTopicEventSubscriptionDestination. Set to 'StorageQueue' for type StorageQueueEventSubscriptionDestination. Set to 'WebHook' for type WebHookEventSubscriptionDestination. 'AzureFunction'
'EventHub'
'HybridConnection'
'MonitorAlert'
'NamespaceTopic'
'PartnerDestination'
'ServiceBusQueue'
'ServiceBusTopic'
'StorageQueue'
'WebHook' (required)

EventSubscriptionFilter

Name Description Value
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 singulière. 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 les 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 d’accès aux ressources.
Le format de ce paramètre dépend de l’éditeur des événements.
Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès.
string
subjectEndsWith Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un suffixe de chemin d’accès aux ressources.
Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès.
string

EventSubscriptionIdentity

Name Description Value
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

EventSubscriptionProperties

Name Description Value
deadLetterDestination Destination de la lettre morte de l’abonnement à l’événement. Tout événement qui ne peut pas être remis à sa destination est envoyé à la destination de la lettre morte.
Utilise l’identité d’Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/lettres mortes.
DeadLetterDestination
deadLetterWithResourceIdentity Destination de la lettre morte de l’abonnement à l’événement. Tout événement qui ne peut pas être remis à sa destination est envoyé à la destination de la lettre morte.
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 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 (à savoir, rubrique ou domaine) pour acquérir les jetons d’authentification utilisés lors de la remise/ 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é d’Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/lettres mortes.
EventSubscriptionDestination
eventDeliverySchema Schéma de remise d’événements pour l’abonnement aux événements. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Délai d’expiration de l’abonnement à l’événement. string
filter Informations sur le filtre de l’abonnement aux événements. EventSubscriptionFilter
labels 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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

Name Description Value
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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

MonitorAlertEventSubscriptionDestination

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

MonitorAlertEventSubscriptionDestinationProperties

Name Description Value
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 d’é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 d’événements. string
severity Gravité qui sera attachée à chaque alerte déclenchée par le biais de cet abonnement d’événements.
Ce champ doit être fourni.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

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

NamespaceTopicEventSubscriptionDestinationProperties

Name Description Value
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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination

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

PartnerEventSubscriptionDestinationProperties

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

RetryPolicy

Name Description Value
eventTimeToLiveInMinutes Time To Live (en minutes) pour les événements. int
maxDeliveryAttempts Nombre maximal de tentatives de remise pour les événements. int

ServiceBusQueueEventSubscriptionDestination

Name Description Value
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'ServiceBusQueue' (required)
properties Propriétés Service Bus de la destination de l’abonnement aux événements. ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

Name Description Value
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

Name Description Value
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'ServiceBusTopic' (required)
properties Propriétés de la rubrique Service Bus de la destination de l’abonnement aux événements. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Name Description Value
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 aux événements. string

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

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

StorageBlobDeadLetterDestination

Name Description Value
endpointType Type du point de terminaison pour la destination de lettre morte 'StorageBlob' (required)
properties Propriétés de la destination du deadletter basé sur les objets blob de stockage StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Name Description Value
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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

Name Description Value
queueMessageTimeToLiveInSeconds Durée de vie des messages de file d’attente du stockage en secondes. Cette valeur ne peut pas être nulle ou négative à l’exception de l’utilisation de -1 pour indiquer que le temps de vie du message est Infini. 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

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter

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

StringNotInAdvancedFilter

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri ID d’application Azure Active Directory ou URI 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 en tant que 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 à un événement. string

Constraints:
Sensitive value. 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

Usage Examples

Modèles de démarrage rapide Azure

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

Template Description
Créer une rubrique personnalisée Azure Event Grid et un abonnement file d’attente

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

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

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

Déployer sur Azure
Crée une rubrique personnalisée Azure Event Grid 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 à un groupe de ressources ou à un abonnement Azure.
Rubrique/abonnement Azure Event Grid personnalisé avec CloudEvents

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

Définition de ressource Terraform (fournisseur AzAPI)

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

For a list of changed properties in each API version, see change log.

Resource format

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

DeadLetterDestination objects

Set the endpointType property to specify the type of object.

For StorageBlob, use:

{
  endpointType = "StorageBlob"
  properties = {
    blobContainerName = "string"
    resourceId = "string"
  }
}

AdvancedFilter objects

Set the operatorType property to specify the type of object.

For BoolEquals, use:

{
  operatorType = "BoolEquals"
  value = bool
}

For IsNotNull, use:

{
  operatorType = "IsNotNull"
}

For IsNullOrUndefined, use:

{
  operatorType = "IsNullOrUndefined"
}

For NumberGreaterThan, use:

{
  operatorType = "NumberGreaterThan"
  value = int
}

For NumberGreaterThanOrEquals, use:

{
  operatorType = "NumberGreaterThanOrEquals"
  value = int
}

For NumberIn, use:

{
  operatorType = "NumberIn"
  values = [
    int
  ]
}

For NumberInRange, use:

{
  operatorType = "NumberInRange"
  values = [
    [
      int
    ]
  ]
}

For NumberLessThan, use:

{
  operatorType = "NumberLessThan"
  value = int
}

For NumberLessThanOrEquals, use:

{
  operatorType = "NumberLessThanOrEquals"
  value = int
}

For NumberNotIn, use:

{
  operatorType = "NumberNotIn"
  values = [
    int
  ]
}

For NumberNotInRange, use:

{
  operatorType = "NumberNotInRange"
  values = [
    [
      int
    ]
  ]
}

For StringBeginsWith, use:

{
  operatorType = "StringBeginsWith"
  values = [
    "string"
  ]
}

For StringContains, use:

{
  operatorType = "StringContains"
  values = [
    "string"
  ]
}

For StringEndsWith, use:

{
  operatorType = "StringEndsWith"
  values = [
    "string"
  ]
}

For StringIn, use:

{
  operatorType = "StringIn"
  values = [
    "string"
  ]
}

For StringNotBeginsWith, use:

{
  operatorType = "StringNotBeginsWith"
  values = [
    "string"
  ]
}

For StringNotContains, use:

{
  operatorType = "StringNotContains"
  values = [
    "string"
  ]
}

For StringNotEndsWith, use:

{
  operatorType = "StringNotEndsWith"
  values = [
    "string"
  ]
}

For StringNotIn, use:

{
  operatorType = "StringNotIn"
  values = [
    "string"
  ]
}

EventSubscriptionDestination objects

Set the endpointType property to specify the type of object.

For AzureFunction, use:

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

For EventHub, use:

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

For HybridConnection, use:

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

For MonitorAlert, use:

{
  endpointType = "MonitorAlert"
  properties = {
    actionGroups = [
      "string"
    ]
    description = "string"
    severity = "string"
  }
}

For NamespaceTopic, use:

{
  endpointType = "NamespaceTopic"
  properties = {
    resourceId = "string"
  }
}

For PartnerDestination, use:

{
  endpointType = "PartnerDestination"
  properties = {
    resourceId = "string"
  }
}

For ServiceBusQueue, use:

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

For ServiceBusTopic, use:

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

For StorageQueue, use:

{
  endpointType = "StorageQueue"
  properties = {
    queueMessageTimeToLiveInSeconds = int
    queueName = "string"
    resourceId = "string"
  }
}

For WebHook, use:

{
  endpointType = "WebHook"
  properties = {
    azureActiveDirectoryApplicationIdOrUri = "string"
    azureActiveDirectoryTenantId = "string"
    deliveryAttributeMappings = [
      {
        name = "string"
        type = "string"
        // For remaining properties, see DeliveryAttributeMapping objects
      }
    ]
    endpointUrl = "string"
    maxEventsPerBatch = int
    minimumTlsVersionAllowed = "string"
    preferredBatchSizeInKilobytes = int
  }
}

DeliveryAttributeMapping objects

Set the type property to specify the type of object.

For Dynamic, use:

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

For Static, use:

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

Property Values

Microsoft.EventGrid/eventSubscriptions

Name Description Value
name Nom de la ressource string (required)
parent_id ID de la ressource à laquelle appliquer cette ressource d’extension. string (required)
properties Propriétés de l’abonnement aux événements. EventSubscriptionProperties
type Type de ressource "Microsoft.EventGrid/eventSubscriptions@2023-12-15-preview"

AdvancedFilter

Name Description Value
key Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer. string
operatorType Set to 'BoolEquals' for type BoolEqualsAdvancedFilter. Set to 'IsNotNull' for type IsNotNullAdvancedFilter. Set to 'IsNullOrUndefined' for type IsNullOrUndefinedAdvancedFilter. Set to 'NumberGreaterThan' for type NumberGreaterThanAdvancedFilter. Set to 'NumberGreaterThanOrEquals' for type NumberGreaterThanOrEqualsAdvancedFilter. Set to 'NumberIn' for type NumberInAdvancedFilter. Set to 'NumberInRange' for type NumberInRangeAdvancedFilter. Set to 'NumberLessThan' for type NumberLessThanAdvancedFilter. Set to 'NumberLessThanOrEquals' for type NumberLessThanOrEqualsAdvancedFilter. Set to 'NumberNotIn' for type NumberNotInAdvancedFilter. Set to 'NumberNotInRange' for type NumberNotInRangeAdvancedFilter. Set to 'StringBeginsWith' for type StringBeginsWithAdvancedFilter. Set to 'StringContains' for type StringContainsAdvancedFilter. Set to 'StringEndsWith' for type StringEndsWithAdvancedFilter. Set to 'StringIn' for type StringInAdvancedFilter. Set to 'StringNotBeginsWith' for type StringNotBeginsWithAdvancedFilter. Set to 'StringNotContains' for type StringNotContainsAdvancedFilter. Set to 'StringNotEndsWith' for type StringNotEndsWithAdvancedFilter. Set to 'StringNotIn' for type StringNotInAdvancedFilter. 'BoolEquals'
'IsNotNull'
'IsNullOrUndefined'
'NumberGreaterThan'
'NumberGreaterThanOrEquals'
'NumberIn'
'NumberInRange'
'NumberLessThan'
'NumberLessThanOrEquals'
'NumberNotIn'
'NumberNotInRange'
'StringBeginsWith'
'StringContains'
'StringEndsWith'
'StringIn'
'StringNotBeginsWith'
'StringNotContains'
'StringNotEndsWith'
'StringNotIn' (required)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

DeadLetterDestination

Name Description Value
endpointType Set to 'StorageBlob' for type StorageBlobDeadLetterDestination. 'StorageBlob' (required)

DeadLetterWithResourceIdentity

Name Description Value
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 la lettre morte.
DeadLetterDestination
identity Identité à utiliser lors des événements de lettres mortes. EventSubscriptionIdentity

DeliveryAttributeMapping

Name Description Value
name Nom de l’attribut ou de l’en-tête de remise. string
type Set to 'Dynamic' for type DynamicDeliveryAttributeMapping. Set to 'Static' for type StaticDeliveryAttributeMapping. 'Dynamic'
'Static' (required)

DeliveryWithResourceIdentity

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

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

Name Description Value
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

EventSubscriptionDestination

Name Description Value
endpointType Set to 'AzureFunction' for type AzureFunctionEventSubscriptionDestination. Set to 'EventHub' for type EventHubEventSubscriptionDestination. Set to 'HybridConnection' for type HybridConnectionEventSubscriptionDestination. Set to 'MonitorAlert' for type MonitorAlertEventSubscriptionDestination. Set to 'NamespaceTopic' for type NamespaceTopicEventSubscriptionDestination. Set to 'PartnerDestination' for type PartnerEventSubscriptionDestination. Set to 'ServiceBusQueue' for type ServiceBusQueueEventSubscriptionDestination. Set to 'ServiceBusTopic' for type ServiceBusTopicEventSubscriptionDestination. Set to 'StorageQueue' for type StorageQueueEventSubscriptionDestination. Set to 'WebHook' for type WebHookEventSubscriptionDestination. 'AzureFunction'
'EventHub'
'HybridConnection'
'MonitorAlert'
'NamespaceTopic'
'PartnerDestination'
'ServiceBusQueue'
'ServiceBusTopic'
'StorageQueue'
'WebHook' (required)

EventSubscriptionFilter

Name Description Value
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 singulière. 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 les 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 d’accès aux ressources.
Le format de ce paramètre dépend de l’éditeur des événements.
Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès.
string
subjectEndsWith Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un suffixe de chemin d’accès aux ressources.
Les caractères génériques ne sont pas pris en charge dans ce chemin d’accès.
string

EventSubscriptionIdentity

Name Description Value
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

EventSubscriptionProperties

Name Description Value
deadLetterDestination Destination de la lettre morte de l’abonnement à l’événement. Tout événement qui ne peut pas être remis à sa destination est envoyé à la destination de la lettre morte.
Utilise l’identité d’Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/lettres mortes.
DeadLetterDestination
deadLetterWithResourceIdentity Destination de la lettre morte de l’abonnement à l’événement. Tout événement qui ne peut pas être remis à sa destination est envoyé à la destination de la lettre morte.
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 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 (à savoir, rubrique ou domaine) pour acquérir les jetons d’authentification utilisés lors de la remise/ 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é d’Azure Event Grid pour acquérir les jetons d’authentification utilisés lors de la remise/lettres mortes.
EventSubscriptionDestination
eventDeliverySchema Schéma de remise d’événements pour l’abonnement aux événements. 'CloudEventSchemaV1_0'
'CustomInputSchema'
'EventGridSchema'
expirationTimeUtc Délai d’expiration de l’abonnement à l’événement. string
filter Informations sur le filtre de l’abonnement aux événements. EventSubscriptionFilter
labels 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

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

Name Description Value
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

IsNotNullAdvancedFilter

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

IsNullOrUndefinedAdvancedFilter

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

MonitorAlertEventSubscriptionDestination

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

MonitorAlertEventSubscriptionDestinationProperties

Name Description Value
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 d’é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 d’événements. string
severity Gravité qui sera attachée à chaque alerte déclenchée par le biais de cet abonnement d’événements.
Ce champ doit être fourni.
'Sev0'
'Sev1'
'Sev2'
'Sev3'
'Sev4'

NamespaceTopicEventSubscriptionDestination

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

NamespaceTopicEventSubscriptionDestinationProperties

Name Description Value
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

NumberGreaterThanAdvancedFilter

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

NumberGreaterThanOrEqualsAdvancedFilter

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

NumberInAdvancedFilter

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

NumberInRangeAdvancedFilter

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

NumberLessThanAdvancedFilter

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

NumberLessThanOrEqualsAdvancedFilter

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

NumberNotInAdvancedFilter

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

NumberNotInRangeAdvancedFilter

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

PartnerEventSubscriptionDestination

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

PartnerEventSubscriptionDestinationProperties

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

RetryPolicy

Name Description Value
eventTimeToLiveInMinutes Time To Live (en minutes) pour les événements. int
maxDeliveryAttempts Nombre maximal de tentatives de remise pour les événements. int

ServiceBusQueueEventSubscriptionDestination

Name Description Value
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'ServiceBusQueue' (required)
properties Propriétés Service Bus de la destination de l’abonnement aux événements. ServiceBusQueueEventSubscriptionDestinationProperties

ServiceBusQueueEventSubscriptionDestinationProperties

Name Description Value
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

Name Description Value
endpointType Type du point de terminaison pour la destination de l’abonnement aux événements. 'ServiceBusTopic' (required)
properties Propriétés de la rubrique Service Bus de la destination de l’abonnement aux événements. ServiceBusTopicEventSubscriptionDestinationProperties

ServiceBusTopicEventSubscriptionDestinationProperties

Name Description Value
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 aux événements. string

StaticDeliveryAttributeMapping

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

StaticDeliveryAttributeMappingProperties

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

StorageBlobDeadLetterDestination

Name Description Value
endpointType Type du point de terminaison pour la destination de lettre morte 'StorageBlob' (required)
properties Propriétés de la destination du deadletter basé sur les objets blob de stockage StorageBlobDeadLetterDestinationProperties

StorageBlobDeadLetterDestinationProperties

Name Description Value
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

StorageQueueEventSubscriptionDestination

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

StorageQueueEventSubscriptionDestinationProperties

Name Description Value
queueMessageTimeToLiveInSeconds Durée de vie des messages de file d’attente du stockage en secondes. Cette valeur ne peut pas être nulle ou négative à l’exception de l’utilisation de -1 pour indiquer que le temps de vie du message est Infini. 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

StringBeginsWithAdvancedFilter

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

StringContainsAdvancedFilter

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

StringEndsWithAdvancedFilter

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

StringInAdvancedFilter

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

StringNotBeginsWithAdvancedFilter

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

StringNotContainsAdvancedFilter

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

StringNotEndsWithAdvancedFilter

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

StringNotInAdvancedFilter

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

WebHookEventSubscriptionDestination

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

WebHookEventSubscriptionDestinationProperties

Name Description Value
azureActiveDirectoryApplicationIdOrUri ID d’application Azure Active Directory ou URI 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 en tant que 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 à un événement. string

Constraints:
Sensitive value. 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