Configuração da CLI do Azure
A CLI do Azure permite a definição, pelo usuário, de configurações como registro em log, coleta de dados e valores de argumento padrão. A CLI oferece um comando de conveniência para gerenciar alguns padrões, az config, e uma opção interativa por meio de az init. Outros valores podem ser definidos em um arquivo de configuração ou com variáveis de ambiente. Este artigo fornece mais informações sobre essas definições de configuração do usuário e como configurar a CLI do Azure.
Os valores da configuração usados pela CLI são avaliados na seguinte precedência, com os itens na parte superior da lista sendo prioridade.
- Parâmetros de linha de comando
- Variáveis de ambiente
- Valores no arquivo de configuração definidos com
az configouaz init
Definir configurações usando az init
A maneira mais fácil de definir as configurações da CLI do Azure é usar o comando interativo az init. Escolha uma configuração comum, como "interação" ou "automação", ou opte por definir configurações individuais. O que é especialmente útil com essa abordagem é que az init fornece motivos pelos quais você pode querer escolher uma opção de configuração em vez de outra.
az init
Definir configurações usando az config
Você define padrões para a CLI com o comando az config set.
Esse comando usa um argumento que é uma lista separada por espaços de pares key=value. Os valores fornecidos são usados pela CLI do Azure no lugar dos argumentos necessários.
A tabela a seguir contém uma lista de chaves de configuração disponíveis.
| Nome | Descrição |
|---|---|
| defaults.group | O grupo de recursos padrão para usar para todos os comandos. |
| defaults.location | O local padrão para usar para todos os comandos. |
| defaults.web | O nome de aplicativo padrão para usar para os comandos az webapp. |
| defaults.vm | O nome de VM padrão para usar para os comandos az vm. |
| defaults.vmss | O nome do VMSS (conjunto de dimensionamento de máquinas virtuais) a ser usado para comandos az vmss. |
| defaults.acr | O nome de registro de contêiner padrão para usar para os comandos az acr. |
Como exemplo, a seguir você vê como poderia definir o grupo de recursos e local padrão para todos os comandos.
az config set defaults.location=westus2 defaults.group=MyResourceGroup
O comando a seguir desativa os links de pesquisa durante a execução dos comandos da CLI do Azure:
az config set output.show_survey_link=no
Arquivo de configuração da CLI
O arquivo de configuração da CLI contém outras configurações que são usadas para gerenciar o comportamento da CLI. O arquivo de configuração em si está localizado em $AZURE_CONFIG_DIR/config. O valor padrão de AZURE_CONFIG_DIR é $HOME/.azure no Linux e macOS, e %USERPROFILE%\.azure no Windows.
Os arquivos de configuração são gravados no formato de arquivo INI. Os cabeçalhos de seção definem o formato do arquivo, seguido por uma lista de entradas chave-valor.
- Os cabeçalhos de seção são gravados como
[section-name]. Os nomes de seção diferenciam maiúsculas de minúsculas. - As entradas são gravadas como
key=value. Nomes de campo não diferenciam maiúsculas de minúsculas. - Os comentários são qualquer linha que comece com um
#ou;. Não são permitidos comentários em linha.
Boolianos não diferenciam maiúsculas de minúsculas. Os seguintes valores representam boolianos:
- Verdadeiro:
1,yes,trueeon - Falso:
0,no,falseeoff
Veja um exemplo de um arquivo de configuração da CLI que desabilita prompts de confirmação e define o log para o diretório /var/log/azure.
[core]
disable_confirm_prompt=Yes
[logging]
enable_log_file=yes
log_dir=/var/log/azure
Consulte a próxima seção para obter detalhes sobre todos os valores de configuração disponíveis e o que significam. Para obter detalhes completos sobre o formato de arquivo INI, consulte a Documentação do Python sobe INI.
Valores de configuração da CLI e variáveis de ambiente
A tabela a seguir contém todas as seções e as opções de nomes que podem ser colocadas em um arquivo de configuração. Suas variáveis de ambiente correspondentes estão definidas como AZURE_{section}_{name}, tudo em maiúsculas. Por exemplo, a output padrão para core é definida na variável AZURE_CORE_OUTPUT, a storage_account padrão para batchai é definida na variável AZURE_BATCHAI_STORAGE_ACCOUNT e a location padrão é definida na variável AZURE_DEFAULTS_LOCATION.
Quando você fornece um valor padrão, esse argumento já não é exigido pelos comandos. Em vez disso, o valor padrão é usado.
| Seção | Nome | Tipo | Descrição |
|---|---|---|---|
| core | output | string | O formato de saída padrão. Valores permitidos: json (padrão), jsonc, yaml, yamlc, table, tsv, none. Para obter mais informações, confira Formatos de saída para comandos da CLI do Azure. |
| disable_confirm_prompt | booleano | Ativa e desativa prompts de confirmação. | |
| display_region_identified | booleano | Os clientes do Azure podem optar por implantar recursos em várias regiões diferentes. Em alguns casos, os clientes podem reduzir os custos selecionando regiões próximas que oferecem os mesmos serviços. Se uma região próxima for identificada, uma mensagem exibirá a região a ser selecionada para implantações futuras. Essa configuração controla se a mensagem será exibida. | |
| collect_telemetry | booleano | Permitir que a Microsoft colete dados anônimos sobre o uso da CLI. Para obter informações de privacidade, confira os Termos de uso da licença MIT da CLI do Azure. | |
| only_show_errors | booleano | Mostra apenas erros durante a invocação de comando. Em outras palavras, somente erros serão gravados em stderr. Ele suprime avisos dos comandos em versão prévia, preteridos e experimentais. Ele também está disponível para comandos individuais com o parâmetro --only-show-errors. |
|
| enable_broker_on_windows | boolean | Use o Gerenciador de Contas da Web (WAM) para autenticar no Azure por meio do az login comando. |
|
| login_experience_v2 | boolean | Ativar/desativar o az login seletor de assinatura. |
|
| no_color | booleano | Desabilita a cor. As mensagens originalmente coloridas serão prefixadas com DEBUG, INFO, WARNING e ERROR. Essa booleana ignora o problema de uma biblioteca de terceiro em que a cor do terminal não pode ser revertida depois de um redirecionamento de stdout. |
|
| Clientes | show_secrets_warning | boolean | Ativar/desativar o aviso de saída de informações confidenciais. |
| logging | enable_log_file | booleano | Ativar e desativar o registro em log. |
| log_dir | string | O diretório no qual gravar os logs. Por padrão, esse valor é ${AZURE_CONFIG_DIR}/logs*. |
|
| defaults | group | string | O grupo de recursos padrão para usar para todos os comandos. |
| local | string | O local padrão para usar para todos os comandos. | |
| web | string | O nome de aplicativo padrão para usar para os comandos az webapp. |
|
| vm | string | O nome de VM padrão para usar para os comandos az vm. |
|
| vmss | string | O nome do VMSS (conjunto de dimensionamento de máquinas virtuais) a ser usado para comandos az vmss. |
|
| acr | string | O nome de registro de contêiner padrão para usar para os comandos az acr. |
|
| storage | account | string | O nome da conta de armazenamento padrão (por exemplo, mystorageaccount em https://mystorageaccount.blob.core.windows.net) a ser usada para comandos do plano de dados az storage (por exemplo, az storage container list). |
| chave | string | A chave de acesso padrão a ser usada para os comandos de plano de dados az storage. |
|
| sas_token | string | O token SAS padrão a ser usado para os comandos de plano de dados az storage. |
|
| connection_string | string | A cadeia de conexão padrão a ser usada para os comandos de plano de dados az storage. |
|
| batchai | storage_account | string | A conta de armazenamento padrão a ser usada para comandos az batchai. |
| storage_key | string | A chave de armazenamento padrão a ser usada para comandos az batchai. |
|
| batch | account | string | O nome de conta do Lote do Azure a ser usado para comandos az batch. |
| access_key | string | A chave de acesso padrão a ser usada para comandos az batch. Usado somente com autorização aad. |
|
| endpoint | string | O ponto de extremidade padrão ao qual se conectar para comandos az batch. |
|
| auth_mode | string | O modo de autorização a ser usado para comandos az batch. Valores Permitidos: shared_key e aad. |
|
| nuvem | name | string | A nuvem padrão para todos os comandos az. Valores permitidos: AzureCloud (padrão), AzureChinaCloud, AzureUSGovernment. Para alterar as nuvens é possível usar o comando az cloud set –name. Para obter um exemplo, consulte Gerenciar Nuvens com a CLI do Azure. |
| extension | use_dynamic_install | string | Instale uma extensão se ela ainda não tiver sido adicionada ao executar um comando por meio dela. Valores permitidos: no (padrão), yes_prompt, yes_without_prompt. |
| run_after_dynamic_install | booleano | Continue a executar o comando quando uma extensão for instalada dinamicamente para ele. O padrão é False. |
|
| index_url | string | URL do arquivo de índice de extensão privada seguindo o formato em index.json. Após a especificação, a execução de az extension add --name <extension-name> usará esse arquivo para localizar a extensão a ser adicionada. |
Observação
Você pode ver outros valores em seu arquivo de configuração, mas eles são gerenciados diretamente por meio de comandos da CLI, incluindo az config. Os valores listados na tabela acima são os únicos que você mesmo deve alterar.
