Partager via


az eventgrid namespace client

Note

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 un client d’espace de noms az eventgrid commande. Apprenez-en davantage sur les extensions.

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

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

Commandes

Nom Description Type État
az eventgrid namespace client create

Créez un client.

Extension Preview
az eventgrid namespace client delete

Supprimez un client existant.

Extension Preview
az eventgrid namespace client list

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

Extension Preview
az eventgrid namespace client show

Afficher un client.

Extension Preview
az eventgrid namespace client update

Mettez à jour un client.

Extension Preview
az eventgrid namespace client wait

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

Extension Preview

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. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Créez un client.

az eventgrid namespace client create --client-name --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 à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--attributes

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

Propriété Valeur
Groupe de paramètres: Properties Arguments
--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.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--authentication-name

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

Propriété Valeur
Groupe de paramètres: Properties Arguments
--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.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--description

Description de la ressource cliente.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--no-wait

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

Propriété Valeur
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.

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeur par défaut: Enabled
Valeurs acceptées: Disabled, Enabled
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

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. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Supprimez un client existant.

az eventgrid namespace client delete [--client-name --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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--client-name --name -n

Nom du client.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--namespace-name

Nom de l’espace de noms.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--no-wait

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

Propriété Valeur
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 à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

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

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--yes -y

N’invitez pas à confirmer.

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

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

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

--verbose

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

Propriété Valeur
Valeur par défaut: False

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. Niveaux de référence et 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 à l’aide de az configure --defaults group=<name>.

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--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 argument d’une commande suivante.

Propriété Valeur
Groupe de paramètres: Pagination Arguments
--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.

Propriété Valeur
Groupe de paramètres: Pagination Arguments
--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 la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

Chaîne de requête 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 à l’aide de az account set -s NAME_OR_ID.

--verbose

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

Propriété Valeur
Valeur par défaut: False

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. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Afficher un client.

az eventgrid namespace client show [--client-name --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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--client-name --name -n

Nom du client.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--namespace-name

Nom de l’espace de noms.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

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

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

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

--verbose

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

Propriété Valeur
Valeur par défaut: False

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. Niveaux de référence et de support : https://aka.ms/CLI_refstatus

Mettez à jour un client.

az eventgrid namespace client update [--add]
                                     [--attributes]
                                     [--authentication]
                                     [--client-certificate-authentication]
                                     [--client-name --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

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--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 or JSON string>.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
--attributes

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

Propriété Valeur
Groupe de paramètres: Properties Arguments
--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.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--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.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--client-name --name -n

Nom du client.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--description

Description de la ressource cliente.

Propriété Valeur
Groupe de paramètres: Properties Arguments
--force-string

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

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
Valeurs acceptées: 0, 1, f, false, n, no, t, true, y, yes
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--namespace-name

Nom de l’espace de noms.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--no-wait

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

Propriété Valeur
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 <indexToRemove> OR --remove propertyToRemove.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--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=<value>.

Propriété Valeur
Groupe de paramètres: Generic Update Arguments
--state

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

Propriété Valeur
Groupe de paramètres: Properties Arguments
Valeurs acceptées: Disabled, Enabled
--subscription

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

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

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

--verbose

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

Propriété Valeur
Valeur par défaut: False

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. Niveaux de référence et 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 --name]
                                   [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--ids]
                                   [--interval]
                                   [--namespace-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Paramètres facultatifs

Les paramètres suivants sont facultatifs, mais en fonction du contexte, un ou plusieurs peuvent être nécessaires pour que la commande s’exécute correctement.

--client-name --name -n

Nom du client.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--created

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

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
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'].

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
--deleted

Attendez la suppression.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
--exists

Attendez que la ressource existe.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
--ids

Un ou plusieurs ID de ressource (délimités par l’espace). 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 ».

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--interval

Intervalle d’interrogation en secondes.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: 30
--namespace-name

Nom de l’espace de noms.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--resource-group -g

Nom du groupe de ressources. Vous pouvez configurer le groupe par défaut à l’aide de az configure --defaults group=<name>.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--subscription

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

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--timeout

Délai maximal d’attente en secondes.

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: 3600
--updated

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

Propriété Valeur
Groupe de paramètres: Wait Condition Arguments
Valeur par défaut: False
Paramètres globaux
--debug

Augmentez la verbosité de la journalisation pour afficher tous les logs de débogage.

Propriété Valeur
Valeur par défaut: False
--help -h

Affichez ce message d’aide et quittez.

--only-show-errors

Afficher uniquement les erreurs, en supprimant les avertissements.

Propriété Valeur
Valeur par défaut: False
--output -o

Format de sortie.

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

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

--verbose

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

Propriété Valeur
Valeur par défaut: False