Partager via

az nginx deployment api-key

Note

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

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

Commandes

Nom Description Type Statut
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 --name
                                   --deployment-name
                                   --resource-group
                                   [--end-date-time]
                                   [--secret-text]

Paramètres requis

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

Les paramètres suivants sont facultatifs, mais selon le contexte, un ou plusieurs d’entre eux peuvent être nécessaires pour que la commande s’exécute correctement.

--end-date-time

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

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

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

--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 nginx deployment api-key delete

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

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

Paramètres optionnels

Les paramètres suivants sont facultatifs, mais selon le contexte, un ou plusieurs d’entre eux peuvent être nécessaires pour que la commande s’exécute correctement.

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

Nom de la ressource de la clé API.

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

Nom du déploiement NGINX ciblé.

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

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

Les paramètres suivants sont facultatifs, mais selon le contexte, un ou plusieurs d’entre eux peuvent être nécessaires pour que la commande s’exécute correctement.

--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
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 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 --name]
                                 [--deployment-name]
                                 [--ids]
                                 [--resource-group]
                                 [--subscription]

Paramètres optionnels

Les paramètres suivants sont facultatifs, mais selon le contexte, un ou plusieurs d’entre eux peuvent être nécessaires pour que la commande s’exécute correctement.

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

Nom de la ressource de la clé API.

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

Nom du déploiement NGINX ciblé.

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

Les paramètres suivants sont facultatifs, mais selon le contexte, un ou plusieurs d’entre eux 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
--api-key-name --name -n

Nom de la ressource de la clé API.

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

Nom du déploiement NGINX ciblé.

Propriété Valeur
Groupe de paramètres: Resource Id Arguments
--end-date-time

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

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

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