Microsoft.EventGrid eventSubscriptions 2020-06-01

Article
12/20/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@2020-06-01' = {
  scope: resourceSymbolicName or scope
  name: 'string'
  properties: {
    deadLetterDestination: {
      endpointType: 'string'
      // For remaining properties, see DeadLetterDestination objects
    }
    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
        }
      ]
      includedEventTypes: [
        'string'
      ]
      isSubjectCaseSensitive: bool
      subjectBeginsWith: 'string'
      subjectEndsWith: 'string'
    }
    labels: [
      'string'
    ]
    retryPolicy: {
      eventTimeToLiveInMinutes: int
      maxDeliveryAttempts: int
    }
  }
}

Objets DeadLetterDestination

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

Pour StorageBlob, utilisez :

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

Objets EventSubscriptionDestination

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

Pour AzureFunction, utilisez :

{
  endpointType: 'AzureFunction'
  properties: {
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
    resourceId: 'string'
  }
}

Pour EventHub, utilisez :

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

Pour HybridConnection, utilisez :

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

Pour ServiceBusQueue, utilisez :

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

Pour ServiceBusTopic, utilisez :

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

Pour StorageQueue, utilisez :

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

Pour WebHook, utilisez :

{
  endpointType: 'WebHook'
  properties: {
    azureActiveDirectoryApplicationIdOrUri: 'string'
    azureActiveDirectoryTenantId: 'string'
    endpointUrl: 'string'
    maxEventsPerBatch: int
    preferredBatchSizeInKilobytes: int
  }
}

Objets AdvancedFilter

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

Pour BoolEquals, utilisez :

{
  operatorType: 'BoolEquals'
  value: bool
}

Pour NumberGreaterThan, utilisez :

{
  operatorType: 'NumberGreaterThan'
  value: int
}

Pour NumberGreaterThanOrEquals, utilisez :

{
  operatorType: 'NumberGreaterThanOrEquals'
  value: int
}

Pour NumberIn, utilisez :

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

Pour NumberLessThan, utilisez :

{
  operatorType: 'NumberLessThan'
  value: int
}

Pour NumberLessThanOrEquals, utilisez :

{
  operatorType: 'NumberLessThanOrEquals'
  value: int
}

Pour NumberNotIn, utilisez :

{
  operatorType: 'NumberNotIn'
  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 stringNotIn, utilisez :

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

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 « NumberGreaterThan » pour le type NumberGreaterThanAdvancedFilter. Défini sur « NumberGreaterThanOrEquals » pour le type NumberGreaterThanOrEqualsAdvancedFilter. Défini sur « NumberIn » pour le type NumberInAdvancedFilter. 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 « 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 « StringNotIn » pour le type StringNotInAdvancedFilter.	'BoolEquals' 'NumberGreaterThan' 'NumberGreaterThanOrEquals' 'NumberIn' 'NumberLessThan' 'NumberLessThanOrEquals' 'NumberNotIn' 'StringBeginsWith' 'StringContains' 'StringEndsWith' 'StringIn' '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
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)

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

EventSubscriptionProperties

Nom	Description	Valeur
deadLetterDestination	Destination DeadLetter de l’abonnement à l’événement.	DeadLetterDestination
destination	Informations sur la destination où les événements doivent être remis pour l’abonnement aux événements.	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

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
resourceId	ID de ressource Azure d’une connexion hybride qui est la destination d’un abonnement aux événements.	corde