Formatos de saída com suporte para a CLI do Azure Sphere

  • Artigo

A CLI do Azure Sphere dá suporte a vários formatos nos quais os dados podem ser exibidos. Por padrão, ele usa table como o formato padrão para exibir a saída da CLI, mas também dá suporte a outros formatos.

Nota

  • A saída exibida para um comando pode variar para um tipo de saída diferente.

Os valores de argumento e os tipos de saída são:

Formato de saída Descrição
table Tabela ASCII com chaves como títulos de coluna. Esse é o formato padrão.
json Cadeia de caracteres JSON.
jsonc JSON colorido.
yaml YAML, uma alternativa legível por máquina ao JSON.
yamlc YAML colorido.
tsv Valores separados por guia, sem chaves.
none Nenhuma saída além de erros e avisos.

Comandos com suporte

Você pode especificar o formato de saída necessário para o comando usando --output, --outou -o. Se estiver faltando um comando que você precisa fazer script, informe-nos com comentários do azsphere. Há suporte para os seguintes comandos:

Formato de saída de tabela

O table formato é o formato padrão que imprime a saída como uma tabela ASCII, facilitando a leitura e a verificação. Esse formato é melhor quando você deseja uma visão geral rápida e pesquisável por humanos dos dados. É útil para obter um resumo das informações focadas, especialmente para 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
 ------------------------------------ --------------------- -------------

Você pode usar o --query parâmetro para personalizar as propriedades e colunas que deseja mostrar na saída. O exemplo a seguir mostra como selecionar apenas o TenantID e a Função no comando de 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

  • Execute o comando no formato JSON para exibir os nomes de propriedade disponíveis a serem usados na consulta. Por exemplo, quando você executa o azsphere tenant list --output json comando, a saída exibe os nomes e valores disponíveis para esse comando.
  • Objetos aninhados, algumas chaves e campos não são impressos na saída da tabela por padrão. Se você precisar vê-los em sua saída, poderá usar o recurso de re-keying JMESPath para alterar o nome da chave e evitar filtragem. Para obter mais informações sobre como usar consultas para filtrar dados, consulte Saída de comando da CLI de consulta.

Formato de saída JSON

O formato de saída JSON inclui todos os dados brutos e dados aninhados em um formato estruturado. Recomendamos usar a saída JSON para fins concisos de saída e script. Isso só é aplicável quando o comando é bem-sucedido e retorna 0.

O exemplo a seguir exibe a lista de locatários no formato JSON padrão.

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 saída YAML

O yaml formato imprime a saída como YAML, um formato de serialização de dados de texto simples. YAML tende a ser mais fácil de ler do 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 saída TSV

O tsv formato de saída retorna valores separados por guia e separados por linhas sem formatação adicional, chaves ou outros símbolos. A tsv saída é semelhante à table saída, mas difere das seguintes maneiras:

  • Os cabeçalhos de coluna não são exibidos na tsv saída.
  • A table saída exibe a lista e tsv exibe o comprimento de uma lista.
  • Objetos aninhados não são impressos na tsv saída.
  • A tsv saída é separada por guia e não é dimensionada para se ajustar ao terminal.
azsphere tenant list --output tsv
143adbc9-1bf0-4be2-84a2-084a331d81cb    MyTenant    1
768c2cd6-059a-49ad-9f53-89f5271cea15    MyTenant1    2