Unterstützte Ausgabeformate für die Azure Sphere-CLI

  • Artikel

Die Azure Sphere-CLI unterstützt verschiedene Formate, in denen die Daten angezeigt werden können. Standardmäßig wird als Standardformat zum Anzeigen der CLI-Ausgabe verwendet table , aber auch andere Formate werden unterstützt.

Hinweis

  • Die für einen Befehl angezeigte Ausgabe kann je nach Ausgabetyp variieren.

Die Argumentwerte und die Ausgabetypen sind:

Ausgabeformat Beschreibung
table ASCII-Tabelle mit Schlüsseln als Spaltenüberschriften. Dies ist das Standardformat.
json JSON-Zeichenfolge.
jsonc Farbiger JSON-Code.
yaml YAML, eine maschinenlesbare Alternative zu JSON.
yamlc Farbiges YAML.
tsv Durch Tabstopp getrennte Werte ohne Schlüssel.
none Keine andere Ausgabe als Fehler und Warnungen.

Unterstützte Befehle

Sie können das erforderliche Ausgabeformat für den Befehl mit --output, --outoder -oangeben. Wenn ein Befehl fehlt, den Sie für die Skripterstellung benötigen, teilen Sie uns dies mit azsphere-Feedback mit. Sie wird für die folgenden Befehle unterstützt:

Tabellenausgabeformat

Das table Format ist das Standardformat, mit dem die Ausgabe als ASCII-Tabelle gedruckt wird, sodass sie einfach zu lesen und zu scannen ist. Dieses Format eignet sich am besten, wenn Sie eine schnelle, von Menschen durchsuchbare Übersicht über Daten wünschen. Es ist nützlich, um eine Zusammenfassung der fokussierten 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 Mandanten-ID 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 Eigenschaftsnamen anzuzeigen, die in der Abfrage verwendet werden sollen. Wenn Sie z. B. 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 ausgegeben. Wenn Sie diese in Ihrer Ausgabe sehen müssen, können Sie das Feature zum erneuten Schlüsseln von JMESPath verwenden, um den Schlüsselnamen zu ändern und das Filtern zu vermeiden. Weitere Informationen zur Verwendung von Abfragen zum Filtern von Daten finden Sie unter 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 Skripterstellungszwecke zu verwenden. Dies gilt nur, wenn der Befehl erfolgreich ist und 0 zurückgibt.

Im folgenden Beispiel wird die Liste der Mandanten im JSON-Standardformat 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 yaml Format gibt die Ausgabe als YAML aus, einem Nur-Text-Datenserialisierungsformat. 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 durch Tabstopps getrennte und durch Zeilenumbruch getrennte Werte ohne zusätzliche Formatierung, Schlüssel oder andere Symbole zurück. Die tsv Ausgabe ähnelt der table Ausgabe, unterscheidet sich jedoch in den folgenden Punkten:

  • Spaltenüberschriften werden in der tsv Ausgabe nicht angezeigt.
  • Die table Ausgabe zeigt eine Liste und tsv die Länge einer Liste an.
  • Geschachtelte Objekte werden nicht in der tsv Ausgabe ausgegeben.
  • Die tsv Ausgabe ist tabstopps getrennt und lässt sich nicht an das Terminal anpassen.
azsphere tenant list --output tsv
143adbc9-1bf0-4be2-84a2-084a331d81cb    MyTenant    1
768c2cd6-059a-49ad-9f53-89f5271cea15    MyTenant1    2