Podporované formáty výstupu pro Rozhraní příkazového řádku Azure Sphere

Článek
09/27/2024

Důležité

Toto je dokumentace k Azure Sphere (starší verze). Azure Sphere (starší verze) se vyřazuje 27. září 2027 a uživatelé musí do této doby migrovat do Azure Sphere (integrované). K zobrazení dokumentace k Azure Sphere (integrované) použijte selektor verzí umístěný nad obsahem.

Rozhraní příkazového řádku Azure Sphere podporuje několik formátů, ve kterých se data dají zobrazit. Ve výchozím nastavení se používá table jako výchozí formát pro zobrazení výstupu rozhraní příkazového řádku, ale podporuje i jiné formáty.

Poznámka:

Výstup zobrazený pro příkaz se může lišit pro jiný typ výstupu.

Hodnoty argumentů a výstupní typy jsou:

Výstupní formát	Popis
`table`	Tabulka ASCII s klíči jako záhlavími sloupců. Toto je výchozí formát.
`json`	Řetězec ve formátu JSON.
`jsonc`	Obarvený řetězec ve formátu JSON.
`yaml`	YAML, strojově čitelná alternativa JSON.
`yamlc`	Obarvené YAML.
`tsv`	Hodnoty oddělené tabulátorem bez kláves.
`none`	Žádný výstup kromě chyb a upozornění.

Podporované příkazy

Požadovaný výstupní formát příkazu můžete zadat pomocí příkazu --output, --outnebo -o. Pokud chybí příkaz, který potřebujete skriptovat, dejte nám vědět pomocí příkazu azsphere feedback. Podporuje se pro následující příkazy:

Výstupní formát tabulky

Formát table je výchozí formát, který tiskne výstup jako tabulku ASCII, což usnadňuje čtení a skenování. Tento formát je nejlepší, když chcete mít rychlý přehled dat, který lze prohledávat člověkem. Je užitečné získat souhrn zaměřených informací, zejména pro příkazy seznamu.

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

Pomocí parametru --query můžete přizpůsobit vlastnosti a sloupce, které chcete zobrazit ve výstupu. Následující příklad ukazuje, jak vybrat pouze TenantID a Role v příkazu list.

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

Poznámka:

Spuštěním příkazu ve formátu JSON zobrazte dostupné názvy vlastností, které se mají použít v dotazu. Například při spuštění příkazu se ve výstupu azsphere tenant list --output json zobrazí názvy a hodnoty, které jsou pro tento příkaz k dispozici.
Ve výstupu tabulky se ve výchozím nastavení nevytisknou vnořené objekty, některé klíče a pole. Pokud je potřebujete zahrnout do výstupu, můžete využít překlíčovací funkci JMESPath ke změně názvu klíče a vyhnout se tak filtrování. Další informace o použití dotazů k filtrování dat najdete v tématu Výstup příkazu rozhraní příkazového řádku dotazu.

Výstupní formát JSON

Výstupní formát JSON zahrnuje všechna nezpracovaná data a vnořená data ve strukturovaném formátu. Pro stručné účely výstupu a skriptování doporučujeme použít výstup JSON. To platí jenom v případě, že příkaz proběhne úspěšně a vrátí hodnotu 0.

Následující příklad zobrazí seznam tenantů ve výchozím formátu JSON.

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

Výstupní formát YAML

yaml vytiskne výstup jako YAML (formát serializace dat v prostém textu). YAML je obvykle čitelnější než 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

Výstupní formát TSV

Výstupní tsv formát vrátí hodnoty oddělené tabulátorem a novými spojnicemi bez dalšího formátování, klíčů nebo jiných symbolů. Výstup tsv se podobá výstupu table , ale liší se následujícími způsoby:

Záhlaví sloupců se ve výstupu tsv nezobrazují.
Výstup table zobrazí seznam a tsv zobrazí délku seznamu.
Ve výstupu tsv nejsou vytištěny vnořené objekty.
Výstup tsv je oddělen tabulátorem a nenasahuje měřítko tak, aby odpovídalo terminálu.

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

Sdílet prostřednictvím