Utdataformat som stöds för Azure Sphere CLI

Artikel
09/27/2024

Viktigt!

Det här är dokumentationen om Azure Sphere (Legacy). Azure Sphere (Legacy) upphör den 27 september 2027 och användarna måste migrera till Azure Sphere (integrerad) vid den här tiden. Använd versionsväljaren ovanför TOC för att visa dokumentationen om Azure Sphere (integrerad).

Azure Sphere CLI stöder flera format där data kan visas. Som standard används table det som standardformat för att visa CLI-utdata, men stöder även andra format.

Kommentar

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

Argumentvärdena och utdatatyperna är:

Utdataformat	beskrivning
`table`	ASCII-tabell med nycklar som kolumnrubriker. Det här är standardformat.
`json`	JSON-sträng.
`jsonc`	Färglagd JSON.
`yaml`	YAML, ett maskinläsbart alternativ till JSON.
`yamlc`	Färgad YAML.
`tsv`	Tabbavgränsade värden utan nycklar.
`none`	Inga utdata förutom fel och varningar.

Kommandon som stöds

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

Format för tabellutdata

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 fokuserad 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 bara väljer 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
 ------------------------------------ -------------

Kommentar

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

Format för JSON-utdata

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 endast när kommandot lyckas och returnerar 0.

I följande exempel visas listan över klienter 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"
    ]
  }
]

Format för YAML-utdata

yaml-formatet skriver ut utdata som YAML, ett oformaterat dataserialiseringsformat. 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

Format för TSV-utdata

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

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

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

Dela via