Azure Sphere CLI 支持的输出格式

项目
09/27/2024

重要

这是 Azure Sphere（旧版）文档。 Azure Sphere（旧版）将于 2027 年 9 月 27 日停用，用户此时必须迁移到 Azure Sphere（集成）。 使用位于 TOC 上方的版本选择器查看 Azure Sphere（集成）文档。

Azure Sphere CLI 支持多种格式，可在其中查看数据。默认情况下，它用作 table 显示 CLI 输出的默认格式，但也支持其他格式。

注意

为命令显示的输出可能因不同的输出类型而异。

参数值和输出类型为：

输出格式	说明
`table`	将键作为列标题的 ASCII 表。这是默认格式。
`json`	JSON 字符串。
`jsonc`	彩色 JSON。
`yaml`	YAML，一种机器可读的 JSON 替代格式。
`yamlc`	着色 YAML。
`tsv`	不带键的制表符分隔值。
`none`	除了错误和警告之外，没有输出。

支持的命令

可以使用 <a0/> 或 -o> 指定命令--output所需的输出格式。如果缺少需要编写脚本的命令，请通过 azsphere 反馈告知我们。以下命令支持它：

表输出格式

该 table 格式是将输出打印为 ASCII 表的默认格式，便于读取和扫描。当需要快速、可人工搜索的数据概述时，最好使用此格式。它可用于获取重点信息的摘要，尤其是列表命令。

azsphere tenant list --output table
 ------------------------------------ --------------------- -------------
 Id                                   Name                  Roles
 ========================================================================
 143adbc9-1bf0-4be2-84a2-084a331d81cb MyTenant               Contributor
 ------------------------------------ --------------------- -------------
 768c2cd6-059a-49ad-9f53-89f5271cea15 MyTenant1              Administrator
                                                             Contributor
 ------------------------------------ --------------------- -------------

可以使用 --query 参数自定义要在输出中显示的属性和列。以下示例演示如何在列表命令中选择 TenantID 和 Role。

azsphere tenant list --query '[].{TenantID:id, Role:roles}'
 ------------------------------------ -------------
 TenantID                             Role
 ==================================================
 143adbc9-1bf0-4be2-84a2-084a331d81cb Contributor
 ------------------------------------ -------------
 183adhc9-a5c8-8he2-84a2-c4f00f73a471 Administrator
                                      Contributor
 ------------------------------------ -------------

注意

以 JSON 格式运行命令，查看要在查询中使用的可用属性名称。例如，运行 azsphere tenant list --output json 命令时，输出会显示可用于该命令的名称和值。
默认情况下，嵌套对象、某些键和字段不会打印在表输出中。如果需要在输出中查看这些键，可以使用 JMESPath 重新键入功能更改键名称，并避免筛选。有关使用查询筛选数据的详细信息，请参阅 Query CLI 命令输出。

JSON 输出格式

JSON 输出格式包括结构化格式的所有原始数据和嵌套数据。建议使用 JSON 输出进行简洁的输出和脚本编写。仅当命令成功并返回 0 时，这才适用。

以下示例以默认 JSON 格式显示租户列表。

azsphere tenant list --output json
[
  {
    "id": "143adbc9-1bf0-4be2-84a2-084a331d81cb",
    "name": "MyTenant",
    "roles": [
      "Contributor"
    ]
  },
  {
    "id": "768c2cd6-059a-49ad-9f53-89f5271cea15",
    "name": "MyTenant1",
    "roles": [
      "Administrator",
      "Contributor"
    ]
  }
]

YAML 输出格式

yaml 格式将输出打印为 YAML（一种纯文本数据序列化格式）。 YAML 往往比 JSON 更容易读取。

azsphere tenant list --output yaml
- id: 143adbc9-1bf0-4be2-84a2-084a331d81cb
  name: MyTenant
  roles:
  - Contributor
- id: 768c2cd6-059a-49ad-9f53-89f5271cea15
  name: MyTenant1
  roles:
  - Administrator
  - Contributor

TSV 输出格式

输出 tsv 格式返回制表符分隔值和换行符分隔的值，而不返回其他格式、键或其他符号。输出 tsv 类似于输出， table 但以以下方式不同：

列标题不会显示在输出中 tsv 。
输出 table 显示列表并 tsv 显示列表的长度。
嵌套对象不会在输出中 tsv 打印。
输出 tsv 是制表符分隔的，无法缩放以适应终端。

azsphere tenant list --output tsv
143adbc9-1bf0-4be2-84a2-084a331d81cb    MyTenant    1
768c2cd6-059a-49ad-9f53-89f5271cea15    MyTenant1    2

通过