Introdução à CLI do Azure

Artigo
03/08/2024

Bem-vindo à CLI (Interface de Linha de Comando) do Azure! Este artigo apresenta a CLI e ajuda você a concluir tarefas comuns.

Instalar ou executar no Azure Cloud Shell

A maneira mais fácil de aprender a usar a CLI do Azure é executando um ambiente Bash no Azure Cloud Shell por meio do navegador. Para saber mais sobre o Cloud Shell, veja Início Rápido do Bash no Azure Cloud Shell.

Quando estiver pronto para instalar a CLI do Azure, consulte as instruções de instalação para Windows, Linux, macOS e contêiner do Docker. Se estiver a utilizar o modelo de implementação clássica do Azure, instale a CLI clássica do Azure.

Verifique a sua versão executando az --version. O Azure Cloud Shell sempre tem a versão mais recente da CLI do Azure pré-instalada.

az version

Entrar na CLI do Azure

Antes de usar qualquer comando da CLI do Azure com uma instalação local, você precisa entrar com az login.

Execute o comando az login.
```
az login
```
Se a CLI do Azure puder abrir seu navegador padrão, ela iniciará o fluxo de código de autorização e abrirá o navegador padrão para carregar uma página de entrada do Azure.

Caso contrário, ele inicia o fluxo de código do dispositivo e instrui você a abrir uma página do navegador em https://aka.ms/devicelogin. Em seguida, insira o código exibido no seu terminal.

Se nenhum navegador da Web estiver disponível ou o navegador da Web não abrir, você pode forçar o fluxo de código do dispositivo com az login --use-device-code.
Inicie sessão com as credenciais da sua conta no browser.

Depois de iniciar sessão, recebe uma lista de subscrições associadas à sua conta do Azure. As informações da subscrição com isDefault: true são a subscrição atualmente ativada após iniciar sessão. Para selecionar outra assinatura, use o comando az account set com o ID de assinatura da conta desejada. Para obter mais informações sobre a seleção de assinaturas, consulte Gerenciar assinaturas do Azure.

Existem formas de iniciar sessão de forma não interativa, que são abordadas em detalhe em Iniciar sessão com a CLI do Azure.

Encontrar comandos

Os comandos da CLI do Azure são organizados como grupos de comandos. Cada grupo representa uma área de um serviço do Azure. Há duas opções para localizar grupos de comandos:

Use o comando az find . Por exemplo, para procurar os nomes dos comando que contenham vm, utilize o seguinte comando:
```
az find vm
```

Use o --help argumento para obter uma lista completa de subgrupos dentro de um grupo de referência. Este exemplo retorna todos os subgrupos de máquinas virtuais:

az vm --help

Aqui está um exemplo de saída com linhas omitidas para brevidade:

Subgroups:
  application            : Manage applications for VM.
  availability-set       : Group resources into availability sets.
  boot-diagnostics       : Troubleshoot the startup of an Azure Virtual Machine.
  ...

Aqui está outro exemplo que localiza os comandos da CLI do Azure para agrupar máquinas virtuais em conjuntos de disponibilidade, um subgrupo de az vm:

az vm availability-set --help

Use também --help para obter listas de parâmetros e exemplos de comandos para um comando de referência.

az vm create --help

Aqui está um exemplo de saída com linhas omitidas para brevidade:

Arguments
    --name  [Required] : Name of the virtual machine.
    ...
Authentication Arguments
    --admin-password   : Password for the VM if authentication type is 'Password'.
    --admin-username   : Username for the VM...
    ...
Managed Service Identity Arguments
    ...
Examples
    Create a VM from a custom managed image.
      az vm create -g MyResourceGroup -n MyVm --image MyImage
    ...

Use o índice de referência de A a Z que lista todos os grupos de comandos em ordem alfabética.

Encontre exemplos e artigos publicados

Se você preferir aprender a sintaxe da CLI do Azure vendo exemplos publicados testados, há dois índices de conteúdo do artigo:

Índice de amostras de A a Z. O índice de exemplos fornece uma lista de exemplos da CLI do Azure classificados por área de assunto, grupo de referência e repositório do GitHub.

