共用方式為

如何在 Azure CLI 中使用全域參數

  • 發行項

當您使用 Azure CLI 參考命令時，大部分命令都有可用的自變數。 這些自變數稱為「全域參數」，因為幾乎所有的 Azure CLI 參考命令都很常見。

--help global 參數

若要取得參考群組或命令的相關信息，請使用 --help 全域參數。 參數會在 --help 您的控制台中顯示 Azure CLI 參考資訊，包括可用的子群組和參數清單。

az group create --name myResourceGroup --location eastus --help

此處顯示的下列主控台輸出已省略欄位，以求簡潔：

Command
    az group create : Create a new resource group.

Arguments
    --location -l                 [Required] : Location. Values from: `az account list-locations`.
                                               You can configure the default location using `az
                                               configure --defaults location=<location>`.
    --name --resource-group -g -n [Required] : Name of the new resource group.
    --managed-by                             : The ID of the resource that manages this resource
                                               group.
    --tags                                   : Space-separated tags: key[=value] [key[=value] ...].
                                               Use "" to clear existing tags.

Global Arguments
    --debug                                  : Increase logging verbosity to show all debug logs.
    --help -h                                : Show this help message and exit.
    --only-show-errors                       : Only show errors, suppressing warnings.

Examples
    Create a new resource group in the West US region.
        az group create -l westus -n MyResourceGroup

--verbose global 參數

藉由將全域參數新增 --verbose 至您的參考命令，以深入瞭解記錄的詳細數據。 嘗試瞭解特定命令執行所花費的時間比其他人長時，詳細信息輸出會很有説明。

az group create --name myResourceGroup --location eastus --verbose

此處顯示的下列控制台輸出已省略欄位以求簡潔，但請注意運行時間的其他資訊。

{...}
Command ran in 1.413 seconds (init: 0.487, invoke: 0.926)

--debug global 參數

如果參數的額外詳細數據 --verbose 不足，而且您想要檢視整個記錄檔，請使用 --debug 全域參數。 也提供提交 Bug 報告時所產生的 --debug 輸出。

az group create --name myrResourceGroup --location eastus --debug

此處顯示的下列主控台輸出已省略欄位，以求簡潔：


cli.knack.cli: Command arguments: ['group', 'create', '--name', 'myResourceGroup', '--location', 'eastus', '--debug']
cli.knack.cli: __init__ debug log:
[...]
cli.knack.cli: Event: CommandInvoker.OnTransformResult [<function _resource_group_transform at 0x000001D9B72123B0>, <function _x509_from_base64_to_hex_transform at 0x000001D9B7212440>]
cli.knack.cli: Event: CommandInvoker.OnFilterResult []
{...}
[...]
telemetry.process: Return from creating process
telemetry.main: Finish creating telemetry upload process.

--only-show-errors global 參數

在偵錯過程中，使用全域參數移除 reference 命令所傳回的 --only-show-errors 警告。

az interactive

輸出主控台：

**This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus**

Any comments or concerns? You can use the 'feedback' command! We would greatly appreciate it.

A new Recommender is added which can make the completion ability more intelligent and provide the scenario completion!
If you want to disable this feature, you can use 'az config set interactive.enable_recommender=False' to disable it.

A command preload mechanism was added to prevent lagging and command run errors.
You can skip preloading in a single pass by CTRL+C or turn it off by setting 'az config set interactive.enable_preloading=False'

Loading command table... Expected time around 1 minute.

--subscription global 參數

您可以使用 --subscription 全域參數來設定命令的特定訂用帳戶。 下列範例會使用訂用帳戶標識碼來變更使用中的訂用帳戶：

az account set --subscription "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

--output global 參數

若要以特定格式顯示命令的輸出，請指定 --output 全域參數。 在這裡範例中，輸出會顯示為資料表：

注意

輸出的接受值為：json、jsonc、none、table、tsv、yaml 和 yamlc。 默認輸出值為 json。

az vm list --resource-group myResourceGroup --output table

輸出主控台：

Name    ResourceGroup    Location
------  ---------------  ----------
myVm    myResourceGroup  eastus

若要深入瞭解不同的輸出格式，請參閱 Azure CLI 命令的輸出格式。

--query global 參數

有時候，輸出主控台可能會顯示您需要篩選的大量資訊。 若要這樣做，請使用 --query 全域參數在命令的結果上執行 JMESPath 查詢 。 JMESPath 是 JSON 的查詢語言，可讓您從 Azure CLI 輸出中選取和修改數據。

此範例會藉由新增 --query，傳回授權連線到虛擬機的 SSH 公鑰：

 az vm show --resource-group myResourceGroup --name myVm --query "osProfile.linuxConfigurat
ion.ssh.publicKeys"

輸出主控台：

[
  {
    "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC7WbiMEsB0iwdGPjeGXs3UWFtzbCkUwtIxzkIOpEtlqkLGa0XQdvwhzok6szq6Ycx/f4cfid/yrmBPtzmxdQnGeCy2FOcVIzp+SkjIUg/Ez2YyDcMb60u66QUmHPRyhipJ/PDZROt6O0092qfTkTjB+7hLRiZzV2raLjiQ95eV0AXUP+Gsvdo/7ytqWNIm3iQTWbQ/GwSg+p0v+kmZELIbrxo845dambSpgBL8g0wCUZaptru3ZHo9m0UWbFPASVJKauhfPCSVPQCaOCaAdB01Ih8QDVRCazT+jyV6GgTwUIXVQthVBbt56ibhuSUdf0cWF8IVncjH+WXexVAhQw0j",
    "path": "/home/yourName/.ssh/authorized_keys"
  }
]

若要深入了解查詢命令輸出，請參閱 如何使用 JMESPath 查詢來查詢 Azure CLI 命令輸出。

另請參閱