Formatos de saída suportados para a CLI do Azure Sphere

Artigo
09/27/2024

Importante

Esta é a documentação do Azure Sphere (Legado). O Azure Sphere (Legado) 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 o formato padrão para exibir a saída da CLI, mas também suporta outros formatos.

Nota

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

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

Formato de saída	Description
`table`	Tabela ASCII com chaves como cabeçalhos de colunas. Este é o formato predefinido.
`json`	Cadeia de carateres JSON.
`jsonc`	JSON colorizado.
`yaml`	YAML, uma alternativa legível pela máquina para JSON.
`yamlc`	YAML colorido.
`tsv`	Valores separados por tabulações, sem chaves.
`none`	Nenhuma saída além de erros e avisos.

Comandos suportados

Você pode especificar o formato de saída necessário para o comando usando --output, --outou -o. Se não tivermos um comando que você precise roteirizar, informe-nos com o feedback do 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 por humanos dos dados. É útil para obter um resumo de informações focadas, particularmente 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
 ------------------------------------ -------------

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 precisar delas na sua saída, pode sempre utilizar a funcionalidade de novas chaves JMESPath para alterar o nome da chave e evitar a filtragem. Para obter mais informações sobre como usar consultas para filtrar dados, consulte Query CLI command output.

Formato de saída JSON

O formato de saída JSON inclui todos os dados brutos e dados aninhados em um formato estruturado. Recomendamos o uso da saída JSON para fins de saída concisa e scripting. 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 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 tabulação e por novas linhas sem formatação, teclas ou outros símbolos adicionais. 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.
Os objetos aninhados não são impressos na tsv saída.
A tsv saída é separada por tabulações 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

Partilhar via