Configuration d’Azure CLI

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. L’interface CLI offre une commande pratique pour gérer certaines valeurs par défaut, az config, et une option interactive via az init. D’autres valeurs peuvent être définies dans un fichier de configuration ou avec des variables d’environnement. Cet article fournit des informations supplémentaires sur ces paramètres de configuration utilisateur et sur la façon de configurer Azure CLI.

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.

1. Paramètres de ligne de commande
2. Variables d'environnement
3. Valeurs du fichier de configuration définies avec az config ou az init

Configurer les paramètres avec az init

Le moyen le plus simple de définir des configurations Azure CLI consiste à utiliser la commande interactive az init. Choisissez une configuration commune comme « interaction » ou « automatisation », ou choisissez de parcourir des configurations individuelles. Ce qui est particulièrement utile avec cette approche est que az init fournit des raisons pour lesquelles vous souhaiterez probablement choisir une option de configuration plutôt qu’une autre.

az init

Configurer les paramètres avec az config

Vous pouvez définir des valeurs par défaut pour l’interface CLI avec la commande az config set. Cette commande prend un seul argument, qui est une liste de paires key=value séparées par un espace. Les valeurs fournies sont utilisées par l’interface CLI à la place des arguments requis.

Le tableau suivant contient une liste des clés de configuration disponibles.

Nom	Description
defaults.group	Groupe de ressources par défaut à utiliser pour toutes les commandes.
defaults.location	Emplacement par défaut à utiliser pour toutes les commandes.
defaults.web	Application par défaut à utiliser pour toutes les commandes az webapp.
defaults.vm	Nom de la machine virtuelle par défaut à utiliser pour les commandes az vm.
defaults.vmss	Nom du groupe de machines virtuelles identiques (VMSS) par défaut à utiliser pour les commandes az vmss.
defaults.acr	Nom du Registre du conteneur par défaut à utiliser pour les commandes az acr.

Par exemple, voici comment vous devez définir le groupe de ressources et l’emplacement par défaut pour toutes les commandes.

az config set defaults.location=westus2 defaults.group=MyResourceGroup

La commande suivante désactive les liens d’enquête lors de l’exécution des commandes Azure CLI :

az config set output.show_survey_link=no

Fichier de configuration de l’interface CLI

Le fichier de configuration de l’interface CLI contient d’autres paramètres utilisés pour gérer le comportement de l’interface CLI. Le fichier de configuration se trouve sous $AZURE_CONFIG_DIR/config. La valeur par défaut AZURE_CONFIG_DIR est $HOME/.azure sur Linux et macOS, et %USERPROFILE%\.azure sous Windows.

Les fichiers de configuration sont écrits sous le format de fichier INI. Des en-têtes de section définissent le format de fichier, suivis d’une liste d’entrées de clé-valeur.

• Les en-têtes de section sont écrits en tant que [section-name]. Les noms de section sont sensibles à la casse.
• Les entrées sont écrites en tant que key=value. Les noms des clés ne sont pas sensibles à la casse.
• Les commentaires sont n’importe quelle ligne commençant par un # ou ;. Les commentaires inclus ne sont pas autorisés.

Les valeurs boléennes sont insensibles à la casse. Les valeurs suivantes représentent des valeurs booléennes :

• True : 1, yes, true, on
• False : 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.

