通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

如何使用 Azure CLI 中的全局参数

  • 项目

使用 Azure CLI 引用命令时，有可用于大多数命令的参数。 这些参数称为“全局参数”，因为它们几乎适用于所有 Azure CLI 引用命令。

--help 全局参数

若要获取有关引用组或命令的信息，请使用 --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 全局参数

通过向 --verbose 引用命令添加全局参数，详细了解日志记录的详细信息。 尝试了解某些命令执行时间比其他人长的原因时，详细输出非常有用。

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

此处显示的以下控制台输出为简洁起见而省略了字段，但请注意有关执行时间的其他信息。

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

--debug 全局参数

如果参数的额外详细信息 --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 全局参数

在调试过程中，使用 --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 全局参数

可以使用 --subscription 全局参数为命令设置特定订阅。 以下示例使用订阅 ID 更改活动订阅：

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

--output 全局参数

若要以特定格式显示命令的输出，请指定 --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 全局参数

有时，输出控制台可能会显示需要筛选的大量信息。 为此，请使用 --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 命令输出。

另请参阅