Azure CLI-Konfiguration
Die Azure CLI ermöglicht die Benutzerkonfiguration von Einstellungen, z.B. Protokollierung, Datensammlung und Standardargumentwerte. Die CLI verfügt über einen praktischen Befehl für die Verwaltung einiger Standardwerte (az config
) sowie eine interaktive Option über az init
. Andere Werte können in einer Konfigurationsdatei oder mit Umgebungsvariablen festgelegt werden. Dieser Artikel enthält weitere Informationen zu diesen Benutzerkonfigurationseinstellungen sowie zum Konfigurieren der Azure CLI.
Von der CLI verwendete Konfigurationswerte werden in der folgenden Reihenfolge ausgewertet. Die Liste ist nach absteigender Priorität sortiert.
- Befehlszeilenparameter
- Umgebungsvariablen
- In der Konfigurationsdatei mit
az config
oderaz init
festgelegte Werte
Konfigurieren von Einstellungen mithilfe von az init
Die einfachste Möglichkeit zum Festlegen von Azure CLI-Konfigurationen besteht darin, den interaktiven Befehl az init zu verwenden. Wählen Sie eine allgemeine Konfiguration wie „Interaktion“ oder „Automatisierung“ aus oder durchlaufen Sie einzelne Konfigurationsschritte. Besonders hilfreich bei diesem Ansatz ist, dass az init
Gründe liefert, warum Sie eine Konfigurationsoption einer anderen vorziehen sollten.
az init
Konfigurieren von Einstellungen mithilfe von az config
Standardwerte für die CLI können mithilfe des Befehls az config set festgelegt werden.
Dieser Befehl akzeptiert eine durch Leerzeichen getrennte Liste mit Schlüssel-Wert-Paaren (key=value
) als Argument. Die angegebenen Werte werden von der Azure CLI anstelle von erforderlichen Argumenten verwendet.
Die folgende Tabelle enthält eine Liste der verfügbaren Konfigurationsschlüssel.
Name | Beschreibung |
---|---|
defaults.group | Die Standardressourcengruppe für alle Befehle. |
defaults.location | Der Standardstandort für alle Befehle. |
defaults.web | Der Standard-App-Name für az webapp -Befehle. |
defaults.vm | Der Standard-VM-Name für az vm -Befehle. |
defaults.vmss | Der Standardname einer VM-Skalierungsgruppe (VMSS), der für az vmss -Befehle verwendet wird |
defaults.acr | Der standardmäßige Containerregistrierungsname für az acr -Befehle. |
Das folgende Beispiel zeigt, wie Sie die Standardressourcengruppe und den Standardstandort für alle Befehle festlegen.
az config set defaults.location=westus2 defaults.group=MyResourceGroup
Der folgende Befehl deaktiviert die Umfragelinks beim Ausführen der Azure CLI-Befehle:
az config set output.show_survey_link=no
CLI-Konfigurationsdatei
Die CLI-Konfigurationsdatei enthält weitere Einstellungen für die Verwaltung des CLI-Verhaltens. Sie befindet sich unter $AZURE_CONFIG_DIR/config
. AZURE_CONFIG_DIR
hat standardmäßig den Wert $HOME/.azure
(Linux und macOS) bzw. %USERPROFILE%\.azure
(Windows).
Konfigurationsdateien sind im INI-Dateiformat geschrieben. Abschnittsheader definieren das Dateiformat, gefolgt von einer Liste von Schlüssel-Wert-Einträgen.
- Abschnittsheader werden als
[section-name]
geschrieben. Bei Abschnittsnamen wird zwischen Groß- und Kleinschreibung unterschieden. - Einträge werden als
key=value
geschrieben. Bei Schlüsselnamen wird die Groß-/Kleinschreibung nicht beachtet. - Zeilen, die mit
#
oder;
beginnen, sind Kommentare. Inlinekommentare sind nicht zulässig.
Bei booleschen Werten wird die Groß-/Kleinschreibung nicht beachtet. Die folgenden Werte stellen boolesche Werte dar:
- True:
1
,yes
,true
,on
- False:
0
,no
,false
,off
Das folgende Beispiel zeigt eine CLI-Konfigurationsdatei, die sämtliche Bestätigungsaufforderungen deaktiviert und eine Protokollierung im Verzeichnis /var/log/azure
einrichtet.
[core]
disable_confirm_prompt=Yes
[logging]
enable_log_file=yes
log_dir=/var/log/azure
Ausführliche Informationen zu allen verfügbaren Konfigurationswerten und zu deren Bedeutung finden Sie im nächsten Abschnitt. Umfassende Details zum INI-Dateiformat finden Sie in der Python-Dokumentation zu INI.
CLI-Konfigurationswerte und Umgebungsvariablen
Die folgende Tabelle enthält sämtliche Abschnitte und Optionsnamen, die in einer Konfigurationsdatei verwendet werden können. Die entsprechenden Umgebungsvariablen werden als AZURE_{section}_{name}
(in Großbuchstaben) festgelegt. Der output
-Standardwert für core
wird beispielsweise in der Variablen AZURE_CORE_OUTPUT
, der storage_account
-Standardwert für batchai
in der Variablen AZURE_BATCHAI_STORAGE_ACCOUNT
und der location
-Standardwert in der Variablen AZURE_DEFAULTS_LOCATION
festgelegt.
Wenn Sie einen Standardwert angeben, wird dieses Argument von keinem Befehl mehr benötigt. Stattdessen wird der Standardwert verwendet.
`Section` | Name | Typ | BESCHREIBUNG |
---|---|---|---|
core | output | Zeichenfolge | Das Standardausgabeformat. Zulässige Werte: json (Standard), jsonc , yaml , yamlc , table , tsv , none . Weitere Informationen finden Sie unter Ausgabeformate für Azure CLI-Befehle. |
disable_confirm_prompt | boolean | Dient zum Aktivieren/Deaktivieren von Bestätigungsaufforderungen. | |
display_region_identified | boolean | Azure-Kunden können sich für die Bereitstellung von Ressourcen in vielen verschiedenen Regionen entscheiden. In einigen Fällen können Kunden die Kosten senken, indem sie Regionen in der Nähe auswählen, die die gleichen Dienste anbieten. Wenn eine Region in der Nähe bestimmt wird, wird eine Meldung angezeigt, die Region für zukünftige Bereitstellungen auszuwählen. Diese Einstellung steuert, ob die Nachricht angezeigt wird. | |
collect_telemetry | boolean | Erlaubt Microsoft das Sammeln anonymer Daten zur Verwendung der CLI. Informationen zum Datenschutz finden Sie in der MIT-Lizenz für die Azure CLI. | |
only_show_errors | boolean | Fehler nur beim Befehlsaufruf anzeigen. Anders ausgedrückt: In stderr werden nur Fehler geschrieben. Warnungen aus der Vorschau bzw. aus veralteten und experimentellen Befehlen werden unterdrückt. Auch für einzelne Befehle mit dem Parameter --only-show-errors verfügbar |
|
enable_broker_on_windows | boolean | Verwenden Sie Web Account Manager (WAM), um sich über den az login Befehl bei Azure zu authentifizieren. |
|
login_experience_v2 | boolean | Aktivieren/Deaktivieren der az login Abonnementauswahl. |
|
no_color | boolean | Farbe deaktivieren. Ursprünglich farbigen Nachrichten wird die Präfixe DEBUG , INFO , WARNING und ERROR vorangestellt. Dieser Boolesche Wert umgeht das Problem einer Bibliothek eines Drittanbieters, bei dem die Farbe des Terminals nach einer stdout -Umleitung nicht mehr zurückgesetzt werden kann. |
|
Kunden | show_secrets_warning | boolean | Schalten Sie die Warnung für die Ausgabe vertraulicher Informationen ein/aus. |
logging | enable_log_file | boolean | Dient zum Aktivieren/Deaktivieren der Protokollierung. |
log_dir | Zeichenfolge | Das Verzeichnis, in das Protokolle geschrieben werden sollen. Standardmäßig ist dieser Wert auf ${AZURE_CONFIG_DIR}/logs* festgelegt. |
|
defaults | group | Zeichenfolge | Die Standardressourcengruppe für alle Befehle. |
location | Zeichenfolge | Der Standardstandort für alle Befehle. | |
Web- | Zeichenfolge | Der Standard-App-Name für az webapp -Befehle. |
|
vm | Zeichenfolge | Der Standard-VM-Name für az vm -Befehle. |
|
vmss | Zeichenfolge | Der Standardname einer VM-Skalierungsgruppe (VMSS), der für az vmss -Befehle verwendet wird |
|
acr | Zeichenfolge | Der standardmäßige Containerregistrierungsname für az acr -Befehle. |
|
storage | account | Zeichenfolge | Der Standardname des Speicherkontos (z. B. mystorageaccount in https://mystorageaccount.blob.core.windows.net ) zur Nutzung in Datenebenenbefehlen vom Typ az storage (z. B. az storage container list ). |
Schlüssel | Zeichenfolge | Der Standardzugriffsschlüssel für az storage -Datenebenenbefehle |
|
sas_token | Zeichenfolge | Das SAS-Standardtoken für az storage -Datenebenenbefehle |
|
connection_string | Zeichenfolge | Die Standardverbindungszeichenfolge für az storage -Datenebenenbefehle |
|
batchai | storage_account | Zeichenfolge | Das Standardspeicherkonto für az batchai -Befehle. |
storage_key | Zeichenfolge | Der Standardspeicherschlüssel für az batchai -Befehle. |
|
batch | account | Zeichenfolge | Der Azure Batch-Standardkontoname für az batch -Befehle. |
access_key | Zeichenfolge | Der Standardzugriffsschlüssel für az batch -Befehle. Wird nur für die aad -Autorisierung verwendet. |
|
endpoint | Zeichenfolge | Der Standardendpunkt für az batch -Befehle, mit dem eine Verbindung hergestellt werden soll. |
|
auth_mode | Zeichenfolge | Der Autorisierungsmodus für az batch -Befehle. Zulässige Werte: shared_key , aad . |
|
cloud | name | Zeichenfolge | Die Standardcloud für alle az -Befehle. Zulässige Werte: AzureCloud (Standard), AzureChinaCloud , AzureUSGovernment . Zum Ändern von Clouds können Sie den Befehl az cloud set –name verwenden. Ein Beispiel finden Sie unter Verwalten von Clouds mit der Azure CLI. |
extension | use_dynamic_install | Zeichenfolge | Installiert eine Erweiterung, wenn sie noch nicht hinzugefügt wurde und ein Befehl über sie ausgeführt wird. Zulässige Werte: no (Standard), yes_prompt , yes_without_prompt . |
run_after_dynamic_install | boolean | Setzt die Befehlsausführung fort, wenn eine Erweiterung dynamisch für ihn installiert wird. Der Standardwert ist False . |
|
index_url | Zeichenfolge | URL der Indexdatei der privaten Erweiterung unter Einhaltung des Formats in index.json. Einmal angegeben, wird bei der Ausführung von az extension add --name <extension-name> diese Datei verwendet, um die hinzuzufügende Erweiterung zu finden. |
Hinweis
In Ihrer Konfigurationsdatei begegnen Ihnen möglicherweise noch andere Werte, diese werden jedoch direkt über CLI-Befehle verwaltet (einschließlich az config
). Abgesehen von den in der obigen Tabelle aufgeführten Werten sollten Sie keine anderen Werte selbst ändern.