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

  • Artigo

Importante

Esta é a documentação do Azure Sphere (herdado). O Azure Sphere (herdado) será desativado em 27 de setembro de 2027 e os usuários devem migrar para o Azure Sphere (integrado) até esse momento. Use o seletor de versão localizado acima do sumário para exibir a documentação do Azure Sphere (Integrado).

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 formato padrão para exibir a saída da CLI, mas também oferece suporte a outros formatos.

Observação

  • A saída exibida para um comando pode variar para diferentes tipos de saída.

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

Formato da saída Descrição
table A tabela ASCII com as chaves como títulos de coluna. Este é o formato padrão.
json cadeia de caracteres JSON.
jsonc JSON colorido.
yaml YAML, uma alternativa legível por computador para JSON.
yamlc YAML colorido.
tsv Valores separados por tabulação, 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, --out, ou -o. Se não houver um comando que você precise criar um script, informe-nos com comentários sobre azsphere. Ele é suportado para os seguintes comandos:

Formato de saída da tabela

O table formato é o formato padrão que imprime a saída como uma tabela ASCII, facilitando a leitura e a digitalização. Esse formato é melhor quando você deseja uma visão geral rápida e pesquisável 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 TenantID e Role no comando list.

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

Observação

  • 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 ver isso na saída, poderá usar o recurso de recriação de chave JMESPath para alterar o nome da chave e evitar a filtragem. Para obter mais informações sobre como usar consultas para filtrar dados, consulte Saída do comando Query CLI.

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

O formato de saída TSV

O tsv formato de saída retorna valores separados por tabulação e nova linha sem formatação adicional, chaves ou outros símbolos. A tsv saída é semelhante à saída, table 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 tabulação e não é dimensionada para caber no terminal.
azsphere tenant list --output tsv
143adbc9-1bf0-4be2-84a2-084a331d81cb    MyTenant    1
768c2cd6-059a-49ad-9f53-89f5271cea15    MyTenant1    2