Formats de sortie pris en charge pour Azure Sphere CLI

  • Article

Important

Il s’agit de la documentation Azure Sphere (héritée). Azure Sphere (hérité) prend sa retraite le 27 septembre 2027 et les utilisateurs doivent migrer vers Azure Sphere (intégré) pour l’instant. Utilisez le sélecteur de version situé au-dessus du TOC pour afficher la documentation Azure Sphere (intégrée).

Azure Sphere CLI prend en charge plusieurs formats dans lesquels les données peuvent être consultées. Par défaut, il utilise table le format par défaut pour afficher la sortie CLI, mais prend également en charge d’autres formats.

Remarque

  • La sortie affichée pour une commande peut varier selon un type de sortie différent.

Les valeurs d’argument et les types de sortie sont les suivants :

Format de sortie Description
table Table ASCII avec des clés en tant qu’en-têtes de colonne. C’est le format par défaut.
json Chaîne JSON.
jsonc JSON coloré.
yaml YAML, une alternative à JSON pouvant être lue par la machine.
yamlc YAML colorisé.
tsv Valeurs séparées par des tabulations, sans touches.
none Aucune sortie autre que les erreurs et les avertissements.

Commandes prises en charge

Vous pouvez spécifier le format de sortie requis pour la commande à l’aide --outputde , --outou -o. Si nous ne disposons pas d’une commande que vous devez scripter, faites-nous part des commentaires azsphere. Il est pris en charge pour les commandes suivantes :

Format de sortie de la table

Le table format est le format par défaut qui imprime la sortie sous forme de tableau ASCII, ce qui facilite la lecture et l’analyse. Ce format est préférable lorsque vous souhaitez obtenir une vue d’ensemble rapide et pouvant faire l’objet d’une recherche humaine sur les données. Il est utile d’obtenir un résumé des informations ciblées, en particulier pour les commandes de liste.

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

Vous pouvez utiliser le --query paramètre pour personnaliser les propriétés et les colonnes que vous souhaitez afficher dans la sortie. L’exemple suivant montre comment sélectionner uniquement l’ID de locataire et le rôle dans la commande de liste.

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

Remarque

  • Exécutez la commande au format JSON pour afficher les noms de propriétés disponibles à utiliser dans la requête. Par exemple, lorsque vous exécutez la azsphere tenant list --output json commande, la sortie affiche les noms et les valeurs disponibles pour cette commande.
  • Les objets imbriqués, certaines clés et champs ne sont pas imprimés dans la sortie de la table par défaut. Si vous avez besoin de les voir dans votre sortie, vous pouvez utiliser la fonction JMESPath de régénération des clés pour modifier le nom de clé et éviter le filtrage. Pour plus d’informations sur l’utilisation de requêtes pour filtrer les données, consultez la sortie de la commande CLI de requête.

Format de sortie JSON

Le format de sortie JSON inclut toutes les données brutes et les données imbriquées dans un format structuré. Nous vous recommandons d’utiliser la sortie JSON à des fins de sortie et de script concis. Cela s’applique uniquement lorsque la commande réussit et retourne 0.

L’exemple suivant affiche la liste des locataires au format JSON par défaut.

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 de sortie YAML

Le format yaml affiche la sortie en tant que YAML, un format de sérialisation de données en texte brut. YAML a tendance à être plus facile à lire que 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 de sortie TSV

Le tsv format de sortie retourne des valeurs séparées par des onglets et séparées par des lignes sans mise en forme, touches ou autres symboles supplémentaires. La tsv sortie est similaire à la table sortie, mais diffère de la manière suivante :

  • Les en-têtes de colonne ne sont pas affichés dans la tsv sortie.
  • La table sortie affiche la liste et tsv affiche la longueur d’une liste.
  • Les objets imbriqués ne sont pas imprimés dans la tsv sortie.
  • La tsv sortie est séparée par des onglets et n’est pas mise à l’échelle pour s’adapter au terminal.
azsphere tenant list --output tsv
143adbc9-1bf0-4be2-84a2-084a331d81cb    MyTenant    1
768c2cd6-059a-49ad-9f53-89f5271cea15    MyTenant1    2