Configuration d’Azure CLI

Azure CLI permet la configuration utilisateur pour les 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 configet 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 configuration d’Azure CLI.

Les valeurs de configuration utilisées par l’interface CLI sont évaluées dans la priorité suivante, avec des éléments plus élevés dans la liste qui ont priorité.

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

Configurer les paramètres à l’aide d’az init

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

az init

Configurer les paramètres à l’aide d’az config

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

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

Nom	Descriptif
groupe de valeurs par défaut	Groupe de ressources par défaut à utiliser pour toutes les commandes.
emplacement par défaut	Emplacement par défaut à utiliser pour toutes les commandes.
defaults.web	Nom d'application à utiliser par défaut pour les commandes az webapp.
paramètres_par_défaut.vm	Nom par défaut de machine virtuelle à utiliser pour les commandes az vm.
defaults.vmss	Nom de l'ensemble de machines virtuelles par défaut à utiliser pour az vmss les commandes.
defaults.acr	Nom du registre de conteneurs par défaut à utiliser pour les commandes az acr.

Par exemple, voici comment 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 core.survey_message=no

Fichier de configuration CLI

Le fichier de configuration 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 au format de fichier INI. Les en-têtes de section définissent le format de fichier, suivis d’une liste d’entrées clé-valeur.

• Les en-têtes de section sont écrits en tant que [section-name]. Les noms de section respectent la casse.
• Les entrées sont écrites en tant que key=value. Les noms de clés ne sont pas sensibles à la casse.
• Les commentaires sont toutes les lignes qui commencent par un # ou ;. Les commentaires inline ne sont pas autorisés.

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

• True : 1, , yes, trueon
• Faux : 0, no, false, off

Voici un exemple de fichier de configuration CLI qui désactive toutes les invites de confirmation et configure la journalisation dans le /var/log/azure répertoire.

[core]
disable_confirm_prompt=Yes

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

Consultez la section suivante pour plus d’informations sur toutes les valeurs de configuration disponibles et ce qu’elles signifient. Pour plus d’informations sur le format de fichier INI, consultez la documentation Python sur INI.

Valeurs de configuration cli et variables d’environnement

Le tableau suivant contient toutes les sections et noms d’options qui peuvent être placés dans un fichier de configuration. Leurs variables d’environnement correspondantes sont définies en tant que AZURE_{section}_{name}, dans toutes les majuscules. Par exemple, output la valeur par défaut core est définie dans la AZURE_CORE_OUTPUT variable, la storage_account valeur par défaut batchai est définie dans la AZURE_BATCHAI_STORAGE_ACCOUNT variable et la valeur par défaut location est définie dans la AZURE_DEFAULTS_LOCATION variable.

Lorsque vous fournissez une valeur par défaut, cet argument n’est plus requis par une commande. Au lieu de cela, la valeur par défaut est utilisée.

Section	Nom	Catégorie	Descriptif
noyau	résultat	ficelle	Format de sortie par défaut. Valeurs autorisées : json (par défaut), jsonc, , yamlyamlctable, tsv, . none Pour plus d’informations, consultez Formats de sortie pour les commandes Azure CLI.
	désactiver_invite_de_confirmation	booléen	Activez/désactivez les invites de confirmation.
	région_affichée_identifiée	booléen	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 les régions voisines offrant les mêmes services. Si une région proche est identifiée, un message affiche la région à sélectionner pour les déploiements futurs. Ce paramètre contrôle si le message s’affiche.
	collecter_télémétrie	booléen	Autoriser Microsoft à collecter des données anonymes sur l’utilisation de l’interface CLI. Pour plus d’informations sur la confidentialité, consultez la licence MIT Azure CLI.
	afficher_seulement_les_erreurs	booléen	Affiche uniquement les erreurs lors de l’appel de commande. En d’autres termes, seules les erreurs sont écrites dans stderr. Il supprime les avertissements de prévisualisation, ainsi que des commandes déconseillées et expérimentales. Il est également disponible pour les commandes individuelles avec le --only-show-errors paramètre.
	activer_le_broker_sous_windows	booléen	Utilisez le Gestionnaire de comptes web (WAM) pour vous authentifier auprès d’Azure via la az login commande.
	expérience_de_connexion_v2	booléen	Activez/désactivez le sélecteur d’abonnement az login .
	sans couleur	booléen	Désactivez la couleur. Les messages colorés à l’origine sont préfixés par DEBUG, INFOWARNING et ERROR. Cette valeur booléenne contourne le problème d’une bibliothèque tierce où la couleur du terminal ne peut pas revenir après une stdout redirection.
