az eventgrid topic event-subscription
Gérer les abonnements aux événements de la rubrique.
Commandes
Nom | Description | Type | État |
---|---|---|---|
az eventgrid topic event-subscription create |
Créez un abonnement à un événement pour une rubrique. |
Core | GA |
az eventgrid topic event-subscription delete |
Supprimez un abonnement à un événement d’une rubrique. |
Core | GA |
az eventgrid topic event-subscription list |
Répertorier les abonnements aux événements d’une rubrique spécifique. |
Core | GA |
az eventgrid topic event-subscription show |
Obtenez les détails d’un abonnement aux événements d’une rubrique. |
Core | GA |
az eventgrid topic event-subscription update |
Mettez à jour un abonnement aux événements d’une rubrique. |
Core | GA |
az eventgrid topic event-subscription create
Créez un abonnement à un événement pour une rubrique.
az eventgrid topic event-subscription create --name
--resource-group
--topic-name
[--aad-app-id]
[--aad-tenant-id]
[--advanced-filter]
[--deadletter-endpoint]
[--delivery-attribute-mapping]
[--enable-advanced-filtering-on-arrays {false, true}]
[--endpoint]
[--endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
[--event-delivery-schema {cloudeventschemav1_0, custominputschema, eventgridschema}]
[--event-ttl]
[--expiration-date]
[--included-event-types]
[--labels]
[--max-delivery-attempts]
[--max-events-per-batch]
[--pref-batch-size-kb]
[--qttl]
[--subject-begins-with]
[--subject-case-sensitive {false, true}]
[--subject-ends-with]
Exemples
Créez un abonnement aux événements pour une rubrique Event Grid à l’aide de filtres par défaut.
az eventgrid topic event-subscription create --name es1 \
-g rg1 --topic-name topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
Créez un abonnement aux événements pour une rubrique Event Grid, avec un filtre spécifiant un préfixe d’objet.
az eventgrid topic event-subscription create --name es4 \
-g rg1 --topic-name topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \
--subject-begins-with mysubject_prefix
Créez un abonnement aux événements pour une rubrique Event Grid, en utilisant des filtres par défaut et CloudEvent V 1.0 comme schéma de remise.
az eventgrid topic event-subscription create -n es2 \
-g rg1 --topic-name topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \
--event-delivery-schema cloudeventschemav1_0
Créez un abonnement aux événements pour une rubrique Event Grid, avec une stratégie de nouvelle tentative et une stratégie de nouvelle tentative personnalisée de 10 tentatives de remise maximales et une durée de vie d’événement de 2 heures (selon la date d’expiration) et la date d’expiration.
az eventgrid topic event-subscription create --name es2 \
-g rg1 --topic-name topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code \
--deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/s2/blobServices/default/containers/blobcontainer1 \
--max-delivery-attempts 10 --event-ttl 120 --expiration-date "2022-10-31"
Créez un abonnement aux événements pour une rubrique Event Grid à l’aide du Webhook activé par Azure Active Directory comme destination.
az eventgrid topic event-subscription create --name es1 \
-g rg1 --topic-name topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
--azure-active-directory-tenant-id azureactivedirectorytenantid
--azure-active-directory-application-id-or-uri azureactivedirectoryapplicationidoruri
Créez un abonnement aux événements pour une rubrique Event Grid à l’aide d’Azure Function en tant que destination.
az eventgrid topic event-subscription create -n es1 \
-g rg1 --topic-name topic1 \
--endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction
Créer un abonnement aux événements pour une rubrique Event Grid à l’aide de Stockage File d’attente en tant que destination avec une durée de vie de 5 minutes
az eventgrid topic event-subscription create -n es1 \
-g rg1 --topic-name topic1 \
--endpoint-type storagequeue \
--endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/queueservices/default/queues/q1 \
--storage-queue-msg-ttl 300
Créer un abonnement aux événements pour une rubrique Event Grid et activer le filtrage avancé sur les tableaux
az eventgrid topic event-subscription create -n es1 \
-g rg1 --topic-name topic1 \
--endpoint /subscriptions/{SubID}/resourceGroups/{RG}/providers/Microsoft.Web/sites/{functionappname}/functions/{functionname} --endpoint-type azurefunction \
--enable-advanced-filtering-on-arrays true
Paramètres obligatoires
Nom de l’abonnement aux événements.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom de la rubrique.
Paramètres facultatifs
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. Applicable uniquement pour le webhook comme destination.
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. Applicable uniquement pour le webhook comme destination.
Un filtre avancé permet de filtrer les événements en fonction d’une propriété d’événement spécifique.
Utilisation : --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALUE [VALUE ...] StringIn : --advanced-filter data. Color StringIn Blue Red Orange Yellow StringNotIn : --advanced-filter data. Color StringNotIn Blue Red Orange StringContains: --advanced-filter subject StringContains Blue Red StringNotContains: --advanced-filter subject StringNotContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWithsWith : --advanced-filter subject StringNotBeginsWith Blue Red StringEndsWith : --advanced-filter subject StringEndsWith img png jpg StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png numberIn : --advanced-filter data.property1 NumberIn 5 10 20 NumberInRange --advanced-filter data.property1 NumberInRange 5,10 20,30 40,50 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberNotInRange : --advanced-filter data.property2 NumberNotInInRange 100 110 200 210 300 310 NumberLessThan : --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals : --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan : --advanced-filter data.property3 NumberGreaterThan 100 NumberGreaterThanOrEquals : --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true IsNullOrUndefined : --advanced-filter data.property3 IsNullOrUndefined IsNotNull : --advanced-filter data.property3 IsNotNull Plusieurs filtres avancés peuvent être spécifiés à l’aide de plusieurs --advanced-filter
arguments.
ID de ressource Azure d’une destination de conteneur d’objets blob Stockage Azure où EventGrid doit annuler la remise des événements pour cet abonnement d’événements.
Exemple : --deadletter-endpoint /subscriptions/{SubID}/resourceGroups/rg1/providers/Microsoft. Stockage/storageAccounts/sa1/blobServices/default/containers/containerName.
Ajoutez le mappage d’attributs de remise pour envoyer des informations supplémentaires via des en-têtes HTTP lors de la remise d’événements. Cet attribut est valide pour tous les types de destination, sauf Stockage Queue. Plusieurs attributs peuvent être spécifiés à l’aide --delivery-attribute-mapping
de plusieurs arguments.
Utilisation : --delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret] Mappage d’attribut statique : --delivery-attribute-mapping somename static somevalue Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue false Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping dynamic somevalue both Static and Dynamic: -- delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.
Permet aux filtres avancés d’être évalués par rapport à un tableau de valeurs au lieu d’attendre une valeur singulière.
Point de terminaison où EventGrid doit remettre des événements correspondant à cet abonnement d’événements. Pour le type de point de terminaison webhook, il doit s’agir de l’URL de webhook correspondante. Pour les autres types de points de terminaison, il doit s’agir de l’identificateur de ressource Azure du point de terminaison. Il est prévu que le point de terminaison de destination soit déjà créé et disponible pour une utilisation avant d’exécuter une commande Event Grid.
Type du point de terminaison de destination.
Schéma dans lequel les événements doivent être remis pour cet abonnement d’événements. Par défaut, les événements sont remis dans le même schéma dans lequel ils sont publiés (en fonction du schéma d’entrée de la rubrique correspondante).
Heure de vie de l’événement (en minutes). Doit être un nombre compris entre 1 et 1440.
Date ou datetime (en UTC, par exemple « 2018-11-30T11:59:59+00:00 » ou « 2018-11-30 ») après quoi l’abonnement à l’événement expire. Par défaut, il n’y a pas d’expiration pour l’abonnement à l’événement.
Liste séparée par l’espace des types d’événements (par exemple, Microsoft.Stockage. BlobCreated et Microsoft. Stockage. BlobDeleted). Pour vous abonner à tous les types d’événements par défaut, ne spécifiez aucune valeur pour cet argument. Pour les rubriques Event Grid, les types d’événements sont définis par le client. Pour les événements Azure, par exemple, Stockage Comptes, IoT Hub, etc., vous pouvez interroger leurs types d’événements à l’aide de cette commande CLI « az eventgrid topic-type list-event-types ».
Liste d’étiquettes séparées par un espace à associer à cet abonnement d’événements.
Nombre maximal de tentatives de remise. Doit être un nombre compris entre 1 et 30.
Nombre maximal d’événements dans un lot. Doit être un nombre compris entre 1 et 5000.
Taille de lot préférée en kilo-octets. Doit être un nombre compris entre 1 et 1024.
Stockage délai de vie des messages de file d’attente en secondes.
Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un préfixe. Les caractères génériques ne sont pas pris en charge.
Spécifiez pour indiquer si les champs d’objet doivent être comparés de manière sensible à la casse. True si l’indicateur est présent.
Chaîne facultative pour filtrer les événements d’un abonnement aux événements en fonction d’un suffixe. Les caractères génériques ne sont pas pris en charge.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az eventgrid topic event-subscription delete
Supprimez un abonnement à un événement d’une rubrique.
az eventgrid topic event-subscription delete --name
--resource-group
--topic-name
[--yes]
Exemples
Supprimez un abonnement aux événements pour une rubrique Event Grid.
az eventgrid topic event-subscription delete --name es1 \
-g rg1 --topic-name topic1 \
Paramètres obligatoires
Nom de l’abonnement aux événements.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom de la rubrique.
Paramètres facultatifs
Ne pas demander de confirmation.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az eventgrid topic event-subscription list
Répertorier les abonnements aux événements d’une rubrique spécifique.
az eventgrid topic event-subscription list --resource-group
--topic-name
[--odata-query]
Exemples
Répertoriez tous les abonnements aux événements créés pour une rubrique Event Grid.
az eventgrid topic event-subscription list -g rg1 --topic-name topic1
Paramètres obligatoires
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom de la rubrique.
Paramètres facultatifs
Requête OData utilisée pour filtrer les résultats de la liste. Le filtrage est actuellement autorisé uniquement sur la propriété Name. Les opérations prises en charge sont les suivantes : CONTAINS, eq (pour égal), ne (pour pas égal), AND, OR et NOT.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az eventgrid topic event-subscription show
Obtenez les détails d’un abonnement aux événements d’une rubrique.
az eventgrid topic event-subscription show --name
--resource-group
--topic-name
[--full-ed-url {false, true}]
[--include-attrib-secret {false, true}]
Exemples
Affichez les détails d’un abonnement aux événements pour une rubrique Event Grid.
az eventgrid topic event-subscription show --name es1 \
-g rg1 --topic-name topic1
Afficher les détails d’un abonnement aux événements d’une rubrique Event Grid inclut tous les secrets d’attribut de remise statique.
az eventgrid topic event-subscription show --name es1 \
-g rg1 --topic-name topic1 --include-attrib-secret
Paramètres obligatoires
Nom de l’abonnement aux événements.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom de la rubrique.
Paramètres facultatifs
Spécifiez pour indiquer si l’URL de point de terminaison complète doit être retournée. True si l’indicateur est présent.
Indiquez si des secrets d’attribut de remise statique doivent être retournés. True si l’indicateur est présent.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
az eventgrid topic event-subscription update
Mettez à jour un abonnement aux événements d’une rubrique.
az eventgrid topic event-subscription update --name
--resource-group
--topic-name
[--advanced-filter]
[--deadletter-endpoint]
[--delivery-attribute-mapping]
[--enable-advanced-filtering-on-arrays {false, true}]
[--endpoint]
[--included-event-types]
[--labels]
[--qttl]
[--subject-begins-with]
[--subject-ends-with]
[--update-endpoint-type {azurefunction, eventhub, hybridconnection, servicebusqueue, servicebustopic, storagequeue, webhook}]
Exemples
Mettez à jour un abonnement aux événements d’une rubrique Event Grid pour spécifier un nouveau point de terminaison.
az eventgrid topic event-subscription update --name es1 \
-g rg1 --topic-name topic1 --endpoint https://contoso.azurewebsites.net/api/f1?code=code
Mettez à jour un abonnement aux événements d’une rubrique Event Grid pour spécifier un nouveau filtre de fin d’objet.
az eventgrid topic event-subscription update --name es2 \
-g rg1 --topic-name topic1 \
--subject-ends-with .jpg
Mettez à jour un abonnement aux événements d’une rubrique Event Grid pour spécifier un nouveau point de terminaison et un nouveau sujet se termine par filtrer une nouvelle liste de types d’événements inclus.
az eventgrid topic event-subscription update --name es3 \
-g rg1 --topic-name topic1 \
--subject-ends-with .png \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
--included-event-types Microsoft.Storage.BlobCreated Microsoft.Storage.BlobDeleted
Mettez à jour un abonnement aux événements pour une rubrique Azure Event Grid afin d’inclure une destination deadletter.
az eventgrid topic event-subscription update --name es2 \
-g rg1 --topic-name topic1 \
--deadletter-endpoint /subscriptions/{SubID}/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/sa1/blobServices/default/containers/blobcontainer1
Mettez à jour un abonnement aux événements pour une rubrique Azure Event Grid à l’aide de filtres avancés.
az eventgrid topic event-subscription update --name es3 \
-g rg1 --topic-name topic1 \
--endpoint https://contoso.azurewebsites.net/api/f1?code=code
--advanced-filter data.blobType StringIn BlockBlob
--advanced-filter data.url StringBeginsWith https://myaccount.blob.core.windows.net
Mettre à jour un abonnement aux événements pour une rubrique Event Grid avec Stockage File d’attente comme destination avec une durée de vie de 5 minutes
az eventgrid topic event-subscription update -n es1 \
-g rg1 --topic-name topic1 \
--storage-queue-msg-ttl 300
Mettre à jour un abonnement aux événements pour une rubrique Event Grid avec filtrage avancé sur les tableaux activés
az eventgrid topic event-subscription update -n es1 \
-g rg1 --topic-name topic1 \
--enable-advanced-filtering-on-arrays true
Paramètres obligatoires
Nom de l’abonnement aux événements.
Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>
.
Nom de la rubrique.
Paramètres facultatifs
Un filtre avancé permet de filtrer les événements en fonction d’une propriété d’événement spécifique.
Utilisation : --advanced-filter KEY[. INNERKEY] FILTEROPERATOR VALUE [VALUE ...] StringIn : --advanced-filter data. Color StringIn Blue Red Orange Yellow StringNotIn : --advanced-filter data. Color StringNotIn Blue Red Orange StringContains: --advanced-filter subject StringContains Blue Red StringNotContains: --advanced-filter subject StringNotContains Blue Red StringBeginsWith: --advanced-filter subject StringBeginsWithsWith : --advanced-filter subject StringNotBeginsWith Blue Red StringEndsWith : --advanced-filter subject StringEndsWith img png jpg StringNotEndsWith: --advanced-filter subject StringNotEndsWith img png numberIn : --advanced-filter data.property1 NumberIn 5 10 20 NumberInRange --advanced-filter data.property1 NumberInRange 5,10 20,30 40,50 NumberNotIn: --advanced-filter data.property2 NumberNotIn 100 200 300 NumberNotInRange : --advanced-filter data.property2 NumberNotInInRange 100 110 200 210 300 310 NumberLessThan : --advanced-filter data.property3 NumberLessThan 100 NumberLessThanOrEquals : --advanced-filter data.property2 NumberLessThanOrEquals 100 NumberGreaterThan : --advanced-filter data.property3 NumberGreaterThan 100 NumberGreaterThanOrEquals : --advanced-filter data.property2 NumberGreaterThanOrEquals 100 BoolEquals: --advanced-filter data.property3 BoolEquals true IsNullOrUndefined : --advanced-filter data.property3 IsNullOrUndefined IsNotNull : --advanced-filter data.property3 IsNotNull Plusieurs filtres avancés peuvent être spécifiés à l’aide de plusieurs --advanced-filter
arguments.
ID de ressource Azure d’une destination de conteneur d’objets blob Stockage Azure où EventGrid doit annuler la remise des événements pour cet abonnement d’événements.
Ajoutez le mappage d’attributs de remise pour envoyer des informations supplémentaires via des en-têtes HTTP lors de la remise d’événements. Cet attribut est valide pour tous les types de destination, sauf Stockage Queue. Plusieurs attributs peuvent être spécifiés à l’aide --delivery-attribute-mapping
de plusieurs arguments.
Utilisation : --delivery-attribute-mapping attribute-name attribute-type attribute-value [attribute-is-secret] Mappage d’attribut statique : --delivery-attribute-mapping somename static somevalue Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue false Static Attribute Mapping: --delivery-attribute-mapping somename static somevalue true Dynamic Attribute Mapping: --delivery-attribute-mapping dynamic somevalue both Static and Dynamic: -- delivery-attribute-mapping somename dynamic somevalue --delivery-attribute-mapping somename2 static somevalue.
Permet aux filtres avancés d’être évalués par rapport à un tableau de valeurs au lieu d’attendre une valeur singulière.
Point de terminaison où EventGrid doit remettre des événements correspondant à cet abonnement d’événements. Pour le type de point de terminaison webhook, il doit s’agir de l’URL de webhook correspondante. Pour les autres types de points de terminaison, il doit s’agir de l’identificateur de ressource Azure du point de terminaison. Il est prévu que le point de terminaison de destination soit déjà créé et disponible pour une utilisation avant d’exécuter une commande Event Grid.
Liste séparée par l’espace des types d’événements (par exemple, Microsoft.Stockage. BlobCreated et Microsoft. Stockage. BlobDeleted). Pour vous abonner à tous les types d’événements par défaut, ne spécifiez aucune valeur pour cet argument. Pour les rubriques Event Grid, les types d’événements sont définis par le client. Pour les événements Azure, par exemple, Stockage Comptes, IoT Hub, etc., vous pouvez interroger leurs types d’événements à l’aide de cette commande CLI « az eventgrid topic-type list-event-types ».
Liste d’étiquettes séparées par un espace à associer à cet abonnement d’événements.
Stockage délai de vie des messages de file d’attente en secondes.
Chaîne facultative permettant de filtrer les événements d’un abonnement aux événements en fonction d’un préfixe. Les caractères génériques ne sont pas pris en charge.
Chaîne facultative pour filtrer les événements d’un abonnement aux événements en fonction d’un suffixe. Les caractères génériques ne sont pas pris en charge.
Type du point de terminaison de destination.
Paramètres globaux
Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.
Affichez ce message d’aide et quittez.
Afficher uniquement les erreurs, en supprimant les avertissements.
Format de sortie.
Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.
Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID
.
Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour