Azure CLI 命令的输出格式

项目
10/23/2020

Azure CLI 使用 JSON 作为默认输出格式，但提供其他格式。使用 --output（--out 或 -o）参数设置 CLI 输出的格式。输出的参数值和类型为：

--output	说明
`json`	JSON 字符串。此设置为默认设置
`jsonc`	彩色 JSON
`yaml`	YAML，一种机器可读的 JSON 替代格式
`table`	将键作为列标题的 ASCII 表
`tsv`	制表符分隔值，没有键
`none`	除了错误和警告以外不输出任何内容

JSON 输出格式

以下示例以默认 json 格式显示订阅中的虚拟机列表。

az vm list --output json

以下输出有为简便起见而省略的一些字段并替换了标识信息。

[
  {
    "availabilitySet": null,
    "diagnosticsProfile": null,
    "hardwareProfile": {
      "vmSize": "Standard_DS1"
    },
    "id": "/subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/DemoVM010",
    "instanceView": null,
    "licenseType": null,
    "location": "chinaeast",
    "name": "DemoVM010",
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/.../resourceGroups/demorg1/providers/Microsoft.Network/networkInterfaces/DemoVM010VMNic",
          "primary": null,
          "resourceGroup": "demorg1"
        }
      ]
    },
          ...
          ...
          ...   
]

YAML 输出格式

yaml 格式将输出打印为 YAML（一种纯文本数据序列化格式）。 YAML 往往比 JSON 更容易阅读，并且可以轻松映射到该格式。某些应用程序和 CLI 命令将 YAML（而不是 JSON）作为配置输入。

az vm list --out yaml

以下输出有为简便起见而省略的一些字段并替换了标识信息。

- availabilitySet: null
  diagnosticsProfile: null
  hardwareProfile:
    vmSize: Standard_DS1_v2
  id: /subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/DemoVM010
  identity: null
  instanceView: null
  licenseType: null
  location: chinaeast
  name: ExampleVM1
  networkProfile:
    networkInterfaces:
    - id: /subscriptions/.../resourceGroups/DemoRG1/providers/Microsoft.Network/networkInterfaces/DemoVM010Nic
      primary: null
      resourceGroup: DemoRG1
  ...
...

表输出格式

table 格式以 ASCII 表的形式列显输出，因此可以轻松阅读和扫描输出。嵌套对象不会包含在表输出中，但仍可以作为查询的一部分进行筛选。某些字段不会包含在表中，因此，当你想要数据的快速、人工可搜索的概述时，此格式最佳。

az vm list --out table

Name         ResourceGroup    Location
-----------  ---------------  ----------
DemoVM010    DEMORG1          chinaeast
demovm212    DEMORG1          chinaeast
demovm213    DEMORG1          chinaeast
KBDemo001VM  RGDEMO001        chinaeast
KBDemo020    RGDEMO001        chinaeast

可以使用 --query 参数来自定义要在列表输出中显示的属性和列。以下示例演示如何只在 list 命令中选择 VM 名称和资源组名称。

az vm list --query "[].{ resource: resourceGroup, name: name }" -o table

Resource    Name
----------  -----------
DEMORG1     DemoVM010
DEMORG1     demovm212
DEMORG1     demovm213
RGDEMO001   KBDemo001VM
RGDEMO001   KBDemo020

Note

默认情况下，某些键不会在表视图中列显。这些键是 id、type 和 etag。如果需要在输出中查看这些键，可以使用 JMESPath 重新键入功能更改键名称，并避免筛选。

az vm list --query "[].{objectID:id}" -o table

若要详细了解如何使用查询来筛选数据，请参阅在 Azure CLI 中使用 JMESPath 查询。

TSV 输出格式

tsv 输出格式返回制表符和换行符分隔的值，而不带附加格式设置、键或其他符号。采用这种格式可在需要以某种形式处理文本的其他命令和工具中轻松使用输出。与 table 格式一样，tsv 不会列显嵌套的对象。

在前面的示例中使用 tsv 选项会输出制表符分隔结果。

az vm list --out tsv

None    None        /subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/DemoVM010 None    None    chinaeast  DemoVM010           None    Succeeded   DEMORG1 None            Microsoft.Compute/virtualMachines   cbd56d9b-9340-44bc-a722-25f15b578444
None    None        /subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/demovm212 None    None    chinaeast  demovm212           None    Succeeded   DEMORG1 None            Microsoft.Compute/virtualMachines   4bdac85d-c2f7-410f-9907-ca7921d930b4
None    None        /subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/demovm213 None    None    chinaeast  demovm213           None    Succeeded   DEMORG1 None            Microsoft.Compute/virtualMachines   2131c664-221a-4b7f-9653-f6d542fbfa34
None    None        /subscriptions/.../resourceGroups/RGDEMO001/providers/Microsoft.Compute/virtualMachines/KBDemo001VM None    None    chinaeast  KBDemo001VM         None    Succeeded   RGDEMO001   None            Microsoft.Compute/virtualMachines   14e74761-c17e-4530-a7be-9e4ff06ea74b
None    None        /subscriptions/.../resourceGroups/RGDEMO001/providers/Microsoft.Compute/virtualMachines/KBDemo020    None    chinaeast  KBDemo020           None    Succeeded   RGDEMO001   None            Microsoft.Compute/virtualMachines    36baa9-9b80-48a8-b4a9-854c7a858ece

TSV 输出格式的一个限制是不能保证输出顺序。 CLI 通过按字母顺序对响应 JSON 中的键进行排序，然后按 TSV 输出的顺序输出其值，来尽可能地保持顺序。但这并不能保证顺序始终相同，因为 Azure 服务响应格式可能会更改。

若要强制执行一致的排序，需要使用 --query 参数和多选列表格式。当 CLI 命令返回单个 JSON 字典时，请使用常规格式 [key1, key2, ..., keyN] 强制键顺序。对于返回数组的 CLI 命令，请使用常规格式 [].[key1, key2, ..., keyN] 对列值进行排序。

例如，若要按 ID、位置、资源组和 VM 名称对显示的信息进行排序，请执行以下命令：

az vm list --out tsv --query '[].[id, location, resourceGroup, name]'

/subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/DemoVM010    chinaeast    DEMORG1    DemoVM010
/subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/demovm212    chinaeast    DEMORG1    demovm212
/subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/demovm213    chinaeast    DEMORG1    demovm213
/subscriptions/.../resourceGroups/RGDEMO001/providers/Microsoft.Compute/virtualMachines/KBDemo001VM     chinaeast  RGDEMO001       KBDemo001VM
/subscriptions/.../resourceGroups/RGDEMO001/providers/Microsoft.Compute/virtualMachines/KBDemo020       chinaeast  RGDEMO001       KBDemo020

以下示例演示如何通过管道将 tsv 输出传送到 bash 中的其他命令。该查询用于筛选输出和强制排序，grep 选择其中包含文本“RGD”的项，然后 cut 命令选择第四个字段以在输出中显示 VM 的名称。

az vm list --out tsv --query '[].[id, location, resourceGroup, name]' | grep RGD | cut -f4

KBDemo001VM
KBDemo020

设置默认输出格式

使用交互式 az configure 命令设置环境并建立输出格式的默认设置。默认输出格式为 json。

az configure

Welcome to the Azure CLI! This command will guide you through logging in and setting some default values.

Your settings can be found at /home/defaultuser/.azure/config
Your current configuration is as follows:

  ...

Do you wish to change your settings? (y/N): y

What default output format would you like?
 [1] json - JSON formatted output that most closely matches API responses.
 [2] jsonc - Colored JSON formatted output that most closely matches API responses.
 [3] table - Human-readable output format.
 [4] tsv - Tab- and Newline-delimited. Great for GREP, AWK, etc.
 [5] yaml - YAML formatted output. An alternative to JSON. Great for configuration files.
 [6] none - No output, except for errors and warnings.
Please enter a choice [1]:

若要详细了解如何配置环境，请参阅 Azure CLI 配置。