共用方式為


Azure CLI 設定

Azure CLI 可讓使用者設定記錄、數據收集和預設自變數值等設定。 CLI 提供方便的命令,可透過 az init管理某些預設值az config和互動式選項。 其他值可以在組態檔或環境變數中設定。 本文提供這些用戶組態設定以及如何設定 Azure CLI 的進一步資訊。

CLI 所使用的組態值會以下列優先順序進行評估,清單上的專案會優先使用。

  1. 命令列參數
  2. 環境變數
  3. 使用 az config 或設定組態檔中的值 az init

使用 az init 設定設定

設定 Azure CLI 組態最簡單的方式是使用互動式 az init 命令。 選擇一般設定,例如「互動」或「自動化」,或選擇逐步解說個別組態。 這種方法特別有説明的原因在於 az init ,您可能想要選擇一個組態選項來取代另一個組態選項。

az init

使用 az config 設定設定

您可以使用 az config set 命令來設定 CLI 的預設值。 此命令會採用以空格分隔的 key=value 配對清單做為自變數。 Azure CLI 會使用所提供的值來取代必要的自變數。

下表包含可用的組態金鑰清單。

名稱 描述
defaults.group 要用於所有命令的預設資源群組。
defaults.location 用於所有命令的預設位置。
defaults.web 要用於 az webapp 命令的預設應用程式名稱。
defaults.vm 要用於 az vm 命令的預設 VM 名稱。
defaults.vmss 要用於 az vmss 命令的預設虛擬機擴展集 (VMSS) 名稱。
defaults.acr 用於命令的預設容器登錄名稱 az acr

例如,以下是設定所有命令的預設資源群組和位置的方式。

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

下列命令會在執行 Azure CLI 命令時關閉問卷連結:

az config set output.show_survey_link=no

CLI 組態檔

CLI 組態檔包含用於管理 CLI 行為的其他設定。 組態檔本身位於 $AZURE_CONFIG_DIR/config。 的預設值 AZURE_CONFIG_DIR 位於 $HOME/.azure Linux和macOS上,以及 %USERPROFILE%\.azure Windows 上。

組態檔是以 INI 檔案格式撰寫。 區段標頭會定義檔案格式,後面接著索引鍵/值項目清單。

  • 區段標頭會寫入為 [section-name]。 區段名稱區分大小寫。
  • 項目會寫入為 key=value。 索引鍵名稱不區分大小寫。
  • 批注是以 或 ;開頭#的任何行。 不允許內嵌批注。

布爾值不區分大小寫。 下列值代表布爾值:

  • True1、、 yestrueon
  • False0、、 nofalseoff

以下是 CLI 組態檔的範例,該設定檔會停用任何確認提示,並設定記錄至 /var/log/azure 目錄。

[core]
disable_confirm_prompt=Yes

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

如需所有可用組態值及其意義的詳細數據,請參閱下一節。 如需 INI 檔格式的完整詳細數據,請參閱 INI 上的 Python 檔。

CLI 組態值和環境變數

下表包含可在組態檔中放置的所有區段和選項名稱。 對應的環境變數在所有上限中都會設定為 AZURE_{section}_{name}。 例如,output預設值core是在變數中AZURE_CORE_OUTPUT設定,storage_accountbatchai預設值是在變數中AZURE_BATCHAI_STORAGE_ACCOUNT設定,而預設值location則是在變數中AZURE_DEFAULTS_LOCATION設定。

當您提供預設值時,任何命令都不再需要該自變數。 相反地,會使用預設值。

區段​​ 名稱 類型​​ 描述
核心 output 字串 默認輸出格式。 允許的值: json (預設值)、jsonc、、、yamltsvyamlctablenone。 如需詳細資訊,請參閱 Azure CLI 命令的輸出格式
disable_confirm_prompt boolean 開啟/關閉確認提示。
display_region_identified boolean Azure 客戶可以選擇在許多不同的區域中部署資源。 在某些情況下,客戶可以藉由選取提供相同服務的鄰近區域來降低成本。 如果識別附近的區域,訊息會顯示要選取以供未來部署的區域。 此設定可控制訊息是否顯示。
collect_telemetry boolean 允許 Microsoft 收集 CLI 使用量的匿名數據。 如需隱私權資訊,請參閱 Azure CLI MIT 授權
only_show_errors boolean 只在命令調用期間顯示錯誤。 換句話說,只會將錯誤寫入 stderr。 它會隱藏預覽、已淘汰和實驗命令的警告。 它也可用於具有 參數的 --only-show-errors 個別命令。
enable_broker_on_windows boolean 使用 Web 帳戶管理員 (WAM) 透過 命令向 Azure az login 進行驗證。
login_experience_v2 boolean 開啟/關閉訂用 az login 帳戶選取器。
no_color boolean 停用色彩。 原始色彩的訊息前面會加上DEBUGINFOWARNINGERROR。 此布爾值會略過第三方連結庫的問題,其中終端機的色彩無法在重新導向之後 stdout 回復。
客戶 show_secrets_warning boolean 開啟/關閉敏感性信息輸出的警告。
測 井 enable_log_file boolean 開啟/關閉記錄。
log_dir 字串 要寫入記錄檔的目錄。 根據預設,此值為 ${AZURE_CONFIG_DIR}/logs*
違約 群組 字串 要用於所有命令的預設資源群組。
location 字串 用於所有命令的預設位置。
web 字串 要用於 az webapp 命令的預設應用程式名稱。
vm 字串 要用於 az vm 命令的預設 VM 名稱。
vmss 字串 要用於 az vmss 命令的預設虛擬機擴展集 (VMSS) 名稱。
Acr 字串 用於命令的預設容器登錄名稱 az acr
存儲 account 字串 用於資料平面命令的預設記憶體帳戶名稱(例如,in https://mystorageaccount.blob.core.windows.net中的 mystorageaccount)。az storageaz storage container list
索引鍵 字串 用於數據平面命令的預設存取金鑰 az storage
sas_token 字串 用於數據平面命令的預設 SAS 令牌 az storage
connection_string 字串 用於數據平面命令的預設 連接字串az storage
batchai storage_account 字串 要用於 az batchai 命令的預設記憶體帳戶。
storage_key 字串 要用於 az batchai 命令的預設記憶體金鑰。
account 字串 要用於 az batch 命令的預設 Azure Batch 帳戶名稱。
access_key 字串 要用於 az batch 命令的預設存取金鑰。 僅搭配 aad 授權使用。
endpoint 字串 用於命令的預設端點 az batch
auth_mode 字串 要用於 az batch 命令的授權模式。 允許的值: shared_keyaad
NAME 字串 所有 az 命令的預設雲端。 允許的值: AzureCloud (預設值)、 AzureChinaCloudAzureUSGovernment。 若要變更雲端,您可以使用 az cloud set –name 命令。 如需範例,請參閱 使用 Azure CLI 管理雲端。
擴展 use_dynamic_install 字串 如果尚未從它執行命令,請安裝擴充功能。 允許的值: no (預設值)、 yes_promptyes_without_prompt
run_after_dynamic_install boolean 當擴充功能為它動態安裝時,請繼續執行命令。 預設值為 False
index_url 字串 遵循 index.json 格式的私人延伸模組索引檔案 URL。 指定之後,執行 az extension add --name <extension-name> 會使用該檔案來尋找要新增的擴展名。

注意

您可能會在組態檔中看到其他值,但這些值是透過 CLI 命令直接管理,包括 az config。 先前表格中列出的值是唯一應該自行變更的值。