Configuration d’Azure CLIAzure CLI configuration

Azure CLI autorise une configuration utilisateur pour des paramètres tels que la journalisation, la collecte de données et les valeurs d’argument par défaut.The Azure CLI allows for user configuration for settings such as logging, data collection, and default argument values. L’interface CLI propose une commande satisfaisante pour la gestion de certains paramètres par défaut, az configure.The CLI offers a convenience command for managing some defaults, az configure. D’autres valeurs peuvent être définies dans un fichier de configuration ou avec des variables d’environnement.Other values can be set in a configuration file or with environment variables.

Les valeurs de configuration utilisées par l’interface CLI sont évaluées dans l’ordre suivant. Les éléments situés en haut de la liste sont prioritaires.Configuration values used by the CLI are evaluated in the following precedence, with items higher on the list taking priority.

  1. Paramètres de ligne de commandeCommand-line parameters
  2. Variables d’environnementEnvironment variables
  3. Valeurs du fichier de configuration ou définies avec az configureValues in the configuration file or set with az configure

Configuration de l’interface CLI avec az configureCLI configuration with az configure

La commande az configure permet de définir les valeurs par défaut de l’interface CLI.You set defaults for the CLI with the az configure command. Cette commande accepte un seul argument, --defaults, qui est une liste séparée par des espaces de paires key=value.This command takes one argument, --defaults, which is a space-separated list of key=value pairs. Les valeurs fournies sont utilisées par l’interface CLI à la place des arguments requis.The provided values are used by the CLI in place of required arguments.

Le tableau suivant contient une liste des clés de configuration disponibles.The following table contains a list of available configuration keys.

NomName DescriptionDescription
groupgroup Groupe de ressources par défaut à utiliser pour toutes les commandes.The default resource group to use for all commands.
locationlocation Emplacement par défaut à utiliser pour toutes les commandes.The default location to use for all commands.
webweb Application par défaut à utiliser pour toutes les commandes az webapp.The default app name to use for az webapp commands.
vmvm Nom de la machine virtuelle par défaut à utiliser pour les commandes az vm.The default VM name to use for az vm commands.
vmssvmss Nom du groupe de machines virtuelles identiques (VMSS) par défaut à utiliser pour les commandes az vmss.The default virtual machine scale set (VMSS) name to use for az vmss commands.
acracr Nom du Registre du conteneur par défaut à utiliser pour les commandes az acr.The default container registry name to use for az acr commands.

Par exemple, voici comment vous devez définir le groupe de ressources et l’emplacement par défaut pour toutes les commandes.As an example, here's how you would set the default resource group and location for all commands.

az configure --defaults location=westus2 group=MyResourceGroup

Fichier de configuration de l’interface CLICLI configuration file

Le fichier de configuration de l’interface CLI contient d’autres paramètres utilisés pour gérer le comportement de l’interface CLI.The CLI configuration file contains other settings that are used for managing CLI behavior. Le fichier de configuration se trouve sous $AZURE_CONFIG_DIR/config.The configuration file itself is located at $AZURE_CONFIG_DIR/config. La valeur par défaut AZURE_CONFIG_DIR est $HOME/.azure sur Linux et macOS, et %USERPROFILE%\.azure sous Windows.The default value of AZURE_CONFIG_DIR is $HOME/.azure on Linux and macOS, and %USERPROFILE%\.azure on Windows.

Les fichiers de configuration sont écrits sous le format de fichier INI.Configuration files are written in the INI file format. Ce format de fichier est défini par des en-têtes de section, suivis d’une liste d’entrées de clé-valeur.This file format is defined by section headers, followed by a list of key-value entries.

  • Les en-têtes de section sont écrits en tant que [section-name].Section headers are written as [section-name]. Les noms de section sont sensibles à la casse.Section names are case-sensitive.
  • Les entrées sont écrites en tant que key=value.Entries are written as key=value. Les noms de clés ne sont pas sensibles à la casse.Key names are not case-sensitive.
  • Les commentaires sont n’importe quelle ligne commençant par un # ou ;.Comments are any line that begins with a # or ;. Les commentaires inclus ne sont pas autorisés.Inline comments are not allowed.

Les valeurs booléennes ne respectent pas la casse et sont représentées par les valeurs suivantes.Booleans are case-insensitive, and are represented by the following values.

  • True : 1, yes, true, onTrue: 1, yes, true, on
  • False : 0, no, false, offFalse: 0, no, false, off

Voici un exemple de fichier de configuration d’interface CLI qui désactive toutes les invites de confirmation et qui configure la journalisation vers le répertoire /var/log/azure.Here's an example of a CLI configuration file that disables any confirmation prompts and sets up logging to the /var/log/azure directory.