clients	avertissement_affichage_secrets	booléen	Activez/désactivez l’avertissement pour la sortie des informations sensibles.
journalisation	enable_log_file	booléen	Activez/désactivez la journalisation.
	répertoire_logs	ficelle	Répertoire où écrire les journaux de logs. Par défaut, cette valeur est ${AZURE_CONFIG_DIR}/logs*.
Par défaut	groupe	ficelle	Groupe de ressources par défaut à utiliser pour toutes les commandes.
	lieu	ficelle	Emplacement par défaut à utiliser pour toutes les commandes.
	Web	ficelle	Nom d'application à utiliser par défaut pour les commandes az webapp.
	VM	ficelle	Nom par défaut de machine virtuelle à utiliser pour les commandes az vm.
	vmss	ficelle	Nom de l'ensemble de machines virtuelles par défaut à utiliser pour az vmss les commandes.
	ACR.	ficelle	Nom du registre de conteneurs par défaut à utiliser pour les commandes az acr.
stockage	compte	ficelle	Nom du compte de stockage par défaut (par exemple, mystorageaccount inhttps://mystorageaccount.blob.core.windows.net) à utiliser pour az storage les commandes de plan de données (par exemple). az storage container list
	clé	ficelle	Clé d’accès par défaut pour les commandes du plan de données az storage.
	jeton SAS	ficelle	Jeton SAP par défaut à utiliser pour az storage les commandes de plan de données.
	chaîne_de_connexion	ficelle	Chaîne de connexion par défaut à utiliser pour az storage les commandes de plan de données.
batchai	compte_de_stockage	ficelle	Compte de stockage par défaut à utiliser pour az batchai les commandes.
	clé_de_stockage	ficelle	Clé de stockage par défaut à utiliser pour les commandes az batchai.
lot	compte	ficelle	Nom de compte Azure Batch par défaut à utiliser pour les commandes az batch.
	clé_d'accès	ficelle	Clé d’accès par défaut à utiliser pour les commandes az batch. Utilisé uniquement avec l’autorisation aad.
	point de terminaison	ficelle	Point de terminaison par défaut auquel se connecter pour les commandes az batch.
	auth_mode	ficelle	Mode d’autorisation à utiliser pour les commandes de az batch. Valeurs autorisées : shared_key, aad.
nuage	nom	ficelle	Cloud par défaut pour toutes les az commandes. Valeurs autorisées : AzureCloud (par défaut), AzureChinaCloud, AzureUSGovernment. Pour modifier les clouds, vous pouvez utiliser la az cloud set -–name commande. Pour obtenir un exemple, consultez Gérer les clouds avec Azure CLI.
extension	use_dynamic_install	ficelle	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.
	exécuter_après_installation_dynamique	booléen	Continuez à exécuter la commande lorsqu’une extension est installée dynamiquement pour celle-ci. La valeur par défaut est False.
	index_url	ficelle	URL du fichier d’index d’extension privée suivant le format dans index.json. Une fois spécifié, l’exécution az extension add --name <extension-name> utilise ce fichier pour rechercher l’extension à ajouter.

Remarque

Vous pouvez voir d’autres valeurs dans votre fichier de configuration, mais elles sont gérées directement via des commandes CLI, notamment az config. Les valeurs répertoriées dans la table sont les seules valeurs que vous devez changer vous-même.