Formati di output supportati per Azure Sphere CLI

  • Articolo

Azure Sphere CLI supporta diversi formati in cui i dati possono essere visualizzati. Per impostazione predefinita, usa table come formato predefinito per la visualizzazione dell'output CLI, ma supporta anche altri formati.

Nota

  • L'output visualizzato per un comando può variare in base al tipo di output.

I valori degli argomenti e i tipi di output sono:

Formato output Descrizione
table Tabella ASCII con tasti come intestazioni di colonna. Questo è il formato predefinito.
json Stringa JSON.
jsonc JSON colorato.
yaml YAML, un'alternativa leggibile alla macchina a JSON.
yamlc IAML colorati.
tsv Valori separati da tabulazione, senza tasti.
none Nessun output se non errori e avvisi.

Comandi supportati

È possibile specificare il formato di output necessario per il comando usando --output, --outo -o. Se ci manca un comando che devi scrivere, facci sapere con il feedback dell'azsfera. È supportato per i comandi seguenti:

Formato di output della tabella

Il table formato è il formato predefinito che consente di stampare l'output come tabella ASCII, semplificando la lettura e la scansione. Questo formato è ideale quando si vuole una panoramica rapida e ricercabile dei dati. È utile per ottenere un riepilogo delle informazioni mirate, in particolare per i comandi elenco.

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

È possibile usare il --query parametro per personalizzare le proprietà e le colonne da visualizzare nell'output. L'esempio seguente mostra come selezionare solo l'ID tenant e il ruolo nel comando elenco.

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

Nota

  • Eseguire il comando nel formato JSON per visualizzare i nomi di proprietà disponibili da usare nella query. Ad esempio, quando si esegue il azsphere tenant list --output json comando, l'output visualizza i nomi e i valori disponibili per il comando.
  • Per impostazione predefinita, gli oggetti annidati, alcuni tasti e campi non vengono stampati nell'output della tabella. Se è necessario visualizzarli nell'output, è possibile usare la funzionalità di re-keying di JMESPath per modificare il nome della chiave ed evitare di filtrare. Per altre informazioni sull'uso delle query per filtrare i dati, vedere Output del comando QUERY CLI.

Formato di output JSON

Il formato di output JSON include tutti i dati non elaborati e i dati annidati in un formato strutturato. È consigliabile usare l'output JSON per scopi di output e script conciso. Questo è applicabile solo quando il comando ha esito positivo e restituisce 0.

L'esempio seguente mostra l'elenco dei tenant nel formato JSON predefinito.

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"
    ]
  }
]

Formato di output YAML

Il yaml formato stampa l'output come YAML, un formato di serializzazione dei dati in testo normale. YAML tende ad essere più facile da leggere rispetto a 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

Formato di output TSV

Il tsv formato di output restituisce valori separati da tabulazione e da nuova linea senza formattazione aggiuntiva, tasti o altri simboli. L'output tsv è simile all'output table , ma è diverso nei modi seguenti:

  • Le intestazioni di colonna non vengono visualizzate nell'output tsv .
  • L'output table visualizza l'elenco e tsv la lunghezza di un elenco.
  • Gli oggetti annidati non vengono stampati nell'output tsv .
  • L'output tsv è separato da tabulazione e non si adatta al terminale.
azsphere tenant list --output tsv
143adbc9-1bf0-4be2-84a2-084a331d81cb    MyTenant    1
768c2cd6-059a-49ad-9f53-89f5271cea15    MyTenant1    2