Formatos de salida admitidos para la CLI de Azure Sphere

  • Artículo

La CLI de Azure Sphere admite varios formatos en los que se pueden ver los datos. De forma predeterminada, se usa table como formato predeterminado para mostrar la salida de la CLI, pero también es compatible con otros formatos.

Nota

  • La salida mostrada para un comando puede variar para el tipo de salida diferente.

Los valores de los argumentos y los tipos de salida son:

Formato de salida Descripción
table Tabla ASCII con claves como encabezados de columna. Este es el formato predeterminado.
json Cadena JSON.
jsonc JSON colorizado.
yaml YAML, una alternativa legible por máquina a JSON.
yamlc YAML coloreado.
tsv Valores separados por tabulaciones, sin teclas.
none No hay salida que no sean errores y advertencias.

Comandos compatibles

Puede especificar el formato de salida necesario para el comando usando --output, --out, o -o. Si nos falta un comando que necesita para generar un script, háganoslo saber con comentarios de azsphere. Es compatible con los siguientes comandos:

Formato de salida de tabla

El table formato es el formato predeterminado que imprime la salida como una tabla ASCII, lo que facilita la lectura y el examen. Este formato es el mejor para obtener una descripción general de los datos rápida y que se pueda buscar en humanos. Resulta útil para obtener un resumen de la información enfocada, especialmente para los comandos de lista.

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

Puede usar el --query parámetro para personalizar las propiedades y columnas que desea mostrar en el resultado. En el ejemplo siguiente se muestra cómo seleccionar solo el TenantID y el Rol en el comando de la lista.

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

Nota

  • Ejecute el comando en formato JSON para ver los nombres de propiedad disponibles que se usarán en la consulta. Por ejemplo, al ejecutar el azsphere tenant list --output json comando, la salida muestra los nombres y valores disponibles para ese comando.
  • Los objetos anidados, algunas claves y campos no se imprimen en el resultado de la tabla de forma predeterminada. Si necesita verlos en el resultado, puede usar la característica de re-keying de JMESPath para cambiar el nombre de la clave y evitar el filtrado. Para obtener más información sobre el uso de consultas para filtrar datos, vea Resultado del comando Query CLI.

Formato de salida JSON

El formato de salida JSON incluye todos los datos sin procesar y los datos anidados en un formato estructurado. Se recomienda usar la salida JSON para fines de scripting y salida concisos. Esto solo es aplicable cuando el comando se ejecuta correctamente y devuelve 0.

En el ejemplo siguiente se muestra la lista de inquilinos en el formato JSON predeterminado.

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"
    ]
  }
]

Formato de salida YAML

El yaml formato imprime la salida como YAML, un formato de serialización de datos de texto sin formato. YAML tiende a ser más fácil de leer 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

Formato de salida TSV

El tsv formato de salida devuelve valores separados por tabulaciones y separados por nuevas líneas sin formato adicional, teclas u otros símbolos. La tsv salida es similar a la table salida, pero se diferencia de las siguientes maneras:

  • Los encabezados de columna no se muestran en la tsv salida.
  • La table salida muestra la lista y tsv muestra la longitud de una lista.
  • Los objetos anidados no se imprimen en la tsv salida.
  • La tsv salida está separada por tabulaciones y no se escala para ajustarse al terminal.
azsphere tenant list --output tsv
143adbc9-1bf0-4be2-84a2-084a331d81cb    MyTenant    1
768c2cd6-059a-49ad-9f53-89f5271cea15    MyTenant1    2