Artigo índice A a Z. Use as teclas de atalho do teclado find , como Ctrl + F, para soltar rapidamente no grupo de comandos de referência no qual você está interessado. Por exemplo, o índice do artigo tem esta aparência para az vm:

Subgrupo de referência	Artigo da CLI do Azure mostrando o uso de referência
az vm	Formatos de saída para comandos da CLI do Azure
	Como usar variáveis nos comandos da CLI do Azure
	Obter informações de VM com consultas
	{Mais artigos listados aqui.}
az vm aem	Nova versão da extensão de VM do Azure para soluções SAP
	Versão padrão da extensão de VM do Azure para soluções SAP
Aplicação AZ VM	{...}

Usar preenchimento de guia

A CLI tem conclusão de guia completa para comandos em um ambiente Bash. Para habilitar o preenchimento de guias em um ambiente do PowerShell, consulte Habilitar conclusão de guias no PowerShell.

Esteja ciente dos argumentos disponíveis globalmente

Existem alguns argumentos que estão disponíveis para a maioria dos comandos.

--help imprime as informações de referência da CLI sobre comandos e os respetivos argumentos, bem como apresenta uma lista dos comandos e subgrupos disponíveis.
--output muda o formato de saída. Os formatos de saída disponíveis são json, jsonc (JSON colorido), tsv (Valores separados por tabulação), table (tabelas ASCII legíveis por humanos) e yaml. Por predefinição, a CLI produz json. Para saber mais sobre os formatos de saída disponíveis, veja Formatos de saída para a CLI do Azure.
--query utiliza a Linguagem de Consulta JMESPath para filtrar os resultados devolvidos pelo serviços do Azure. Para saber mais sobre consultas, consulte Resultados do comando de consulta com a CLI do Azure e o tutorial JMESPath.
--verbose imprime informações sobre os recursos criados no Azure durante uma operação e outras informações úteis.
--debug imprime ainda mais informações sobre as operações da CLI utilizadas para efeitos de depuração. Se detetar um erro, forneça o resultado gerado com o sinalizador --debug ativado quando enviar um relatório de erros.
--subscription é o nome ou ID de uma assinatura. Para obter mais informações sobre como definir sua assinatura padrão, consulte Gerenciar assinaturas do Azure com a CLI do Azure.
--only-show-errors suprime avisos na saída do comando e mostra apenas erros.

Usar o modo interativo

A CLI oferece um modo interativa que mostra automaticamente as informações de ajuda e torna mais fácil selecionar os subcomandos. Pode entrar no modo interativo com o comando az interactive.

az interactive

Para obter mais informações sobre o modo interativo, consulte Executar a CLI do Azure no modo interativo.

Há também um plug-in do Visual Studio Code que oferece uma experiência interativa, incluindo documentação de conclusão automática e à passagem do rato.

Aprenda as noções básicas da CLI do Azure com guias de início rápido e tutoriais

Para saber como usar a CLI do Azure, experimente nosso tutorial de integração que ensina as seguintes habilidades ao trabalhar com o Armazenamento do Azure:

Localize e altere a sua subscrição predefinida.
Crie um recurso do Azure contendo uma ID aleatória no nome.
Defina variáveis de ambiente.
Aprenda as diferenças de sintaxe entre Bash, PowerShell e Cmd.
Depurar comandos de referência da CLI do Azure.
Obtenha propriedades de um arquivo JSON local.. Este exemplo mostra como obter valores de configuração para desenvolvimento, estágio e produção.
Exclua vários recursos usando um script.

Nota

Em scripts e no site de documentação da Microsoft, os exemplos da CLI do Azure são escritos para o shell Bash. A maioria dos exemplos de uma linha será executada em qualquer plataforma. Exemplos mais longos que incluem continuações de linha (\), atribuição de variáveis ou aspas precisam ser modificados para funcionar em outros shells, incluindo o PowerShell. Para obter mais informações sobre diferenças de sintaxe entre ambientes, consulte Aprender diferenças de sintaxe entre Bash, PowerShell e Cmd.

Enviar comentários

Apreciamos os seus comentários para a CLI para ajudar-nos a melhorar e resolver erros. Você pode registrar um problema no GitHub ou usar os recursos internos da CLI para deixar comentários gerais com o comando az feedback .

az feedback