Introdução à CLI do Azure

Artigo
03/08/2024

Bem-vindo(a) à CLI (interface de linha de comando) do Azure! Este artigo apresenta a CLI e ajuda 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 de seu navegador. Para saber mais sobre o Cloud Shell, consulte Início Rápido para Bash no Azure Cloud Shell.

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

Verifique sua versão executando az --versiono . 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 os comandos da CLI do Azure com uma instalação local, é preciso 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, ela iniciará o fluxo de código do dispositivo e instruirá você a abrir uma página do navegador em https://aka.ms/devicelogin. Em seguida, insira o código exibido no terminal.

Se nenhum navegador da Web estiver disponível ou se houver falha ao abrir o navegador, você poderá forçar o fluxo de código do dispositivo com az login --use-device-code.
Entre com suas credenciais de conta no navegador.

Depois de iniciar sessão, recebe uma lista de subscrições associadas à sua conta do Azure. A informação de assinatura com isDefault: true é a assinatura ativada no momento depois de entrar. 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.

Há maneiras de entrar de modo não interativo, como mostrado em detalhes em Entrar com a CLI do Azure.

Localizar 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 nomes de comando que contenham vm, use 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 para máquinas virtuais:

az vm --help

Aqui está um exemplo de saída com linhas omitidas por 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 por 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:

Amostras indexadas 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.

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

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

Usar conclusão de tabulação

A CLI tem conclusão de tabulação completa para comandos em um ambiente Bash. Para habilitar a conclusão de tabulação em um ambiente do PowerShell, consulte Habilitar a conclusão de tabulação no PowerShell.

Esteja ciente dos argumentos disponíveis globalmente

Há 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 seus argumentos, além de listar os comandos e subgrupos disponíveis.
--output altera 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ível por humanos) e yaml. Por padrão, a CLI gera json. Para saber mais sobre os formatos de saída disponíveis, confira Formatos de saída da CLI do Azure.
--query usa o linguagem de consulta JMESPath para filtrar a saída retornada dos serviços do Azure. Para saber mais sobre as consultas, confira Consultar resultados do comando com a CLI do Azure e Tutorial do JMESPath.
--verbose imprime informações sobre recursos criados no Azure durante uma operação, além de outras informações úteis.
--debug imprime ainda mais informações sobre operações de CLI e é usado para fins de depuração. Se você encontrar um bug, forneça a saída gerada com o sinalizador --debug ao enviar um relatório de bugs. Ele pode ser usado, por exemplo, para identificar a API REST que o comando executado está invocando abaixo e a resposta recebida do serviço.
--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 interativo que exibe informações de ajuda automaticamente e torna mais fácil selecionar subcomandos. Você entra 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.

Também há um plug-in do Visual Studio Code que oferece uma experiência interativa, incluindo documentação de preenchimento automático e com o passar do mouse.

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:

Encontre e altere sua assinatura padrão.
Crie um recurso do Azure contendo uma ID aleatória no nome.
Definir 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.

Observação

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.

Envie comentários

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

az feedback

Compartilhar via