Konfiguration av Azure CLI

  • Artikel

Azure CLI tillåter användarkonfiguration av inställningar som loggning, insamling av data och standardvärden för argument. CLI erbjuder ett bekvämlighetskommando för att hantera vissa standardvärden, az configoch ett interaktivt alternativ via az init. Andra värden kan anges i en konfigurationsfil eller med miljövariabler. Den här artikeln innehåller ytterligare information om de här användarkonfigurationsinställningarna och hur du konfigurerar Azure CLI.

Konfigurationsvärden som används av CLI utvärderas med följande prioritet, där poster som är högre upp på listan prioriteras.

  1. Kommandoradsparametrar
  2. Miljövariabler
  3. Värden i konfigurationsfiluppsättningen med az config eller az init

Konfigurera inställningar med az init

Det enklaste sättet att ange Azure CLI-konfigurationer är att använda det interaktiva kommandot az init . Välj en vanlig konfiguration som "interaktion" eller "automatisering" eller välj att gå igenom enskilda konfigurationer. Det som är särskilt användbart med den här metoden är az init varför du kanske vill välja ett konfigurationsalternativ framför ett annat.

az init

Konfigurera inställningar med az config

Du kan ange standardvärden för CLI med kommandot az config set . Det här kommandot tar en blankstegsavgränsad lista med key=value par som argument. De angivna värdena används av Azure CLI i stället för obligatoriska argument.

Följande tabell innehåller en lista över tillgängliga konfigurationsnycklar.

Name beskrivning
defaults.group Standardresursgruppen som ska användas för alla kommandon.
defaults.location Standardplatsen som ska användas för alla kommandon.
defaults.web Standardappnamnet som ska användas för alla az webapp-kommandon.
defaults.vm Standardnamnet för VM som ska användas för alla az vm-kommandon.
defaults.vmss Standardnamnet för VMSS -skalningsuppsättningen (VMSS) som ska användas för az vmss kommandon.
defaults.acr Standardcontainerregistret som ska användas för alla az acr-kommandon.

Här är ett exempel på hur du skulle ställa in standardresursgruppen och -platsen för alla kommandon.

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

Följande kommando inaktiverar undersökningslänkarna när Azure CLI-kommandona körs:

az config set output.show_survey_link=no

CLI-konfigurationsfil

CLI-konfigurationsfilen innehåller övriga inställningar som används för att hantera CLI-beteende. Själva konfigurationsfilen finns på $AZURE_CONFIG_DIR/config. Standardvärdet för AZURE_CONFIG_DIR är $HOME/.azure på Linux and macOS, och %USERPROFILE%\.azure för Windows.

Konfigurationsfiler skrivs i INI-format. Avsnittsrubriker definierar filformatet följt av en lista med nyckel/värde-poster.

  • Avsnittsrubrikerna skrivs som [section-name]. Avsnittsnamn är skiftlägeskänsliga.
  • Poster skrivs som key=value. Nyckelnamn är inte skiftlägeskänsliga.
  • Kommentarer är alla rader som börjar med # eller ;. Infogade kommentarer tillåts inte.

Booleska värden är skiftlägesokänsliga. Följande värden representerar booleska värden:

  • Sant: 1, yes, true, on
  • False: 0, no, , falseoff

Här är ett exempel på en CLI-konfigurationsfil som inaktiverar bekräftelseuppmaningar och ställer in loggning till katalogen /var/log/azure.

[core]
disable_confirm_prompt=Yes

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

I nästa avsnitt finns information om alla tillgängliga konfigurationsvärden och vad de betyder. Fullständig information om INI-filformatet finns i Python-dokumentationen om INI.

CLI-konfigurationsvärden och miljövariabler

I följande tabell finns alla avsnitt och alternativnamn som kan placera i en konfigurationsfil. Deras motsvarande miljövariabler anges som AZURE_{section}_{name}, i versaler. Standardvärdet för anges till exempel output i variabelnAZURE_CORE_OUTPUT, storage_account standardvärdet för batchai anges i variabeln AZURE_BATCHAI_STORAGE_ACCOUNT och standardvärdet location anges i variabelnAZURE_DEFAULTS_LOCATION.core

När du anger ett standardvärde krävs inte längre det argumentet av något kommando. I stället används standardvärdet.

