Udostępnij za pośrednictwem

Obsługiwane formaty danych wyjściowych dla interfejsu wiersza polecenia usługi Azure Sphere

  • Artykuł

Ważne

Jest to dokumentacja usługi Azure Sphere (starsza wersja). Usługa Azure Sphere (starsza wersja) zostanie wycofana 27 września 2027 r., a użytkownicy muszą przeprowadzić migrację do usługi Azure Sphere (zintegrowanej) do tej pory. Użyj selektora wersji znajdującego się powyżej spisu treści, aby wyświetlić dokumentację usługi Azure Sphere (zintegrowaną).

Interfejs wiersza polecenia usługi Azure Sphere obsługuje kilka formatów, w których można wyświetlać dane. Domyślnie jest table używany jako domyślny format wyświetlania danych wyjściowych interfejsu wiersza polecenia, ale także obsługuje inne formaty.

Uwaga

  • Dane wyjściowe wyświetlane dla polecenia mogą się różnić w zależności od typu danych wyjściowych.

Wartości argumentów i typy danych wyjściowych to:

Format wyjściowy opis
table Tabela ASCII z kluczami jako nagłówkami kolumn. To jest format domyślny.
json Ciąg JSON.
jsonc Pokolorowany ciąg JSON.
yaml YAML, czytelna dla maszyn alternatywa dla formatu JSON.
yamlc Kolorowane YAML.
tsv Wartości rozdzielane tabulatorami bez kluczy.
none Brak danych wyjściowych innych niż błędy i ostrzeżenia.

Obsługiwane polecenia

Można określić wymagany format danych wyjściowych dla polecenia przy użyciu polecenia --output, --outlub -o. Jeśli brakuje polecenia potrzebnego do utworzenia skryptu, daj nam znać za pomocą polecenia azsphere feedback. Jest on obsługiwany w przypadku następujących poleceń:

Format danych wyjściowych tabeli

Format table jest formatem domyślnym, który drukuje dane wyjściowe jako tabelę ASCII, co ułatwia odczytywanie i skanowanie. Ten format jest najlepszy, gdy potrzebujesz szybkiego, czytelnego dla człowieka przeglądu danych. Przydatne jest uzyskanie podsumowania ukierunkowanych informacji, szczególnie w przypadku poleceń listy.

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

Możesz użyć parametru --query , aby dostosować właściwości i kolumny, które mają być wyświetlane w danych wyjściowych. W poniższym przykładzie pokazano, jak wybrać tylko identyfikator dzierżawy i rolę w poleceniu listy.

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

Uwaga

  • Uruchom polecenie w formacie JSON, aby wyświetlić dostępne nazwy właściwości, które mają być używane w zapytaniu. Na przykład po uruchomieniu azsphere tenant list --output json polecenia dane wyjściowe wyświetlają nazwy i wartości dostępne dla tego polecenia.
  • Zagnieżdżone obiekty, niektóre klucze i pola nie są domyślnie drukowane w danych wyjściowych tabeli. Jeśli chcesz uwzględnić te wartości w danych wyjściowych, możesz użyć funkcji ponownego tworzenia kluczy JMESPath, aby zmienić nazwę klucza i zapobiec filtrowaniu. Aby uzyskać więcej informacji na temat używania zapytań do filtrowania danych, zobacz Query CLI command output (Dane wyjściowe polecenia interfejsu wiersza polecenia zapytania).

Format danych wyjściowych JSON

Format danych wyjściowych JSON zawiera wszystkie nieprzetworzone dane i zagnieżdżone dane w formacie ustrukturyzowanym. Zalecamy używanie danych wyjściowych JSON do zwięzłych danych wyjściowych i skryptów. Ma to zastosowanie tylko wtedy, gdy polecenie zakończy się pomyślnie i zwróci wartość 0.

Poniższy przykład przedstawia listę dzierżaw w domyślnym formacie 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"
    ]
  }
]

Format danych wyjściowych YAML

Format yaml umożliwia wyświetlanie danych wyjściowych jako plików YAML, które są formatem serializacji danych w postaci zwykłego tekstu. Kod YAML jest zwykle łatwiejszy do odczytania niż 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 danych wyjściowych TSV

Format tsv danych wyjściowych zwraca wartości rozdzielane tabulatorami i nowymi liniami bez dodatkowego formatowania, kluczy lub innych symboli. Dane tsv wyjściowe są podobne do table danych wyjściowych, ale różnią się w następujący sposób:

  • Nagłówki kolumn nie są wyświetlane w danych wyjściowych tsv .
  • W table danych wyjściowych zostanie wyświetlona lista i tsv zostanie wyświetlona długość listy.
  • Zagnieżdżone obiekty nie są drukowane w danych wyjściowych tsv .
  • Dane tsv wyjściowe są oddzielone kartą i nie są skalowane w celu dopasowania do terminalu.
azsphere tenant list --output tsv
143adbc9-1bf0-4be2-84a2-084a331d81cb    MyTenant    1
768c2cd6-059a-49ad-9f53-89f5271cea15    MyTenant1    2