Configuração da CLI do Azure

A CLI do Azure permite que o utilizador configure definições como o registo, a recolha de dados e os valores de argumento predefinidos. A CLI oferece um comando de conveniência para gerenciar alguns padrões, az confige uma opção interativa através do az init. Outros valores podem ser definidos num ficheiro 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 de configuração utilizados pela CLI são avaliados na seguinte precedência, em que os itens mais acima na lista têm prioridade.

  1. Parâmetros da linha de comandos
  2. Variáveis de ambiente
  3. Valores no arquivo de configuração definido com az config ou az 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 percorrer configurações individuais. O que é especialmente útil com essa abordagem é az init fornecer razões pelas quais você pode querer escolher uma opção de configuração em vez de outra.

az init

Definir configurações usando az config

Você pode definir padrões para a CLI com o comando az config set . Este comando usa uma lista de pares separados por key=value espaço como um argumento. Os valores fornecidos são usados pela CLI do Azure no lugar dos argumentos necessários.

A tabela seguinte contém uma lista das chaves de configuração disponíveis.

Nome Descrição
defaults.group O grupo de recursos predefinido a utilizar para todos os comandos.
defaults.location A localização predefinida a utilizar para todos os comandos.
padrão.web O nome da aplicação predefinido a utilizar para comandos az webapp.
defaults.vm O nome da VM predefinido a utilizar para comandos az vm.
defaults.vmss O nome padrão do conjunto de escala de máquina virtual (VMSS) a ser usado para az vmss comandos.
defaults.acr O nome do registo de contentor predefinido a utilizar para comandos az acr.

Como exemplo, eis como pode definir o grupo de recursos predefinido e a localizaçã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

Ficheiro de configuração de CLI

O ficheiro de configuração da CLI contém outras definições que são utilizadas para gerir o comportamento da CLI. O próprio ficheiro de configuração está localizado em $AZURE_CONFIG_DIR/config. O valor predefinido de AZURE_CONFIG_DIR é $HOME/.azure em Linux e macOS, e %USERPROFILE%\.azure no Windows.

Os ficheiros de configuração são escritos no formato de ficheiro INI. Os cabeçalhos de seção definem o formato do arquivo, seguido por uma lista de entradas chave-valor.

  • Os cabeçalhos de secção são escritos como [section-name]. Os nomes de secção são sensíveis às maiúsculas e minúsculas.
  • As entradas são escritas como key=value. Os nomes das chaves não diferenciam maiúsculas de minúsculas.
  • Os comentários consistem em qualquer linha que comece com um # ou ;. Comentários embutidos não são permitidos.

Os booleanos não diferenciam maiúsculas de minúsculas. Os seguintes valores representam booleanos:

  • Verdadeiro: 1, , , , yestrueon
  • Falso: 0, , , , nofalseoff

Segue-se um exemplo de um ficheiro de configuração de CLI que desativa qualquer pedido de confirmação e configura o registo no diretório /var/log/azure.

[core]
disable_confirm_prompt=Yes

[logging]
enable_log_file=yes
log_dir=/var/log/azure

Consulte a secção seguinte para obter detalhes sobre todos os valores de configuração disponíveis e o que significam. Para mais informações sobre o formato de ficheiro INI, consulte a documentação Python no INI.

Valores de configuração da CLI e as variáveis de ambiente

A tabela seguinte contém todas as secções e os nomes das opções que podem ser colocados num ficheiro de configuração. As variáveis de ambiente correspondentes são definidas como AZURE_{section}_{name}, em maiúsculas. Por exemplo, output o padrão para é definido na variável, o padrão para batchaicore é definido na variável e o storage_account padrão location é definido na AZURE_CORE_OUTPUTAZURE_BATCHAI_STORAGE_ACCOUNTAZURE_DEFAULTS_LOCATION variável.

Quando fornecer um valor predefinido, esse argumento já não é preciso para qualquer comando. Em vez disso, é utilizado o valor predefinido.