[core]
disable_confirm_prompt=Yes

[logging]
enable_log_file=yes
log_dir=/var/log/azure

Consultez la section suivante pour en savoir plus sur toutes les valeurs de configuration disponibles et leur signification.See the next section for details on all of the available configuration values and what they mean. Pour obtenir des informations détaillées sur le format de fichier INI, consultez la documentation Python sur INI.For the full details on the INI file format, see the Python documentation on INI.

Valeurs de configuration de l’interface CLI et variables d’environnementCLI configuration values and environment variables

Le tableau suivant contient l’ensemble des noms d’options et de sections pouvant être placés dans un fichier de configuration.The following table contains all of the sections and option names that can be placed in a configuration file. Leurs variables d’environnement correspondantes sont configurées en tant que AZURE_{section}_{name} dans toutes les extrémités de fin.Their corresponding environment variables are set as AZURE_{section}_{name}, in all caps. Par exemple, le paramètre par défaut storage_account pour batchai est défini dans la variable AZURE_BATCHAI_STORAGE_ACCOUNT.For example, the storage_account default for batchai is set in the AZURE_BATCHAI_STORAGE_ACCOUNT variable.

Lorsque vous fournissez une valeur par défaut, cet argument n’est plus nécessaire à aucune commande.When you provide a default value, that argument is no longer required by any command. C’est la valeur par défaut qui est alors utilisée.Instead, the default value is used.

SectionSection NomName typeType DescriptionDescription
corecore sortieoutput chaînestring Format de sortie par défaut.The default output format. Peut être json, jsonc, tsv ou table.Can be one of json, jsonc, tsv, or table.
disable_confirm_promptdisable_confirm_prompt booléenneboolean Active/Désactive les invites de confirmation.Turn confirmation prompts on/off.
collect_telemetrycollect_telemetry booléenneboolean Autorise Microsoft à recueillir des données anonymes sur l’utilisation de l’interface CLI.Allow Microsoft to collect anonymous data on the usage of the CLI. Pour plus d’informations sur la confidentialité, consultez les conditions d’utilisation d’Azure CLI.For privacy information, see the Azure CLI Terms of Use.
logginglogging enable_log_fileenable_log_file booléenneboolean Active/Désactive la journalisation.Turn logging on/off.
log_dirlog_dir chaînestring Répertoire dans lequel écrire les journaux.The directory to write logs to. Par défaut, cette valeur est ${AZURE_CONFIG_DIR}/logs.By default this value is ${AZURE_CONFIG_DIR}/logs.
storagestorage connection_stringconnection_string chaînestring Chaîne de connexion par défaut à utiliser pour les commandes az storage.The default connection string to use for az storage commands.
accountaccount chaînestring Nom de compte par défaut à utiliser pour les commandes az storage.The default account name to use for az storage commands.
keykey chaînestring Clé de compte par défaut à utiliser pour les commandes az storage.The default account key to use for az storage commands.
sas_tokensas_token chaînestring Jeton SAS par défaut à utiliser pour les commandes az storage.The default SAS token to use for az storage commands.
batchaibatchai storage_accountstorage_account chaînestring Compte de stockage par défaut à utiliser pour les commandes az batchai.The default storage account to use for az batchai commands.
storage_keystorage_key chaînestring Clé de stockage par défaut à utiliser pour les commandes az batchai.The default storage key to use for az batchai commands.
batchbatch accountaccount chaînestring Nom de compte Azure Batch par défaut à utiliser pour les commandes az batch.The default Azure Batch account name to use for az batch commands.
access_keyaccess_key chaînestring Clé d’accès par défaut à utiliser pour les commandes az batch.The default access key to use for az batch commands. Uniquement utilisée avec l’autorisation aad.Only used with aad authorization.
endpointendpoint chaînestring Point de terminaison par défaut auquel se connecter pour les commandes az batch.The default endpoint to connect to for az batch commands.
auth_modeauth_mode chaînestring Mode d’autorisation à utiliser pour les commandes az batch.The authorization mode to use for az batch commands. Peut être shared_key ou aad.Can be shared_key or aad.

Notes

Votre fichier de configuration peut contenir d’autres valeurs. Toutefois, celles-ci sont gérées directement par le biais de commandes de l’interface CLI, notamment az configure.You may see other values in your configuration file, but these are managed directly through CLI commands, including az configure. Les valeurs répertoriées dans le tableau ci-dessus sont les seules valeurs que vous devez modifier vous-même.The ones listed in the table above are the only values you should change yourself.