Formati di output supportati per l'interfaccia della riga di comando di Azure Sphere

Articolo
11/05/2024

Importante

Questa è la documentazione di Azure Sphere (legacy). Azure Sphere (legacy) viene ritirato il 27 settembre 2027 e gli utenti devono eseguire la migrazione ad Azure Sphere (integrato) entro questo periodo. Usare il selettore di versione posizionato sopra il sommario per visualizzare la documentazione di Azure Sphere (integrata).

L'interfaccia della riga di comando di Azure Sphere supporta diversi formati in cui è possibile visualizzare i dati. Per impostazione predefinita, usa table come formato predefinito per la visualizzazione dell'output dell'interfaccia della riga di comando, ma supporta anche altri formati.

Nota

L'output visualizzato per un comando può variare per un tipo di output diverso.

I valori degli argomenti e i tipi di output sono:

Formato di output	Descrizione
`table`	Tabella ASCII con chiavi come intestazioni di colonna. Si tratta del formato predefinito.
`json`	Stringa JSON.
`jsonc`	Stringa JSON colorata.
`yaml`	YAML, alternativa leggibile dal computer a JSON.
`yamlc`	YAML colorato.
`tsv`	Valori separati da tabulazioni, senza chiavi.
`none`	Nessun output diverso da errori e avvisi.

Comandi supportati

È possibile specificare il formato di output necessario per il comando usando --output, --outo -o. Se manca un comando che è necessario creare uno script, segnalarlo con il feedback di azsphere. È supportato per i comandi seguenti:

Formato dell'output della tabella

Il table formato è il formato predefinito che stampa l'output come tabella ASCII, semplificando la lettura e l'analisi. Questo formato è ideale quando si vuole una rapida panoramica dei dati ricercabile dall'utente. È utile per ottenere un riepilogo delle informazioni incentrate, 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 illustra come selezionare solo TenantID e Role nel comando list.

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 delle 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 tale comando.
Gli oggetti annidati, alcune chiavi e i campi non vengono stampati nell'output della tabella per impostazione predefinita. Se è necessario includerle nell'output, è possibile usare la funzionalità JMESPath per il reinserimento delle chiavi in modo da modificare il nome delle chiavi ed evitare i filtri. Per altre informazioni sull'uso di query per filtrare i dati, vedere Output dei comandi dell'interfaccia della riga di comando di query.

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 scripting concisi. Questa operazione è applicabile solo quando il comando ha esito positivo e restituisce 0.

Nell'esempio seguente viene visualizzato 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 formato yaml stampa l'output come YAML, un formato di serializzazione dei dati in testo normale. YAML tende a 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 TSV dell'output

Il tsv formato di output restituisce valori separati da tabulazioni e delimitati da nuova riga senza formattazione, chiavi o altri simboli aggiuntivi. L'output tsv è simile all'output table , ma differisce nei modi seguenti:

Le intestazioni di colonna non vengono visualizzate nell'output tsv .
L'output visualizza l'elenco table e tsv visualizza la lunghezza di un elenco.
Gli oggetti annidati non vengono stampati nell'output tsv .
L'output tsv è separato da tabulazioni e non viene ridimensionato per adattarsi al terminale.

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

Condividi tramite