Freigeben über

Unterstützte Ausgabeformate für Azure Sphere CLI

  • Artikel

Wichtig

Dies ist die Dokumentation zu Azure Sphere (Legacy). Azure Sphere (Legacy) wird am 27. September 2027 eingestellt, und Benutzer müssen bis zu diesem Zeitpunkt zu Azure Sphere (integriert) migrieren. Verwenden Sie die Versionsauswahl oberhalb des Inhaltsverzeichniss, um die Dokumentation zu Azure Sphere (Integriert) anzuzeigen.

Azure Sphere CLI unterstützt mehrere Formate, in denen die Daten angezeigt werden können. Standardmäßig wird es als Standardformat für die Anzeige der CLI-Ausgabe verwendet table , unterstützt aber auch andere Formate.

Hinweis

  • Die für einen Befehl angezeigte Ausgabe kann für unterschiedliche Ausgabetypen variieren.

Die Argumentwerte und die Ausgabetypen sind:

Ausgabeformat Beschreibung
table ASCII-Tabelle mit Schlüsseln als Spaltenüberschriften. Dies ist das Standformat.
json JSON-Zeichenfolge.
jsonc Farbiger JSON-Code.
yaml YAML, eine maschinenlesbare Alternative zu JSON.
yamlc Farbiges YAML.
tsv Tabstopptrennte Werte ohne Tasten.
none Keine Ausgabe außer Fehlern und Warnungen.

Unterstützte Befehle

Sie können das erforderliche Ausgabeformat für den Befehl mit --output, oder --out-o. Wenn wir einen Befehl fehlen, den Sie für die Skripterstellung benötigen, teilen Sie uns mit Azsphere-Feedback mit. Sie wird für die folgenden Befehle unterstützt:

Tabellenausgabeformat

Das table Format ist das Standardformat, das die Ausgabe als ASCII-Tabelle druckt und das Lesen und Scannen erleichtert. Dieses Format ist am besten geeignet, wenn Sie eine schnelle, durchsuchbare Übersicht über Daten wünschen. Es ist nützlich, eine Zusammenfassung der relevanten Informationen zu erhalten, insbesondere für Listenbefehle.

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

Sie können den --query Parameter verwenden, um die Eigenschaften und Spalten anzupassen, die in der Ausgabe angezeigt werden sollen. Das folgende Beispiel zeigt, wie Sie nur die TenantID und Die Rolle im Listenbefehl auswählen.

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

Hinweis

  • Führen Sie den Befehl im JSON-Format aus, um die verfügbaren Eigenschaftennamen anzuzeigen, die in der Abfrage verwendet werden sollen. Wenn Sie beispielsweise den azsphere tenant list --output json Befehl ausführen, zeigt die Ausgabe die Namen und Werte an, die für diesen Befehl verfügbar sind.
  • Geschachtelte Objekte, einige Schlüssel und Felder werden standardmäßig nicht in der Tabellenausgabe gedruckt. Wenn Sie diese in der Ausgabe benötigen, können Sie die JMESPath-Funktion zum Erstellen neuer Schlüssel verwenden, um den Namen des Schlüssels zu ändern und das Filtern zu vermeiden. Weitere Informationen zur Verwendung von Abfragen zum Filtern von Daten finden Sie in der Abfrage-CLI-Befehlsausgabe.

JSON-Ausgabeformat

Das JSON-Ausgabeformat enthält alle Rohdaten und geschachtelten Daten in einem strukturierten Format. Es wird empfohlen, die JSON-Ausgabe für präzise Ausgabe- und Skriptzwecke zu verwenden. Dies gilt nur, wenn der Befehl erfolgreich ist und "0" zurückgibt.

Im folgenden Beispiel wird die Liste der Mandanten im standardmäßigen JSON-Format angezeigt.

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

Das Format yaml gibt die Ausgabe als YAML (ein Nur-Text-Datenserialisierungsformat) aus. YAML ist in der Regel einfacher zu lesen als 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-Ausgabeformat

Das tsv Ausgabeformat gibt tabstopptrennte und neulinetrennte Werte ohne zusätzliche Formatierung, Tasten oder andere Symbole zurück. Die tsv Ausgabe ähnelt der table Ausgabe, unterscheidet sich jedoch auf folgende Weise:

  • Spaltenüberschriften werden in der tsv Ausgabe nicht angezeigt.
  • Die table Ausgabe zeigt die Liste an und tsv zeigt die Länge einer Liste an.
  • Geschachtelte Objekte werden in der tsv Ausgabe nicht gedruckt.
  • Die tsv Ausgabe ist tabstopptrennt und wird nicht so skaliert, dass sie an das Terminal angepasst wird.
azsphere tenant list --output tsv
143adbc9-1bf0-4be2-84a2-084a331d81cb    MyTenant    1
768c2cd6-059a-49ad-9f53-89f5271cea15    MyTenant1    2