Partager via


az eventgrid namespace topic event-subscription

Remarque

Cette référence fait partie de l’extension eventgrid pour Azure CLI (version 2.51.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une commande event-subscription de rubrique d’espace de noms az eventgrid. En savoir plus sur les extensions.

Le groupe de commandes « az eventgrid namespace topic » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Gérer l’abonnement aux événements de rubrique d’espace de noms eventgrid.

Commandes

Nom Description Type État
az eventgrid namespace topic event-subscription create

Créez un abonnement aux événements d’une rubrique d’espace de noms.

Extension Aperçu
az eventgrid namespace topic event-subscription delete

Supprimez un abonnement à un événement existant d’une rubrique d’espace de noms.

Extension Aperçu
az eventgrid namespace topic event-subscription list

Répertorier les abonnements aux événements appartenant à une rubrique d’espace de noms spécifique.

Extension Aperçu
az eventgrid namespace topic event-subscription show

Afficher un abonnement aux événements d’une rubrique d’espace de noms.

Extension Aperçu
az eventgrid namespace topic event-subscription update

Mettez à jour un abonnement aux événements d’une rubrique d’espace de noms.

Extension Aperçu
az eventgrid namespace topic event-subscription wait

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

Extension Aperçu

az eventgrid namespace topic event-subscription create

Préversion

Le groupe de commandes « az eventgrid namespace topic event-subscription » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Créez un abonnement aux événements d’une rubrique d’espace de noms.

az eventgrid namespace topic event-subscription create --event-subscription-name
                                                       --namespace-name
                                                       --resource-group
                                                       --topic-name
                                                       [--delivery-configuration]
                                                       [--event-delivery-schema {CloudEventSchemaV1_0}]
                                                       [--filters-configuration]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Exemples

Créer un abonnement aux événements

az eventgrid namespace topic event-subscription create -g rg --topic-name topic -n event-subscription --namespace-name name --delivery-configuration "{deliveryMode:Queue,queue:{receiveLockDurationInSeconds:60,maxDeliveryCount:4,eventTimeToLive:P1D}}"

Paramètres obligatoires

--event-subscription-name --name -n

Nom de l’abonnement aux événements à créer. Les noms d’abonnement aux événements doivent être compris entre 3 et 100 caractères et utiliser uniquement des lettres alphanumériques.

--namespace-name

Nom de l’espace de noms.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--topic-name

Nom de la rubrique d’espace de noms.

Paramètres facultatifs

--delivery-configuration

Informations sur la configuration de remise de l’abonnement aux événements. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--event-delivery-schema

Schéma de remise d’événements pour l’abonnement aux événements.

Valeurs acceptées: CloudEventSchemaV1_0
--filters-configuration

Informations sur le filtre de l’abonnement aux événements. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az eventgrid namespace topic event-subscription delete

Préversion

Le groupe de commandes « az eventgrid namespace topic event-subscription » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Supprimez un abonnement à un événement existant d’une rubrique d’espace de noms.

az eventgrid namespace topic event-subscription delete [--event-subscription-name]
                                                       [--ids]
                                                       [--namespace-name]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--resource-group]
                                                       [--subscription]
                                                       [--topic-name]
                                                       [--yes]

Exemples

Supprimer l’abonnement à l’événement

az eventgrid namespace topic event-subscription delete -g rg --topic-name topic -n event-subscription --namespace-name name

Paramètres facultatifs

--event-subscription-name --name -n

Nom de l’abonnement aux événements à créer. Les noms d’abonnement aux événements doivent être compris entre 3 et 100 caractères et utiliser uniquement des lettres alphanumériques.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--namespace-name

Nom de l’espace de noms.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--topic-name

Nom de la rubrique d’espace de noms.

--yes -y

Ne pas demander de confirmation.

Valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az eventgrid namespace topic event-subscription list

Préversion

Le groupe de commandes « az eventgrid namespace topic event-subscription » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Répertorier les abonnements aux événements appartenant à une rubrique d’espace de noms spécifique.

az eventgrid namespace topic event-subscription list --namespace-name
                                                     --resource-group
                                                     --topic-name
                                                     [--filter]
                                                     [--max-items]
                                                     [--next-token]
                                                     [--top]

Exemples

Répertorier l’abonnement aux événements

az eventgrid namespace topic event-subscription list -g rg --topic-name topic --namespace-name name

Paramètres obligatoires

--namespace-name

Nom de l’espace de noms.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--topic-name

Nom de la rubrique d’espace de noms.

Paramètres facultatifs

--filter

Requête utilisée pour filtrer les résultats de la recherche à l’aide de la syntaxe OData. Le filtrage est autorisé uniquement sur la propriété « name » et avec un nombre limité d’opérations OData. Ces opérations sont : la fonction « contains » ainsi que les opérations logiques suivantes : non, et, ou, eq (pour égal) et ne (pour non égal). Aucune opération arithmétique n’est prise en charge. Voici un exemple de filtre valide : $filter=contains(namE, 'PATTERN') et name ne 'PATTERN-1'. L’exemple de filtre suivant n’est pas valide : $filter=location eq 'westus'.

--max-items

Nombre total d’éléments à retourner dans la sortie de la commande. Si le nombre total d’éléments disponibles est supérieur à la valeur spécifiée, un jeton est fourni dans la sortie de la commande. Pour reprendre la pagination, fournissez la valeur du jeton dans --next-token l’argument d’une commande suivante.

--next-token

Jeton pour spécifier où commencer la pagination. Il s’agit de la valeur du jeton d’une réponse tronquée précédemment.

--top

Nombre de résultats à retourner par page pour l’opération de liste. La plage valide pour le paramètre supérieur est comprise entre 1 et 100. Si ce n’est pas spécifié, le nombre par défaut de résultats à renvoyer est de 20 éléments par page.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az eventgrid namespace topic event-subscription show

