Formatos de saída para comandos da CLI do Azure

2025-09-02

A CLI do Azure usa JSON como seu formato de saída padrão, mas oferece outros formatos. Use o --output parâmetro (--out ou -o) para formatar a saída da CLI do Azure. Os valores de argumento e os tipos de saída são:

--saída	Descrição
`json`	Cadeia de caracteres JSON. Essa configuração é o padrão
`jsonc`	JSON colorido
`table`	Tabela ASCII com chaves como títulos de coluna
`tsv`	Valores separados por tabulação, sem chaves
`yaml`	YAML, uma alternativa legível por humanos ao JSON
`yamlc`	YAML colorido
`none`	Nenhuma saída além de erros e avisos

Aviso

Para evitar expor segredos como chaves de API e credenciais, use um formato de saída de none ou armazene a saída do comando em uma variável. Nota: Determinados ambientes de CI/CD podem armazenar a saída dos comandos executados em logs. É uma boa prática confirmar o conteúdo desses arquivos de log e quem tem acesso aos logs. Para obter mais informações, consulte Nenhum formato de saída.

Formato de saída JSON (padrão)

O exemplo a seguir exibe a lista de máquinas virtuais em suas assinaturas no formato JSON padrão.

az vm list --output json

A saída a seguir tem alguns campos omitidos por questão de brevidade, e informações identificáveis substituídas.

