az nginx deployment api-key

Note

Cette référence fait partie de l’extension nginx pour Azure CLI (version 2.68.0 ou ultérieure). L’extension installe automatiquement la première fois que vous exécutez une az nginx deployment api-key commande. En savoir plus sur les extensions.

Gestion des clés API de déploiement Nginxaas.

Commandes

Nom	Description	Type	État
az nginx deployment api-key create	Créez une clé API pour le déploiement Nginx afin d’accéder au point de terminaison de l’API de plan de données.	Extension	GA
az nginx deployment api-key delete	Supprimez la clé API pour le déploiement Nginx.	Extension	GA
az nginx deployment api-key list	Répertoriez toutes les clés API du déploiement Nginx donné.	Extension	GA
az nginx deployment api-key show	Obtenez la clé API spécifiée du déploiement Nginx donné.	Extension	GA
az nginx deployment api-key update	Mettez à jour une clé API pour le déploiement Nginx afin d’accéder au point de terminaison de l’API de plan de données.	Extension	GA

az nginx deployment api-key create

Créez une clé API pour le déploiement Nginx afin d’accéder au point de terminaison de l’API de plan de données.

az nginx deployment api-key create --api-key-name
                                   --deployment-name
                                   --resource-group
                                   [--end-date-time]
                                   [--secret-text]

Paramètres obligatoires

--api-key-name --name -n

Nom de la ressource de la clé API.

--deployment-name

Nom du déploiement NGINX ciblé.

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

--end-date-time

Heure après laquelle cette clé API Dataplane n’est plus valide.

--secret-text

Texte secret à utiliser comme clé API Dataplane. Il s’agit d’une propriété en écriture seule qui ne peut jamais être lue, mais les trois premiers caractères sont retournés dans la propriété 'hint'. Si la valeur est vide, elle est demandée à partir de la tty.

Paramètres globaux

--debug

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

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ê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 la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az nginx deployment api-key delete

Supprimez la clé API pour le déploiement Nginx.

az nginx deployment api-key delete [--api-key-name]
                                   [--deployment-name]
                                   [--ids]
                                   [--resource-group]
                                   [--subscription]
                                   [--yes]

Paramètres facultatifs

--api-key-name --name -n

Nom de la ressource de la clé API.

--deployment-name

Nom du déploiement NGINX ciblé.

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

--resource-group -g

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

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

--yes -y

N’invitez pas à confirmer.

Valeur par défaut: False

Paramètres globaux

--debug

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

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ê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 la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az nginx deployment api-key list

Répertoriez toutes les clés API du déploiement Nginx donné.

az nginx deployment api-key list --deployment-name
                                 --resource-group
                                 [--max-items]
                                 [--next-token]

Paramètres obligatoires

--deployment-name

Nom du déploiement NGINX ciblé.

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

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

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

Paramètres globaux

--debug

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

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ê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 la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az nginx deployment api-key show

Obtenez la clé API spécifiée du déploiement Nginx donné.

az nginx deployment api-key show [--api-key-name]
                                 [--deployment-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Paramètres facultatifs

--api-key-name --name -n

Nom de la ressource de la clé API.

--deployment-name

Nom du déploiement NGINX ciblé.

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

--resource-group -g

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

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

Paramètres globaux

--debug

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

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ê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 la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.

az nginx deployment api-key update

Mettez à jour une clé API pour le déploiement Nginx afin d’accéder au point de terminaison de l’API de plan de données.

az nginx deployment api-key update [--add]
                                   [--api-key-name]
                                   [--deployment-name]
                                   [--end-date-time]
                                   [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--ids]
                                   [--remove]
                                   [--resource-group]
                                   [--secret-text]
                                   [--set]
                                   [--subscription]

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

--api-key-name --name -n

Nom de la ressource de la clé API.

--deployment-name

Nom du déploiement NGINX ciblé.

--end-date-time

Heure après laquelle cette clé API Dataplane n’est plus valide.

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

--remove

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

--resource-group -g

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

--secret-text

Texte secret à utiliser comme clé API Dataplane. Il s’agit d’une propriété en écriture seule qui ne peut jamais être lue, mais les trois premiers caractères sont retournés dans la propriété 'hint'. Si la valeur est vide, elle est demandée à partir de la tty.

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

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

Paramètres globaux

--debug

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

--help -h

Affichez ce message d’aide et quittez-le.

--only-show-errors

Affiche 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ê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 la détail de journalisation. Utilisez --debug pour les journaux de débogage complets.