Partager via

Guide pratique pour utiliser des paramètres globaux dans Azure CLI

  • Article

Lorsque vous utilisez les commandes de référence Azure CLI, il existe des arguments disponibles pour la plupart des commandes. Ces arguments sont appelés « paramètres globaux », car ils sont communs à presque toutes les commandes de référence Azure CLI.

--help paramètre global

Pour obtenir des informations sur un groupe ou une commande de référence, utilisez le --help paramètre global. Le --help paramètre affiche les informations de référence Azure CLI dans votre console, y compris les sous-groupes disponibles et les listes de paramètres.

az group create --name myResourceGroup --location eastus --help

La sortie de la console suivante illustrée ici comporte des champs omis pour la concision :

Command
    az group create : Create a new resource group.

Arguments
    --location -l                 [Required] : Location. Values from: `az account list-locations`.
                                               You can configure the default location using `az
                                               configure --defaults location=<location>`.
    --name --resource-group -g -n [Required] : Name of the new resource group.
    --managed-by                             : The ID of the resource that manages this resource
                                               group.
    --tags                                   : Space-separated tags: key[=value] [key[=value] ...].
                                               Use "" to clear existing tags.

Global Arguments
    --debug                                  : Increase logging verbosity to show all debug logs.
    --help -h                                : Show this help message and exit.
    --only-show-errors                       : Only show errors, suppressing warnings.

Examples
    Create a new resource group in the West US region.
        az group create -l westus -n MyResourceGroup

--verbose paramètre global

En savoir plus sur la journalisation en ajoutant le --verbose paramètre global à votre commande de référence. La sortie détaillée est utile lorsque vous essayez de comprendre pourquoi certaines commandes prennent plus de temps que d’autres pour s’exécuter.

az group create --name myResourceGroup --location eastus --verbose

La sortie de la console suivante illustrée ici comporte des champs omis pour la concision, mais notez les informations supplémentaires sur le temps d’exécution.

{...}
Command ran in 1.413 seconds (init: 0.487, invoke: 0.926)

--debug paramètre global

Si les détails supplémentaires du --verbose paramètre ne sont pas suffisants et que vous souhaitez afficher l’intégralité du journal, utilisez le --debug paramètre global. Fournissez également la sortie générée --debug lors de l’envoi d’un rapport de bogue.

az group create --name myrResourceGroup --location eastus --debug

La sortie de la console suivante illustrée ici comporte des champs omis pour la concision :


cli.knack.cli: Command arguments: ['group', 'create', '--name', 'myResourceGroup', '--location', 'eastus', '--debug']
cli.knack.cli: __init__ debug log:
[...]
cli.knack.cli: Event: CommandInvoker.OnTransformResult [<function _resource_group_transform at 0x000001D9B72123B0>, <function _x509_from_base64_to_hex_transform at 0x000001D9B7212440>]
cli.knack.cli: Event: CommandInvoker.OnFilterResult []
{...}
[...]
telemetry.process: Return from creating process
telemetry.main: Finish creating telemetry upload process.

--only-show-errors paramètre global

Pendant le processus de débogage, supprimez les avertissements retournés par une commande de référence à l’aide du --only-show-errors paramètre global.

az interactive

Console de sortie :

**This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus**

Any comments or concerns? You can use the 'feedback' command! We would greatly appreciate it.

A new Recommender is added which can make the completion ability more intelligent and provide the scenario completion!
If you want to disable this feature, you can use 'az config set interactive.enable_recommender=False' to disable it.

A command preload mechanism was added to prevent lagging and command run errors.
You can skip preloading in a single pass by CTRL+C or turn it off by setting 'az config set interactive.enable_preloading=False'

Loading command table... Expected time around 1 minute.

--subscription paramètre global

Vous pouvez utiliser le --subscription paramètre global pour définir un abonnement spécifique pour une commande. L’exemple suivant modifie l’abonnement actif à l’aide de l’ID d’abonnement :

az account set --subscription "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

--output paramètre global

Pour afficher la sortie d’une commande dans un format spécifique, spécifiez le --output paramètre global. Dans cet exemple, la sortie s’affiche sous la forme d’un tableau :

Remarque

Les valeurs acceptées pour la sortie sont : json, jsonc, none, table, tsv, yaml et yamlc. La valeur de sortie par défaut est json.

az vm list --resource-group myResourceGroup --output table

Console de sortie :

Name    ResourceGroup    Location
------  ---------------  ----------
myVm    myResourceGroup  eastus

Pour en savoir plus sur les différents formats de sortie, consultez Formats de sortie pour les commandes Azure CLI.

--query paramètre global

Il arrive que la console de sortie affiche des quantités étendues d’informations que vous devez filtrer. Pour ce faire, utilisez le --query paramètre global pour exécuter une requête JMESPath sur les résultats des commandes. JMESPath est un langage de requête pour JSON, qui vous permet de sélectionner et de modifier des données à partir de la sortie Azure CLI.

Cet exemple retourne les clés publiques SSH autorisées à se connecter à la machine virtuelle en ajoutant --query:

 az vm show --resource-group myResourceGroup --name myVm --query "osProfile.linuxConfigurat
ion.ssh.publicKeys"

Console de sortie :

[
  {
    "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC7WbiMEsB0iwdGPjeGXs3UWFtzbCkUwtIxzkIOpEtlqkLGa0XQdvwhzok6szq6Ycx/f4cfid/yrmBPtzmxdQnGeCy2FOcVIzp+SkjIUg/Ez2YyDcMb60u66QUmHPRyhipJ/PDZROt6O0092qfTkTjB+7hLRiZzV2raLjiQ95eV0AXUP+Gsvdo/7ytqWNIm3iQTWbQ/GwSg+p0v+kmZELIbrxo845dambSpgBL8g0wCUZaptru3ZHo9m0UWbFPASVJKauhfPCSVPQCaOCaAdB01Ih8QDVRCazT+jyV6GgTwUIXVQthVBbt56ibhuSUdf0cWF8IVncjH+WXexVAhQw0j",
    "path": "/home/daphnema/.ssh/authorized_keys"
  }
]

Pour en savoir plus sur l’interrogation de la sortie de commande, consultez Comment interroger la sortie de commande Azure CLI à l’aide d’une requête JMESPath.

Voir aussi