Utdataformat som stöds för Azure Sphere CLI

Artikel
08/09/2023

Azure Sphere CLI har stöd för flera format där data kan visas. Som standard används table det som standardformat för visning av CLI-utdata, men har också stöd för andra format.

Observera

Resultatet som visas för ett kommando kan variera för olika utdatatyper.

Argumentvärdena och utdatatyperna är:

Utdataformat	Beskrivning
`table`	ASCII-tabell med tangenter som kolumnrubriker. Det här är standardformatet.
`json`	JSON-sträng.
`jsonc`	Färgläggande JSON.
`yaml`	YAML, ett maskinläsbart alternativ till JSON.
`yamlc`	Färglagd YAML.
`tsv`	Tabbavgränsade värden utan tangenter.
`none`	Inga andra utdata än fel och varningar.

Kommandon som stöds

Du kan ange det utdataformat som krävs för kommandot med hjälp av --output, --out, eller -o. Om vi saknar ett kommando som du behöver skript kan du meddela oss med azsfärfeedback. Det stöds för följande kommandon:

Tabellutdataformat

Formatet table är standardformatet som skriver ut utdata som en ASCII-tabell, vilket gör det enkelt att läsa och skanna. Det här formatet är bäst när du vill ha en snabb, människosökbar översikt över data. Det är användbart för att få en sammanfattning av prioriterad information, särskilt för listkommandon.

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

Du kan använda parametern --query för att anpassa de egenskaper och kolumner som du vill visa i utdata. I följande exempel visas hur du väljer bara TenantID och Roll i listkommandot.

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

Observera

Kör kommandot i JSON-format för att visa de tillgängliga egenskapsnamnen som ska användas i frågan. När du till exempel kör azsphere tenant list --output json kommandot visas de namn och värden som är tillgängliga för kommandot i utdata.
Kapslade objekt, vissa nycklar och fält skrivs inte ut i tabellutdata som standard. Om du behöver se dessa i utdata kan du använda funktionen JMESPath för att ändra nyckelnamnet och undvika filtrering. Mer information om hur du använder frågor för att filtrera data finns i Query CLI command output.

JSON-utdataformat

JSON-utdataformatet innehåller alla rådata och kapslade data i ett strukturerat format. Vi rekommenderar att du använder JSON-utdata för koncisa utdata och skript. Detta gäller bara när kommandot lyckas och returnerar 0.

I följande exempel visas listan över klientorganisationer i JSON-standardformatet.

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-utdataformat

Formatet yaml skriver ut utdata som YAML, ett oformaterat dataserieriseringsformat. YAML brukar vara lättare att läsa än 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-utdataformat

Utdataformatet tsv returnerar tabbavgränsade och newline-avgränsade värden utan ytterligare formatering, tangenter eller andra symboler. Utdata tsv liknar utdata table men skiljer sig åt på följande sätt:

Kolumnrubriker visas inte i utdata tsv .
Utdata table visar listan och tsv visar längden på en lista.
Kapslade objekt skrivs inte ut i utdata tsv .
Utdata tsv är flikavgränsade och skalas inte så att de passar terminalen.

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

Dela via