Gerenciar extensões da CLI do Azure: instalar, atualizar e remover

A CLI do Azure oferece a capacidade de carregar extensões. As extensões da CLI do Azure são caracterizadas como rodas Python que não são enviadas como parte da CLI, mas executadas como comandos da CLI. Com as extensões, você recebe acesso a comandos experimentais e de pré-lançamento, juntamente com a capacidade de escrever suas próprias interfaces de CLI. Este artigo aborda como gerenciar extensões e responde a perguntas comuns sobre seu uso.

Como localizar extensões

Para ver as extensões da CLI do Azure fornecidas e mantidas pela Microsoft, use o comando az extension list-available .

az extension list-available --output table

Também hospedamos uma lista de extensões no site de documentação.

Como instalar extensões

Instalar extensões manualmente

Depois de encontrar uma extensão para instalar, use az extension add para instalá-la. Se a extensão aparecer na saída de az extension list-available, você poderá instalá-la pelo nome.

az extension add --name <extension-name>

Se a extensão for de um recurso externo ou se você tiver um link direto para ela, forneça a URL de origem ou o caminho local. A extensão deve ser um arquivo de roda do Python compilado.

az extension add --source <URL-or-path>

Você também pode criar um índice de extensão privada seguindo o formato em index.jsone, em seguida, definir a URL de índice de extensão usada pela CLI do Azure para ele a partir da versão 2.20.0. Depois disso, é possível instalar a extensão pelo nome a partir do índice particular de extensões.

az config set extension.index_url=<URL>
az extension add --name <extension-name>

Depois de instalar uma extensão, ela aparecerá sob o valor da variável de $AZURE_EXTENSION_DIR shell. Se essa variável não estiver configurada, o local padrão será $HOME/.azure/cliextensions no Linux e no macOS e %USERPROFILE%\.azure\cliextensions no Windows.

Instalar extensões automaticamente

Quando você executa um comando de extensão que não está instalado, a CLI do Azure pode reconhecer o comando executado e instalar automaticamente a extensão para você a partir da versão 2.10.0. Esse recurso, conhecido como instalação dinâmica, é habilitado por padrão a partir da versão 2.12.0. Você também pode habilitá-lo por meio da configuração para versões anteriores com suporte.

az config set extension.use_dynamic_install=yes_prompt

Use o comando de configuração a seguir para habilitar a instalação dinâmica sem um prompt.

az config set extension.use_dynamic_install=yes_without_prompt

Use o comando de configuração a seguir para desativar o recurso de instalação dinâmica para reverter para o comportamento padrão. O comando de extensão retornará um erro de comando não encontrado se a extensão não estiver instalada.

az config set extension.use_dynamic_install=no

Por padrão, um comando de extensão que solicita uma instalação dinâmica continua sendo executado após a instalação da extensão. Você pode alterar o comportamento padrão e fazer o comando sair sem uma nova execução definindo a run_after_dynamic_install propriedade como no.

az config set extension.run_after_dynamic_install=no

Como atualizar extensões

Se você instalar uma extensão por nome, atualize-a usando az extension update.

az extension update --name <extension-name>

Caso contrário, uma extensão pode ser atualizada da origem seguindo as instruções de instalação de extensões .

Se você não puder usar a CLI para resolver um nome de extensão, desinstale a extensão e tente reinstalá-la. A extensão também pode fazer parte da CLI base. Atualize a CLI conforme descrito em Instalar a CLI do Azure e verifique se os comandos da extensão estão disponíveis.

Como desinstalar extensões

Se você não precisar mais de uma extensão, remova-a com az extension remove.

az extension remove --name <extension-name>

Você também pode remover uma extensão manualmente excluindo-a do local onde ela foi instalada. A $AZURE_EXTENSION_DIR variável de shell define onde os módulos são instalados. Se essa variável tiver sua definição removida, por padrão, o valor é $HOME/.azure/cliextensions no Linux e macOS e %USERPROFILE%\.azure\cliextensions no Windows.

rm -rf $AZURE_EXTENSION_DIR/<extension-name>

Perguntas Freqüentes

Aqui estão algumas respostas para outras perguntas comuns sobre extensões da CLI.

Quais formatos de arquivo são permitidos para instalação?

Atualmente, somente as rodas do Python compiladas podem ser instaladas como extensões.

As extensões podem substituir os comandos existentes?

Sim. As extensões podem substituir os comandos existentes, mas a CLI emite um aviso antes de executar um comando substituído.

Como posso saber se uma extensão está em pré-lançamento?

A documentação e o controle de versão de uma extensão mostram se ela está em pré-lançamento. A Microsoft geralmente lança comandos de visualização como extensões da CLI, com a opção de movê-los para o produto principal da CLI mais tarde. Quando os comandos são movidos para fora das extensões, a extensão antiga deve ser desinstalada.

As extensões podem depender umas das outras?

Não. Como a CLI não garante uma ordem de carga, as dependências podem não ser atendidas. Remover uma extensão não afeta outras pessoas.

As extensões são atualizadas junto com a CLI?

Não. As extensões devem ser atualizadas separadamente, conforme descrito nas extensões de atualização.

Como desenvolver nossa própria extensão?

Consulte o repositório oficial para obter mais ajuda. Azure/azure-cli-extensions