Microsoft.EventGrid eventSubscriptions

Article
12/16/2024

Définition de ressource 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 de l’API, consultez journal des modifications.

Format de ressource

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

resource symbolicname 'Microsoft.EventGrid/eventSubscriptions@2024-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: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    deliveryWithResourceIdentity: {
      destination: {
        endpointType: 'string'
        // For remaining properties, see EventSubscriptionDestination objects
      }
      identity: {
        federatedIdentityCredentialInfo: {
          federatedClientId: 'string'
        }
        type: 'string'
        userAssignedIdentity: 'string'
      }
    }
    destination: {
      endpointType: 'string'
      // For remaining properties, see EventSubscriptionDestination objects
    }
    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 DeliveryAttributeMapping

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

Pour dynamique, utilisez :

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

Pour statique, utilisez :

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

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

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

Valeurs de propriété

AdvancedFilter

Nom	Description	Valeur
clé	Champ/propriété dans l’événement en fonction de laquelle vous souhaitez filtrer.	corde
operatorType	Défini sur « BoolEquals » pour le type BoolEqualsAdvancedFilter. Défini sur « IsNotNull » pour le type IsNotNullAdvancedFilter. Défini sur « IsNullOrUndefined » pour le type IsNullOrUndefinedAdvancedFilter. Défini sur « NumberGreaterThan » pour le type NumberGreaterThanAdvancedFilter. Défini sur « NumberGreaterThanOrEquals » pour le type NumberGreaterThanOrEqualsAdvancedFilter. Défini sur « NumberIn » pour le type NumberInAdvancedFilter. Défini sur « NumberInRange » pour le type NumberInRangeAdvancedFilter. Défini sur « NumberLessThan » pour le type NumberLessThanAdvancedFilter. Défini sur « NumberLessThanOrEquals » pour le type NumberLessThanOrEqualsAdvancedFilter. Défini sur « NumberNotIn » pour le type NumberNotInAdvancedFilter. Défini sur « NumberNotInRange » pour le type NumberNotInRangeAdvancedFilter. Défini sur « StringBeginsWith » pour le type StringBeginsWithAdvancedFilter. Défini sur « StringContains » pour le type StringContainsAdvancedFilter. Défini sur « StringEndsWith » pour le type StringEndsWithAdvancedFilter. Défini sur « StringIn » pour le type StringInAdvancedFilter. Défini sur « StringNotBeginsWith » pour le type StringNotBeginsWithAdvancedFilter. Défini sur « StringNotContains » pour le type StringNotContainsAdvancedFilter. Défini sur « StringNotEndsWith » pour le type StringNotEndsWithAdvancedFilter. Défini sur « StringNotIn » pour le type StringNotInAdvancedFilter.	'BoolEquals' 'IsNotNull' 'IsNullOrUndefined' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberInRange' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'NumberNotInRange' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' 'StringNotBeginsWith' 'StringNotContains' 'StringNotEndsWith' 'StringNotIn' (obligatoire)

AzureFunctionEventSubscriptionDestination

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

AzureFunctionEventSubscriptionDestinationProperties

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

BoolEqualsAdvancedFilter

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

DeadLetterDestination

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

DeadLetterWithResourceIdentity

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

DeliveryAttributeMapping

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

DeliveryWithResourceIdentity

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

DynamicDeliveryAttributeMapping

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

DynamicDeliveryAttributeMappingProperties

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

EventHubEventSubscriptionDestination

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

EventHubEventSubscriptionDestinationProperties

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

EventSubscriptionDestination

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

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

EventSubscriptionIdentity

Nom	Description	Valeur
federatedIdentityCredentialInfo	Détails des informations d’identification de l’identité fédérée (FIC) utilisées avec la remise des ressources.	FederatedIdentityCredentialInfo
type	Type d’identité managée utilisée. Peut être « SystemAssigned » ou « UserAssigned ».	'SystemAssigned' 'UserAssigned'
userAssignedIdentity	Identité de l’utilisateur associée à la ressource.	corde

EventSubscriptionProperties

Nom	Description	Valeur
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.	corde
filtre	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

FederatedIdentityCredentialInfo

Nom	Description	Valeur
federatedClientId	Application AAD mutualisée avec laquelle les informations d’identification d’identité fédérée (FIC) sont associées.	corde Contraintes: Longueur minimale = 36 Longueur maximale = 36 Modèle = `^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$` (obligatoire)

HybridConnectionEventSubscriptionDestination

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

HybridConnectionEventSubscriptionDestinationProperties

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

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)