Azure Sphere CLI でサポートされている出力形式

[アーティクル]
09/27/2024

重要

これは Azure Sphere (レガシ) のドキュメントです。 Azure Sphere (レガシ) は 2027 年 9 月 27 日に再提供されておりユーザーは現時点で Azure Sphere (統合) に移行する必要があります。 TOC の上にある Version セレクターを使用して、Azure Sphere (統合) のドキュメントを表示します。

Azure Sphere CLI では、データを表示できるいくつかの形式がサポートされています。既定では、CLI 出力を表示するための既定の形式として table が使用されますが、他の形式もサポートされています。

Note

コマンドに表示される出力は、出力の種類によって異なる場合があります。

引数の値と出力の種類は次のとおりです。

出力書式	説明
`table`	列見出しとしてキーが使用されている ASCII テーブル。これは既定の形式です。
`json`	JSON 文字列。
`jsonc`	色付けされた JSON。
`yaml`	YAML。JSON に代わる、コンピューターが読み取り可能な形式。
`yamlc`	色分けされた YAML。
`tsv`	キーのないタブ区切りの値。
`none`	エラーと警告以外の出力はありません。

サポートされているコマンド

--output、--out、または-oを使用して、コマンドに必要な出力形式を指定できます。スクリプトを作成する必要があるコマンドが見つからない場合は、 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 パラメーターを使用して、出力に表示するプロパティと列をカスタマイズできます。次の例は、list コマンドで TenantID とロールのみを選択する方法を示しています。

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

Note

コマンドを 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

次の方法で共有