Préversion

Le groupe de commandes « az eventgrid namespace topic event-subscription » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Afficher un abonnement aux événements d’une rubrique d’espace de noms.

az eventgrid namespace topic event-subscription show [--event-subscription-name]
                                                     [--ids]
                                                     [--namespace-name]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--topic-name]

Exemples

Afficher l’abonnement aux événements

az eventgrid namespace topic event-subscription show -g rg --topic-name topic -n event-subscription --namespace-name name

Paramètres facultatifs

--event-subscription-name --name -n

Nom de l’abonnement aux événements à créer. Les noms d’abonnement aux événements doivent être compris entre 3 et 100 caractères et utiliser uniquement des lettres alphanumériques.

--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--namespace-name

Nom de l’espace de noms.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--topic-name

Nom de la rubrique d’espace de noms.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az eventgrid namespace topic event-subscription update

Préversion

Le groupe de commandes « az eventgrid namespace topic event-subscription » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Mettez à jour un abonnement aux événements d’une rubrique d’espace de noms.

az eventgrid namespace topic event-subscription update [--add]
                                                       [--delivery-configuration]
                                                       [--event-delivery-schema {CloudEventSchemaV1_0}]
                                                       [--event-subscription-name]
                                                       [--filters-configuration]
                                                       [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--ids]
                                                       [--namespace-name]
                                                       [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                       [--remove]
                                                       [--resource-group]
                                                       [--set]
                                                       [--subscription]
                                                       [--topic-name]

Exemples

Mettre à jour l’abonnement aux événements

az eventgrid namespace topic event-subscription create -g rg --topic-name topic -n event-subscription --namespace-name name --filters-configuration "{includedEventTypes:['All']}"

Paramètres facultatifs

--add

Ajoutez un objet à une liste d’objets en spécifiant un chemin d’accès et des paires clé-valeur. Exemple : --add property.listProperty <key=value, string ou JSON string>.

--delivery-configuration

Informations sur la configuration de remise de l’abonnement aux événements. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--event-delivery-schema

Schéma de remise d’événements pour l’abonnement aux événements.

Valeurs acceptées: CloudEventSchemaV1_0
--event-subscription-name --name -n

Nom de l’abonnement aux événements à créer. Les noms d’abonnement aux événements doivent être compris entre 3 et 100 caractères et utiliser uniquement des lettres alphanumériques.

--filters-configuration

Informations sur le filtre de l’abonnement aux événements. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--force-string

Lorsque vous utilisez « set » ou « add », conservez les littéraux de chaîne au lieu de tenter de convertir en JSON.

Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--namespace-name

Nom de l’espace de noms.

--no-wait

Ne pas attendre la fin de l’opération de longue durée.

Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--remove

Supprimez une propriété ou un élément d’une liste. Exemple : --remove property.list OR --remove propertyToRemove.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--set

Mettez à jour un objet en spécifiant un chemin d’accès et une valeur de propriété à définir. Exemple : --set property1.property2=.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--topic-name

Nom de la rubrique d’espace de noms.

Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.

az eventgrid namespace topic event-subscription wait

Préversion

Le groupe de commandes « az eventgrid namespace topic event-subscription » est en préversion et en cours de développement. Référence et niveaux de support : https://aka.ms/CLI_refstatus

Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.

az eventgrid namespace topic event-subscription wait [--created]
                                                     [--custom]
                                                     [--deleted]
                                                     [--event-subscription-name]
                                                     [--exists]
                                                     [--ids]
                                                     [--interval]
                                                     [--namespace-name]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--timeout]
                                                     [--topic-name]
                                                     [--updated]

Paramètres facultatifs

--created

Attendez la création avec « provisioningState » sur « Succeeded ».

Valeur par défaut: False
--custom

Attendez que la condition réponde à une requête JMESPath personnalisée. Par exemple, provisioningState !='InProgress', instanceView.statuses[ ?code=='PowerState/running'].

--deleted

Attendez la suppression.

Valeur par défaut: False
--event-subscription-name --name -n

Nom de l’abonnement aux événements à créer. Les noms d’abonnement aux événements doivent être compris entre 3 et 100 caractères et utiliser uniquement des lettres alphanumériques.

--exists

Attendez que la ressource existe.

Valeur par défaut: False
--ids

Un ou plusieurs ID de ressource (délimités par des espaces). Il doit s’agir d’un ID de ressource complet contenant toutes les informations des arguments « ID de ressource ». Vous devez fournir des arguments --id ou d’autres arguments « ID de ressource ».

--interval

Intervalle d’interrogation en secondes.

Valeur par défaut: 30
--namespace-name

Nom de l’espace de noms.

--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut en utilisant az configure --defaults group=<name>.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--timeout

Délai maximal d’attente en secondes.

Valeur par défaut: 3600
--topic-name

Nom de la rubrique d’espace de noms.

--updated

Attendez la mise à jour avec provisioningState sur « Réussi ».

Valeur par défaut: False
Paramètres globaux
--debug

Augmentez le niveau de détail de la journalisation pour afficher tous les journaux de débogage.

--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

--output -o

Format de sortie.

Valeurs acceptées: json, jsonc, none, table, tsv, yaml, yamlc
Valeur par défaut: json
--query

Chaîne de requêtes JMESPath. Pour plus d’informations et d’exemples, consultez http://jmespath.org/.

--subscription

Nom ou ID de l’abonnement. Vous pouvez configurer l’abonnement par défaut en utilisant az account set -s NAME_OR_ID.

--verbose

Augmentez le niveau de détail de la journalisation. Utilisez --debug pour des journaux de débogage complets.