Partilhar via

Como trabalhar com parâmetros globais na CLI do Azure

  • Artigo

Quando você trabalha com os comandos de referência da CLI do Azure, há argumentos que estão disponíveis para a maioria dos comandos. Esses argumentos são chamados de "parâmetros globais", pois são comuns a quase todos os comandos de referência da CLI do Azure.

--help parâmetro global

Para obter informações sobre um grupo de referência ou comando, use o --help parâmetro global. O --help parâmetro exibe informações de referência da CLI do Azure em seu console, incluindo listas de subgrupos e parâmetros disponíveis.

az group create --name myResourceGroup --location eastus --help

A seguinte saída de console mostrada aqui tem campos omitidos para brevidade:

Command
    az group create : Create a new resource group.

Arguments
    --location -l                 [Required] : Location. Values from: `az account list-locations`.
                                               You can configure the default location using `az
                                               configure --defaults location=<location>`.
    --name --resource-group -g -n [Required] : Name of the new resource group.
    --managed-by                             : The ID of the resource that manages this resource
                                               group.
    --tags                                   : Space-separated tags: key[=value] [key[=value] ...].
                                               Use "" to clear existing tags.

Global Arguments
    --debug                                  : Increase logging verbosity to show all debug logs.
    --help -h                                : Show this help message and exit.
    --only-show-errors                       : Only show errors, suppressing warnings.

Examples
    Create a new resource group in the West US region.
        az group create -l westus -n MyResourceGroup

--verbose parâmetro global

Saiba mais detalhes sobre o registro em log adicionando o --verbose parâmetro global ao seu comando de referência. A saída detalhada é útil ao tentar entender por que certos comandos levam mais tempo do que outros para serem executados.

az group create --name myResourceGroup --location eastus --verbose

A saída do console a seguir mostrada aqui tem campos omitidos para brevidade, mas observe as informações adicionais sobre o tempo de execução.

{...}
Command ran in 1.413 seconds (init: 0.487, invoke: 0.926)

--debug parâmetro global

Se os detalhes extras do --verbose parâmetro não forem suficientes e você desejar visualizar o log inteiro, use o --debug parâmetro global. Forneça também a saída gerada ao --debug enviar um relatório de bug.

az group create --name myrResourceGroup --location eastus --debug

A seguinte saída de console mostrada aqui tem campos omitidos para brevidade:


cli.knack.cli: Command arguments: ['group', 'create', '--name', 'myResourceGroup', '--location', 'eastus', '--debug']
cli.knack.cli: __init__ debug log:
[...]
cli.knack.cli: Event: CommandInvoker.OnTransformResult [<function _resource_group_transform at 0x000001D9B72123B0>, <function _x509_from_base64_to_hex_transform at 0x000001D9B7212440>]
cli.knack.cli: Event: CommandInvoker.OnFilterResult []
{...}
[...]
telemetry.process: Return from creating process
telemetry.main: Finish creating telemetry upload process.

--only-show-errors parâmetro global

Durante o processo de depuração, remova os avisos retornados por um comando de referência usando o --only-show-errors parâmetro global.

az interactive

Console de saída:

**This command is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus**

Any comments or concerns? You can use the 'feedback' command! We would greatly appreciate it.

A new Recommender is added which can make the completion ability more intelligent and provide the scenario completion!
If you want to disable this feature, you can use 'az config set interactive.enable_recommender=False' to disable it.

A command preload mechanism was added to prevent lagging and command run errors.
You can skip preloading in a single pass by CTRL+C or turn it off by setting 'az config set interactive.enable_preloading=False'

Loading command table... Expected time around 1 minute.

--subscription parâmetro global

Você pode usar o --subscription parâmetro global para definir uma assinatura específica para um comando. O exemplo a seguir altera a assinatura ativa usando a ID da assinatura:

az account set --subscription "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

--output parâmetro global

Para mostrar a saída de um comando em um formato específico, especifique o --output parâmetro global. Neste exemplo, a saída é mostrada como uma tabela:

Nota

Os valores aceitos para saída são: json, jsonc, none, table, tsv, yaml e yamlc. O valor de saída padrão é json.

az vm list --resource-group myResourceGroup --output table

Console de saída:

Name    ResourceGroup    Location
------  ---------------  ----------
myVm    myResourceGroup  eastus

Para saber mais sobre os diferentes formatos de saída, consulte Formatos de saída para comandos da CLI do Azure.

--query parâmetro global

Há momentos em que o console de saída pode exibir grandes quantidades de informações que você precisa filtrar. Para fazer isso, use o --query parâmetro global para executar uma consulta JMESPath nos resultados dos comandos. JMESPath é uma linguagem de consulta para JSON, que lhe dá a capacidade de selecionar e modificar dados da saída da CLI do Azure.

Este exemplo retorna as chaves públicas SSH autorizadas a se conectar à máquina virtual adicionando --query:

 az vm show --resource-group myResourceGroup --name myVm --query "osProfile.linuxConfigurat
ion.ssh.publicKeys"

Console de saída:

[
  {
    "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC7WbiMEsB0iwdGPjeGXs3UWFtzbCkUwtIxzkIOpEtlqkLGa0XQdvwhzok6szq6Ycx/f4cfid/yrmBPtzmxdQnGeCy2FOcVIzp+SkjIUg/Ez2YyDcMb60u66QUmHPRyhipJ/PDZROt6O0092qfTkTjB+7hLRiZzV2raLjiQ95eV0AXUP+Gsvdo/7ytqWNIm3iQTWbQ/GwSg+p0v+kmZELIbrxo845dambSpgBL8g0wCUZaptru3ZHo9m0UWbFPASVJKauhfPCSVPQCaOCaAdB01Ih8QDVRCazT+jyV6GgTwUIXVQthVBbt56ibhuSUdf0cWF8IVncjH+WXexVAhQw0j",
    "path": "/home/daphnema/.ssh/authorized_keys"
  }
]

Para saber mais sobre como consultar a saída do comando, consulte Como consultar a saída do comando CLI do Azure usando uma consulta JMESPath.

Consulte também