[
  {
    "availabilitySet": null,
    "diagnosticsProfile": null,
    "hardwareProfile": {
      "vmSize": "Standard_DS1"
    },
    "id": "/subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/DemoVM010",
    "instanceView": null,
    "licenseType": null,
    "___location": "westus",
    "name": "DemoVM010",
    "networkProfile": {
      "networkInterfaces": [
        {
          "id": "/subscriptions/.../resourceGroups/demorg1/providers/Microsoft.Network/networkInterfaces/DemoVM010VMNic",
          "primary": null,
          "resourceGroup": "demorg1"
        }
      ]
    },
          ...
          ...
          ...
]

Formato de saída YAML

O yaml formato 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 e é mapeado para esse formato. Alguns aplicativos e comandos da CLI do Azure usam YAML como entrada de configuração, em vez de JSON.

az vm list --output yaml

A saída a seguir tem alguns campos omitidos por questão de brevidade, e informações identificáveis substituídas.

- availabilitySet: null
  diagnosticsProfile: null
  hardwareProfile:
    vmSize: Standard_DS1_v2
  id: /subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/DemoVM010
  identity: null
  instanceView: null
  licenseType: null
  ___location: westus
  name: ExampleVM1
  networkProfile:
    networkInterfaces:
    - id: /subscriptions/.../resourceGroups/DemoRG1/providers/Microsoft.Network/networkInterfaces/DemoVM010Nic
      primary: null
      resourceGroup: DemoRG1
  ...
...

Formato de saída da tabela

O table formato imprime a saída como uma tabela ASCII, facilitando a leitura e a verificação. Objetos aninhados não são incluídos nos resultados da tabela, mas ainda podem ser filtrados como parte de uma consulta. Alguns campos não estão incluídos na tabela, portanto, esse formato é melhor quando você deseja uma visão geral rápida e pesquisável por humanos dos dados.

az vm list --output table

Name         ResourceGroup    Location
-----------  ---------------  ----------
DemoVM010    DEMORG1          westus
demovm212    DEMORG1          westus
demovm213    DEMORG1          westus
KBDemo001VM  RGDEMO001        westus
KBDemo020    RGDEMO001        westus

Você pode usar o --query parâmetro para personalizar as propriedades e colunas que deseja mostrar na saída da lista. O exemplo a seguir mostra como selecionar apenas o Nome da VM e o Nome do Grupo de Recursos no list comando.

az vm list --query "[].{resource:resourceGroup, name:name}" --output table

Resource    Name
----------  -----------
DEMORG1     DemoVM010
DEMORG1     demovm212
DEMORG1     demovm213
RGDEMO001   KBDemo001VM
RGDEMO001   KBDemo020

Observação

Algumas chaves não são impressas no modo de exibição de tabela por padrão. Essas chaves incluem id, typee etag. Se você precisar deles em sua saída, poderá usar o recurso de reatribuição de chave JMESPath para alterar o nome da chave e evitar a filtragem.

az vm list --query "[].{objectID:id}" --output table

Para obter mais informações sobre como usar consultas para filtrar dados, consulte Usar consultas JMESPath com a CLI do Azure.

Formato de saída TSV

O tsv formato de saída retorna valores separados de guia e nova linha sem formatação extra, chaves ou outros símbolos. Esse formato facilita a integração da saída com outros comandos e ferramentas que precisam processar o texto de alguma forma. Assim como o table formato, tsv não imprime objetos aninhados.

Usar o exemplo anterior com a opção tsv gera o resultado separado por tabulação.

az vm list --output tsv

None    None        /subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/DemoVM010    None    None    westus    DemoVM010            None    Succeeded    DEMORG1    None            Microsoft.Compute/virtualMachines    cbd56d9b-9340-44bc-a722-25f15b578444
None    None        /subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/demovm212    None    None    westus    demovm212            None    Succeeded    DEMORG1    None            Microsoft.Compute/virtualMachines    4bdac85d-c2f7-410f-9907-ca7921d930b4
None    None        /subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/demovm213    None    None    westus    demovm213            None    Succeeded    DEMORG1    None            Microsoft.Compute/virtualMachines    2131c664-221a-4b7f-9653-f6d542fbfa34
None    None        /subscriptions/.../resourceGroups/RGDEMO001/providers/Microsoft.Compute/virtualMachines/KBDemo001VM    None    None    westus    KBDemo001VM            None    Succeeded    RGDEMO001    None            Microsoft.Compute/virtualMachines    14e74761-c17e-4530-a7be-9e4ff06ea74b
None    None        /subscriptions/.../resourceGroups/RGDEMO001/providers/Microsoft.Compute/virtualMachines/KBDemo020   None    None    westus    KBDemo020            None    Succeeded    RGDEMO001    None            Microsoft.Compute/virtualMachines    36baa9-9b80-48a8-b4a9-854c7a858ece

Uma restrição do tsv formato de saída é que não há uma garantia sobre a ordenação de saída. A CLI do Azure procura preservar a ordenação ordenando chaves no JSON de resposta em ordem alfabética e, em seguida, imprimindo seus valores em ordem para a tsv saída. Não há garantia de que o pedido seja sempre idêntico, pois o formato de resposta do serviço do Azure pode ser alterado.

Para impor a ordenação consistente, você precisa usar o --query parâmetro e o formato de lista multisseleção . Quando um comando da CLI do Azure retorna um único dicionário JSON, use o formato [key1, key2, ..., keyN] geral para forçar uma ordem de chave. Para comandos da CLI do Azure que retornam uma matriz, use o formato [].[key1, key2, ..., keyN] geral para ordenar valores de coluna.

Por exemplo, para ordenar essas informações exibidas por ID, localização, grupo de recursos e nome da VM:

az vm list --output tsv --query '[].[id, ___location, resourceGroup, name]'

/subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/DemoVM010    westus    DEMORG1    DemoVM010
/subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/demovm212    westus    DEMORG1    demovm212
/subscriptions/.../resourceGroups/DEMORG1/providers/Microsoft.Compute/virtualMachines/demovm213    westus    DEMORG1    demovm213
/subscriptions/.../resourceGroups/RGDEMO001/providers/Microsoft.Compute/virtualMachines/KBDemo001VM     westus  RGDEMO001       KBDemo001VM
/subscriptions/.../resourceGroups/RGDEMO001/providers/Microsoft.Compute/virtualMachines/KBDemo020       westus  RGDEMO001       KBDemo020

O exemplo a seguir mostra como você pode redirecionar tsv a saída para outros comandos no Bash. A consulta é usada para filtrar a saída e forçar a ordenação, grep seleciona itens que têm texto RGD neles e, em seguida, o cut comando seleciona o quarto campo para mostrar o nome da VM na saída.

az vm list --output tsv --query '[].[id, ___location, resourceGroup, name]' | grep RGD | cut -f4

KBDemo001VM
KBDemo020

O tsv formato de saída geralmente é usado ao atribuir valores a variáveis. Este exemplo obtém a ID de assinatura ativa e a armazena em uma variável para uso em um script.

Bash
PowerShell

# Bash Script
subscriptionID=$(az account show --query id --output tsv)
echo "Using subscription ID $subscriptionID"

# PowerShell script
$subscriptionID = az account show --query id --output tsv
echo "Using subscription ID $subscriptionID"

Para obter mais --query exemplos de parâmetro, consulte Como consultar a saída do comando da CLI do Azure.

Nenhum formato de saída

Alguns comandos da CLI do Azure são informações de saída que você deve proteger. Aqui estão quatro exemplos:

Senhas
Cadeias de conexão
Segredos
Teclas

Para proteger segredos e chaves ao usar comandos da CLI do Azure, escolha uma destas opções:

Opção	Benefício	Caso de uso
`--output none` formato de saída	Impede que informações confidenciais sejam exibidas em seu console. Se o comando falhar, você ainda receberá mensagens de erro.	1. Use quando a saída do comando puder ser recuperada posteriormente.
		2. Use quando não for necessário obter saída.
		3. Uma opção comum quando uma identidade gerenciada ou uma entidade de serviço está sendo usada para gerenciar recursos do Azure.
Parâmetro `--query`	Armazena a saída em uma variável.	1. Use quando a saída do comando não puder ser recuperada posteriormente.
		2. Use quando precisar usar um valor de saída de comando em um script.

Recuperar informações de segurança posteriormente

Alguns Os segredos do Azure podem ser recuperados posteriormente. Um exemplo são os segredos armazenados no Azure Key Vault. Neste exemplo, crie um segredo do Azure Key Vault utilizando az keyvault secret set com a opção --output none. Você pode recuperar o segredo mais tarde usando o comando az keyvault secret show .

az keyvault secret set --name MySecretName \
                       --vault-name MyKeyVaultName \
                       --value MySecretValue\
                       --output none

Armazenar informações de segurança em uma variável

O uso de --query para armazenar a saída em uma variável tecnicamente não é um formato de saída. É uma solução para proteger segredos e é uma alternativa ao uso --output none. Por exemplo, quando você redefine uma credencial de principal de serviço, a senha não pode ser recuperada novamente.

Reinicialize uma credencial de principal de serviço retornando a saída no formato json padrão:

# reset service principal credentials using default output format (json).
az ad sp credential reset --id myServicePrincipalID --output json

Saída do console mostrando a nova senha no console.

{
  "appId": "myServicePrincipalID",
  "password": "myServicePrincipalNewPassword",
  "tenant": "myTenantID"
}

Uma solução melhor é retornar informações confidenciais a uma variável.

Bash
PowerShell

# Bash Script
# reset service principal credentials returning results to a variable
myNewPassword=$(az ad sp credential reset --id myServicePrincipalID --query password --output tsv)

# Display the new password (remove this line in production for security)
echo "New password: $myNewPassword"

# PowerShell script
# Reset service principal credentials and capture the new password
$myNewPassword = (az ad sp credential reset --id myServicePrincipalID --query password --output tsv)

# Display the new password (remove this line in production for security)
Write-Output "New password: $myNewPassword"

Para obter mais exemplos sobre como armazenar a saída em uma variável, consulte Usar a CLI do Azure com êxito – passe valores para outro comando. Para saber mais sobre a sintaxe de parâmetros --query, consulte Como consultar a saída do comando da CLI do Azure.

Definir o formato de saída padrão

Os comandos da CLI do Azure fornecem uma saída que pode ser controlada de duas maneiras:

Controle de saída	Benefício	Como fazer
Configuração global	Selecione um valor de saída padrão que você mais usa para não precisar fornecer continuamente um `--output` parâmetro para cada comando de referência.	Especifique um formato de saída padrão usando az config set.
Parâmetro Command	Especifique a saída no nível de comando e dê aos scripts flexibilidade máxima. Você controla a saída do console e a entrada variável para cada comando de referência.	Substitua a configuração padrão usando o parâmetro `--output` de um comando de referência.

A saída padrão da CLI do Azure é json. Defina a saída padrão para none quando a saída do console não for necessária.

az config set core.output=none

Você pode substituir a saída padrão de qualquer comando de referência da CLI do Azure usando o --output parâmetro. Aqui está um script de comandos que alteram e testam a saída do comando:

# set your default output to table
az config set core.output=table

# show your active subscription in table format
# notice how only a subset of properties are returned in the table
az account show

# override your table default and show your active subscription in jsonc format
az account show --output jsonc

# reset your default output to json
az config set core.output=json

Consulte também

Comentários

Esta página foi útil?