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`	錯誤和警告以外的輸出。

支援的命令

您可以使用、 --out或 -o指定命令--output的必要輸出格式。如果缺少您需要編寫腳本的命令，請使用 azsphere 意見反應讓我們知道。下列命令支援：

Table 輸出格式

此 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 參數來自定義您想要在輸出中顯示的屬性和資料行。下列範例示範如何只選取 list 命令中的 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 重新編製索引鍵功能來變更金鑰名稱，並避免篩選。如需使用查詢來篩選數據的詳細資訊，請參閱查詢 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

共用方式為