Secção Nome Tipo Description
core saída string O formato de saída predefinido. Valores permitidos: json (padrão), jsonc, , , table, , noneyamlyamlctsv. Para obter mais informações, consulte Formatos de saída para comandos da CLI do Azure.
disable_confirm_prompt boolean Ativar/desativar os pedidos de confirmação.
display_region_identified boolean Os clientes do Azure podem optar por implantar recursos em muitas 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 é exibida.
collect_telemetry boolean Permitir a recolha de dados anónimos sobre a utilização da CLI. Para obter informações de privacidade, consulte a licença MIT da CLI do Azure.
only_show_errors boolean Mostrar erros apenas durante a chamada de comando. Em outras palavras, apenas erros são gravados em stderr. Ele suprime avisos de comandos de visualização, preteridos e experimentais. Também está disponível para comandos individuais com o --only-show-errors parâmetro.
no_color boolean Desative a cor. Originalmente, as mensagens coloridas são prefixadas com DEBUG, INFOWARNING e ERROR. Este booleano ignora a questão de uma biblioteca de terceiros onde a cor do terminal não pode reverter após um stdout redirecionamento.
clientes show_secrets_warning boolean Ligue/desative o aviso de saída de informações confidenciais.
logging enable_log_file boolean Permite iniciar e terminar a sessão.
log_dir string O diretório para o qual escrever os registos. Por predefinição, este valor é ${AZURE_CONFIG_DIR}/logs*.
inadimplência grupo string O grupo de recursos predefinido a utilizar para todos os comandos.
localização string A localização predefinida a utilizar para todos os comandos.
web string O nome da aplicação predefinido a utilizar para comandos az webapp.
cm string O nome da VM predefinido a utilizar para comandos az vm.
vmss string O nome padrão do conjunto de escala de máquina virtual (VMSS) a ser usado para az vmss comandos.
acr string O nome do registo de contentor predefinido a utilizar para comandos az acr.
storage conta string O nome da conta de armazenamento padrão (por exemplo, mystorageaccount em ) a ser usado para az storage comandos de plano de dados (por exemplo, az storage container list).https://mystorageaccount.blob.core.windows.net
key string A chave de acesso padrão a ser usada para az storage comandos de plano de dados.
sas_token string O token SAS padrão a ser usado para az storage comandos de plano de dados.
connection_string string A cadeia de conexão padrão a ser usada para az storage comandos de plano de dados.
batchai storage_account string A conta de armazenamento predefinida a utilizar para comandos az batchai.
storage_key string A chave de armazenamento predefinida a utilizar para comandos az batchai.
batch conta string O nome da conta do Azure Batch predefinido a utilizar para os comandos az batch.
access_key string A chave de acesso predefinida a utilizar para comandos az batch. Apenas utilizado para autorização aad.
endpoint string O ponto final predefinido para ligar a comandos az batch.
auth_mode string O modo de autorização a utilizar para comandos az batch. Valores permitidos: shared_key, aad.
nuvem nome string A nuvem padrão para todos os az comandos. Valores permitidos: AzureCloud (padrão), AzureChinaCloud, AzureUSGovernment. Para alterar nuvens, você pode usar o az cloud set –name comando. Para obter um exemplo, consulte Gerenciar nuvens com a CLI do Azure.
Extensão use_dynamic_install string Instale uma extensão se ela ainda não tiver sido adicionada ao executar um comando a partir dela. Valores permitidos: no (padrão), yes_prompt, yes_without_prompt.
run_after_dynamic_install boolean Continue a executar o comando quando uma extensão for instalada dinamicamente para ele. A predefinição é False.
index_url string URL do arquivo de índice de extensão privada seguindo o formato em index.json. Uma vez especificado, a execução usa esse arquivo para encontrar a extensão a az extension add --name <extension-name> ser adicionada.

Nota

Pode ver outros valores no seu ficheiro de configuração, mas esses são geridos diretamente através dos comandos da CLI, incluindo az config. Os listados na tabela anteriormente são os únicos valores que você mesmo deve alterar.