Ondersteunde uitvoerindelingen voor Azure Sphere CLI

Artikel
08/09/2023

Azure Sphere CLI ondersteunt verschillende indelingen waarin de gegevens kunnen worden bekeken. Standaard wordt gebruikt table als de standaardindeling voor het weergeven van de CLI-uitvoer, maar ook andere indelingen worden ondersteund.

Opmerking

De uitvoer die voor een opdracht wordt weergegeven, kan variëren per uitvoertype.

De argumentwaarden en de uitvoertypen zijn:

Uitvoerindeling	Beschrijving
`table`	ASCII-tabel met sleutels als kolomkoppen. Dit is de standaardindeling.
`json`	JSON-tekenreeks.
`jsonc`	Gekleurde JSON.
`yaml`	YAML, een machineleesbaar alternatief voor JSON.
`yamlc`	Gekleurde YAML.
`tsv`	Door tabs gescheiden waarden, zonder toetsen.
`none`	Geen andere uitvoer dan fouten en waarschuwingen.

Ondersteunde opdrachten

U kunt de vereiste uitvoerindeling voor de opdracht opgeven met behulp van --output, --outof -o. Als er een opdracht ontbreekt die u moet uitvoeren, laat het ons dan weten met azsphere-feedback. Het wordt ondersteund voor de volgende opdrachten:

Tabeluitvoerindeling

De table indeling is de standaardindeling waarmee uitvoer wordt afgedrukt als een ASCII-tabel, waardoor deze gemakkelijk te lezen en te scannen is. Deze indeling is het beste wanneer u een snel, doorzoekbaar overzicht van gegevens wilt. Het is handig voor het ophalen van een samenvatting van gerichte informatie, met name voor lijstopdrachten.

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

U kunt de --query parameter gebruiken om de eigenschappen en kolommen aan te passen die u in de uitvoer wilt weergeven. In het volgende voorbeeld ziet u hoe u alleen de TenantID en Role selecteert in de lijstopdracht.

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

Opmerking

Voer de opdracht uit in de JSON-indeling om de beschikbare eigenschapsnamen weer te geven die in de query moeten worden gebruikt. Wanneer u bijvoorbeeld de azsphere tenant list --output json opdracht uitvoert, worden in de uitvoer de namen en waarden weergegeven die beschikbaar zijn voor die opdracht.
Geneste objecten, sommige sleutels en velden worden niet standaard afgedrukt in de tabeluitvoer. Als u deze in de uitvoer wilt zien, kunt u de functie JMESPath opnieuw sleutelen gebruiken om de sleutelnaam te wijzigen en te voorkomen dat u filtert. Zie Query CLI-opdrachtuitvoer voor meer informatie over het gebruik van query's om gegevens te filteren.

JSON-uitvoerindeling

JSON-uitvoerindeling bevat alle onbewerkte gegevens en geneste gegevens in een gestructureerde indeling. We raden u aan de JSON-uitvoer te gebruiken voor beknopte uitvoer- en scriptdoeleinden. Dit is alleen van toepassing wanneer de opdracht slaagt en 0 retourneert.

In het volgende voorbeeld wordt de lijst met tenants weergegeven in de standaard-JSON-indeling.

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

Met de yaml indeling wordt uitvoer afgedrukt als YAML, een serialisatie-indeling voor gegevens zonder opmaak. YAML is meestal gemakkelijker te lezen dan 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-uitvoerindeling

De tsv uitvoerindeling retourneert door tabs gescheiden en door nieuwe regels gescheiden waarden zonder extra opmaak, toetsen of andere symbolen. De tsv uitvoer is vergelijkbaar met de table uitvoer, maar verschilt op de volgende manieren:

Kolomkoppen worden niet weergegeven in de tsv uitvoer.
In de table uitvoer wordt de lijst weergegeven en tsv de lengte van een lijst weergegeven.
Geneste objecten worden niet afgedrukt in de tsv uitvoer.
De tsv uitvoer is gescheiden door tabs en kan niet worden aangepast aan de terminal.

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

Share via