Formats des thèmes gdcloud

NAME

gdcloud topic formats : aide supplémentaire pour les formats de ressources.

DESCRIPTION

De nombreuses commandes de l'CLI gdcloud renvoient une liste de ressources en cas de réussite. Par défaut, elles sont mises en forme et affichées sur la sortie standard. L'option --format=NAME[PROJECTIONS] permet de mettre en forme et de modifier la sortie par défaut pour obtenir un résultat plus significatif.

Utilisez l'option --format pour modifier le format de sortie par défaut d'une commande. Les formats de ressources sont décrits en détail plus loin.

Utilisez des projections pour afficher une sous-liste de clés de ressources dans une ressource.

Remarque : Pour faire référence à une liste de champs, vous pouvez trier et mettre en forme chaque ressource. Vous pouvez exécuter une commande list avec le format défini sur yaml, json, csv, text ou table. Par exemple,

gdcloud clusters list --format=yaml

Formats

Une expression de format permet de modifier le format de sortie par défaut d'une commande. De nombreux formats de sortie sont disponibles : certains pour mettre en forme une sortie lisible par l'humain et d'autres pour renvoyer une sortie lisible par une machine. Une expression de format comporte deux parties :

NAME nom

PROJECTIONS [ clé-de-ressource [, …] ]

NAME est obligatoire et PROJECTIONS peut être appliqué aux formats csv, text et table. Les valeurs inconnues sont ignorées sans avertissement. Chaque commande gdcloud list comporte une expression de format par défaut. L'option --format peut modifier ou remplacer la valeur par défaut. Par exemple,

--format="table(clusterref.name,controlPlane.name,controlPlane.image)" affiche les ressources du plan de contrôle au format de tableau.

--format=json affiche la ressource au format JSON.

Les formats disponibles sont les suivants :

## csv

Comma Separated Values (<https //www.ietf.org/rfc/rfc4180.txt>) with no keys. Use this format with a projection to define values to print.

## json

JSON (<https //www.json.org>), JavaScript Object Notation.

## table

Aligned left-adjusted columns and column headings are the disambiguated right hand components of the column keys in uppercase. For example, the projection keys `(first.name, last.name)` produce the default column heading `('FIRST.NAME', 'LAST.NAME')`. If the screen reader option is `True`, you might observe flattened list output instead of a table with columns. To turn it off, run  `gdcloud config set accessibility/screen_reader false`.

## text

A flattened tree. Each output line contains one `key` `value` pair. Use this format with a projection to define values to print.

## yaml

YAML (<https //www.yaml.org>), YAML ain't markup language.

EXEMPLES

Afficher l'état de toutes les informations sur les clusters au format JSON

gdcloud clusters list --format=json

Afficher les détails de la référence de cluster du cluster d'utilisateur

gdcloud clusters describe user-vm-1 --format="table(clusterref.name,clusterref.namespace)"