[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. Pour obtenir des informations détaillées sur le format de fichier INI, consultez la documentation Python sur INI.

Valeurs de configuration de l’interface CLI et variables d’environnement

Le tableau suivant contient l’ensemble des noms d’options et de sections pouvant être placés dans un fichier de configuration. Leurs variables d’environnement correspondantes sont configurées en tant que AZURE_{section}_{name} dans toutes les extrémités de fin. Par exemple, la valeur par défaut output pour core est définie dans la variable AZURE_CORE_OUTPUT, la valeur par défaut storage_account pour batchai est définie dans la variable AZURE_BATCHAI_STORAGE_ACCOUNT et la valeur par défaut location est définie dans la variable AZURE_DEFAULTS_LOCATION.

Lorsque vous fournissez une valeur par défaut, cet argument n’est plus nécessaire à aucune commande. C’est la valeur par défaut qui est alors utilisée.

Section	Nom	Type	Description
core	sortie	string	Format de sortie par défaut. Valeurs autorisées : json (par default), jsonc, yaml, yamlc, table, tsv, none. Pour plus d’informations, consultez Formats de sortie pour les commandes Azure CLI.
	disable_confirm_prompt	boolean	Active/Désactive les invites de confirmation.
	display_region_identified	boolean	Les clients Azure peuvent choisir de déployer des ressources dans de nombreuses régions différentes. Dans certains cas, les clients peuvent être en mesure de réduire les coûts en sélectionnant des régions voisines offrant les mêmes services. Si une région voisine est identifiée, un message affiche la région à sélectionner pour les déploiements futurs. Ce paramètre contrôle l’affichage du message.
	collect_telemetry	boolean	Autorise Microsoft à recueillir des données anonymes sur l’utilisation de l’interface CLI. Pour obtenir des informations sur la confidentialité, consultez la licence MIT Azure CLI.
	only_show_errors	boolean	Montre uniquement les erreurs pendant l’appel de commande. En d’autres termes, seules les erreurs sont écrites dans stderr. Il supprime les avertissements des commandes en préversion, dépréciées et expérimentales. Il est également disponible pour des commandes individuelles avec le paramètre --only-show-errors.
	enable_broker_on_windows	booléen	Utilisez le Gestionnaire de comptes web (WAM) pour vous authentifier auprès d’Azure via la az login commande.
	login_experience_v2	booléen	Activez/désactivez le sélecteur d’abonnement az login .
	no_color	boolean	Désactive la couleur. Les messages de couleur d’origine ont le préfixe DEBUG, INFO, WARNING et ERROR. Cette valeur boléenne contourne le problème d’une bibliothèque tierce où la couleur du terminal ne peut pas être restaurée après une redirection stdout.
clients	show_secrets_warning	booléen	Activez/désactivez l’avertissement pour la sortie des informations sensibles.
logging	enable_log_file	boolean	Active/Désactive la journalisation.
	log_dir	string	Répertoire dans lequel écrire les journaux d’activité. Par défaut, cette valeur est ${AZURE_CONFIG_DIR}/logs*.
defaults	group	string	Groupe de ressources par défaut à utiliser pour toutes les commandes.
	location	string	Emplacement par défaut à utiliser pour toutes les commandes.
	web	string	Application par défaut à utiliser pour toutes les commandes az webapp.
	vm	string	Nom de la machine virtuelle par défaut à utiliser pour les commandes az vm.
	vmss	string	Nom du groupe de machines virtuelles identiques (VMSS) par défaut à utiliser pour les commandes az vmss.
	acr	string	Nom du Registre du conteneur par défaut à utiliser pour les commandes az acr.
storage	account	string	Nom du compte de stockage par défaut (par exemple, mystorageaccount dans https://mystorageaccount.blob.core.windows.net) à utiliser pour des commandes de plan de données az storage (par exemple, az storage container list).
	key	string	Clé d’accès par défaut à utiliser pour les commandes de plan de données az storage.
	sas_token	string	Jeton SAS par défaut à utiliser pour les commandes de plan de données az storage.
	connection_string	string	Chaîne de connexion par défaut à utiliser pour les commandes de plan de données az storage.
batchai	storage_account	string	Compte de stockage par défaut à utiliser pour les commandes az batchai.
	storage_key	string	Clé de stockage par défaut à utiliser pour les commandes az batchai.
batch	account	string	Nom de compte Azure Batch par défaut à utiliser pour les commandes az batch.
	access_key	string	Clé d’accès par défaut à utiliser pour les commandes az batch. Uniquement utilisée avec l’autorisation aad.
	endpoint	string	Point de terminaison par défaut auquel se connecter pour les commandes az batch.
	auth_mode	string	Mode d’autorisation à utiliser pour les commandes az batch. Valeurs autorisées : shared_key, aad.
cloud	name	string	Cloud par défaut pour toutes les commandes az. Valeurs autorisées :AzureCloud (par défaut), AzureChinaCloud, AzureUSGovernment. Pour changer des clouds, vous pouvez utiliser la commande az cloud set –name. Pour obtenir un exemple, consultez Gérer des clouds avec l’interface Azure CLI.
extension	use_dynamic_install	string	Installez une extension si elle n’est pas encore ajoutée lors de l’exécution d’une commande à partir de celle-ci. Valeurs autorisées :no (par défaut), yes_prompt, yes_without_prompt.
	run_after_dynamic_install	boolean	Poursuivez l’exécution de la commande lorsqu’une extension est installée dynamiquement pour celle-ci. La valeur par défaut est False.
	index_url	string	URL du fichier d’index d’extension privée suivant le format dans index.json. Une fois spécifié, l’exécution de az extension add --name <extension-name> utilise ce fichier pour rechercher l’extension à ajouter.

Remarque

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 config. Les valeurs précédemment répertoriées dans le tableau ci-dessus sont les seules valeurs que vous devez modifier vous-même.