Avsnitt Namn Type Beskrivning
kärna utdata sträng Format för standardutdata. Tillåtna värden: json (standard), jsonc, yaml, yamlc, table, tsv, . none Mer information finns i Utdataformat för Azure CLI-kommandon.
disable_confirm_prompt boolean Aktivera/inaktivera bekräftelsemeddelanden.
display_region_identified boolean Azure-kunder kan välja att distribuera resurser i många olika regioner. I vissa fall kan kunder minska kostnaderna genom att välja närliggande regioner som erbjuder samma tjänster. Om en närliggande region identifieras visar ett meddelande den region som ska väljas för framtida distributioner. Den här inställningen styr om meddelandet visas.
collect_telemetry boolean Tillåt att Microsoft samlar in anonyma data om CLI-användning. Sekretessinformation finns i Azure CLI MIT-licensen.
only_show_errors boolean Visa endast fel under kommandoanrop. Med andra ord skrivs endast fel till stderr. Den utelämnar varningar från förhandsversioner, inaktuella och experimentella kommandon. Den är också tillgänglig för enskilda kommandon med parametern --only-show-errors .
enable_broker_on_windows boolean Använd Web Account Manager (WAM) för att autentisera az login till Azure via kommandot .
login_experience_v2 boolean Aktivera/inaktivera prenumerationsväljaren az login .
no_color boolean Inaktivera färg. Ursprungligen färgade meddelanden är prefix med DEBUG, INFOWARNING och ERROR. Det här booleska objektet kringgår problemet med ett bibliotek från tredje part där terminalens färg inte kan återställas efter en stdout omdirigering.
Klienter show_secrets_warning boolean Aktivera/inaktivera varningen för känslig information.
loggning enable_log_file boolean Slå på/av loggning.
log_dir sträng Katalogen som loggar ska skrivas i. Det här värdet är som standard ${AZURE_CONFIG_DIR}/logs*.
Standardvärden grupp sträng Standardresursgruppen som ska användas för alla kommandon.
plats sträng Standardplatsen som ska användas för alla kommandon.
webb sträng Standardappnamnet som ska användas för alla az webapp-kommandon.
vm sträng Standardnamnet för VM som ska användas för alla az vm-kommandon.
vmss sträng Standardnamnet för VMSS -skalningsuppsättningen (VMSS) som ska användas för az vmss kommandon.
acr sträng Standardcontainerregistret som ska användas för alla az acr-kommandon.
lagring konto sträng Standardnamnet för lagringskontot (till exempel mystorageaccount i https://mystorageaccount.blob.core.windows.net) som ska användas för az storage dataplanskommandon (till exempel az storage container list).
nyckel sträng Standardåtkomstnyckeln som ska användas för az storage dataplanskommandon.
sas_token sträng Standard-SAS-token som ska användas för az storage dataplanskommandon.
connection_string sträng Standard anslutningssträng som ska användas för az storage dataplanskommandon.
batchai storage_account sträng Standardlagringsnyckeln som ska användas för az batchai-kommandon.
storage_key sträng Standardlagringsnyckeln som ska användas för az batchai-kommandon.
batch konto sträng Azure Batch-standardnamn som ska användas för az batch-kommandon.
access_key sträng Standardåtkomstnyckeln som ska användas för az batch-kommandon. Ska endast användas med aad-auktorisering.
slutpunkt sträng Standardslutpunkten att ansluta till för az batch-kommandon.
auth_mode sträng Verifieringsläge som ska användas för az batch-kommandon. Tillåtna värden: shared_key, aad.
Moln name sträng Standardmolnet för alla az kommandon. Tillåtna värden: AzureCloud (standard), AzureChinaCloud, AzureUSGovernment. Om du vill ändra moln kan du använda az cloud set –name kommandot . Ett exempel finns i Hantera moln med Azure CLI.
Förlängning use_dynamic_install sträng Installera ett tillägg om det inte har lagts till ännu när du kör ett kommando från det. Tillåtna värden: no (standard), yes_prompt, yes_without_prompt.
run_after_dynamic_install boolean Fortsätt att köra kommandot när ett tillägg installeras dynamiskt för det. Standard är False.
index_url sträng URL för privat tilläggsindexfil som följer formatet i index.json. När filen har angetts az extension add --name <extension-name> används filen för att hitta tillägget som ska läggas till.

Kommentar

Det kan finnas andra värden i din konfigurationsfil, men de hanteras direkt via CLI-kommandon, däribland az config. De som angavs i tabellen tidigare är de enda värden som du bör ändra själv.