az eventgrid namespace client

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 cliente d’espace de noms az eventgrid. En savoir plus sur les extensions.

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

Gérer le client d’espace de noms eventgrid.

Commandes

Nom	Description	Type	Statut
az eventgrid namespace client create	Créez un client.	Extension	Aperçu
az eventgrid namespace client delete	Supprimez un client existant.	Extension	Aperçu
az eventgrid namespace client list	Répertorier tout le client sous un espace de noms.	Extension	Aperçu
az eventgrid namespace client show	Afficher un client.	Extension	Aperçu
az eventgrid namespace client update	Mettez à jour un client.	Extension	Aperçu
az eventgrid namespace client wait	Placez l’interface CLI dans un état d’attente jusqu’à ce qu’une condition soit remplie.	Extension	Aperçu

az eventgrid namespace client create

Préversion

Le groupe de commandes « az eventgrid namespace client » 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 client.

az eventgrid namespace client create --client-name
                                     --namespace-name
                                     --resource-group
                                     [--attributes]
                                     [--authentication]
                                     [--authentication-name]
                                     [--client-certificate-authentication]
                                     [--description]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--state {Disabled, Enabled}]

Exemples

Créer un client

az eventgrid namespace client create -g rg --namespace-name name -n client-name  --attributes "{'room':'345','floor':5}" --client-certificate-authentication "{validationScheme:SubjectMatchesAuthenticationName}"

Paramètres obligatoires

--client-name --name -n

Nom du client.

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

Paramètres facultatifs

--attributes

Attributs pour le client. Prendre en charge json-file et yaml-file.

--authentication

Informations d’authentification pour le client. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--authentication-name

Nom présenté par le client pour l’authentification. La valeur par défaut est le nom de la ressource.

--client-certificate-authentication

Informations d’authentification par certificat client. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--description

Description de la ressource cliente.

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

--state

Indique si le client est activé ou non. La valeur par défaut est Activée.

valeurs acceptées: Disabled, Enabled

valeur par défaut: Enabled

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 client delete

Préversion

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

Supprimez un client existant.

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

Exemples

Supprimer le client

az eventgrid namespace client delete -g rg --namespace-name name -n client-name

Paramètres facultatifs

--client-name --name -n

Nom du client.

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

--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 client list

Préversion

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

Répertorier tout le client sous un espace de noms.

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

Exemples

Répertorier le client

az eventgrid namespace client list -g rg --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>.

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 client show

Préversion

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

Afficher un client.

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

Exemples

Afficher le client

az eventgrid namespace client show -g rg --namespace-name name -n client-name

Paramètres facultatifs

--client-name --name -n

Nom du client.

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

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 client update

Préversion

Le groupe de commandes « az eventgrid namespace client » 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 client.

az eventgrid namespace client update [--add]
                                     [--attributes]
                                     [--authentication]
                                     [--client-certificate-authentication]
                                     [--client-name]
                                     [--description]
                                     [--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]
                                     [--state {Disabled, Enabled}]
                                     [--subscription]

Exemples

Mettre à jour le client

az eventgrid namespace client update -g rg --namespace-name name -n client-name --description test

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

--attributes

Attributs pour le client. Prendre en charge json-file et yaml-file.

--authentication

Informations d’authentification pour le client. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--client-certificate-authentication

Informations d’authentification par certificat client. Prendre en charge la syntaxe abrégée, json-file et yaml-file. Essayez « ?? » pour en montrer plus.

--client-name --name -n

Nom du client.

--description

Description de la ressource cliente.

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

--state

Indique si le client est activé ou non. La valeur par défaut est Activée.

valeurs acceptées: Disabled, Enabled

--subscription

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

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 client wait

Préversion

Le groupe de commandes « az eventgrid namespace client » 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 client wait [--client-name]
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--ids]
                                   [--interval]
                                   [--namespace-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Paramètres facultatifs

--client-name --name -n

Nom du client.

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

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

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