Explorar a configuração da CLI do Desenvolvedor do Azure

A CLI do Desenvolvedor do Azure (azd) permite que você gerencie azd configurações usando um conjunto de azd config comandos. Essas configurações incluem padrões úteis, como sua assinatura e localização Azure, bem como configurações usadas por outros azd comandos ou recursos. Você também pode obter e definir seus próprios valores personalizados e usá-los em scripts ou funcionalidade personalizada.

Neste artigo, você aprenderá:

  • Principais conceitos sobre a configuração da Azure Developer CLI
  • Como trabalhar com azd config comandos
  • Como azd config se integra a outros azd recursos

Explorar o arquivo de configuração da CLI do desenvolvedor Azure

Quando você instala pela primeira vez a CLI do Desenvolvedor do Azure, um arquivo nomeado config.json é adicionado no seguinte local:

  • $HOME/.azd no Linux e macOS
  • %USERPROFILE%\.azd no Windows

Tip

O diretório de configuração pode ser substituído especificando um caminho na variável de AZD_CONFIG_DIR ambiente.

As configurações neste arquivo gerenciam a funcionalidade, como:

  • A assinatura do Azure ou a localização padrão a ser usada ao provisionar ou implantar recursos
  • Quais recursos alfa estão habilitados
  • Quais locais de origem do modelo estão configurados
  • Valores personalizados definidos pelo usuário para scripts ou outras finalidades

Por padrão, o config.json arquivo contém apenas algumas configurações para os locais de origem do modelo padrão azd . À medida que você usa vários recursos da CLI do Desenvolvedor do Azure, alguns valores são preenchidos config.json automaticamente. Por exemplo, na primeira vez que você executar o azd up comando, a assinatura e o local selecionados para provisionamento e implantação são armazenados na defaults seção do arquivo.

Um arquivo simples config.json pode ser semelhante ao seguinte:

{
  "defaults": {
    "location": "eastus2",
    "subscription": "your-subscription-id"
  },
  "template": {
    "sources": {
      "awesome-azd": {
        "key": "awesome-azd",
        "location": "https://aka.ms/awesome-azd/templates.json",
        "name": "Awesome AZD",
        "type": "awesome-azd"
      },
      "default": {
        "key": "default",
        "name": "default"
      }
    }
  }
}

Trabalhar com comandos de configuração

A CLI do Desenvolvedor do Azure fornece um conjunto de comandos para gerenciar as configurações no config.json arquivo manualmente:

  • azd config get: obtenha um valor de configuração.
  • azd config list-alpha: exiba a lista de recursos disponíveis no estágio alfa.
  • azd config reset: redefinir a configuração como padrão.
  • azd config set: defina uma configuração.
  • azd config show: mostrar todos os valores de configuração.
  • azd config unset: Desative uma configuração.

Esses comandos são explorados mais nas seções a seguir. Você também pode visitar a página de referência dos comandos da CLI de Desenvolvedor do Azure para saber mais sobre os comandos azd.

Configurações de exibição

Exiba o conteúdo atual de todo config.json o arquivo a qualquer momento executando o azd config show comando:

azd config show

Saída de exemplo:

{
  "defaults": {
    "location": "eastus2",
    "subscription": "your-subscription-id"
  },
  "template": {
    "sources": {
      "awesome-azd": {
        "key": "awesome-azd",
        "location": "https://aka.ms/awesome-azd/templates.json",
        "name": "Awesome AZD",
        "type": "awesome-azd"
      },
      "default": {
        "key": "default",
        "name": "default"
      }
    }
  }
}

Exiba um valor de configuração específico usando o azd config get <key> comando:

azd config get defaults

Saída de exemplo:

"defaults": {
    "location": "eastus2",
    "subscription": "your-subscription-id"
}

Habilitar ou desabilitar recursos alfa é uma tarefa de configuração comum, portanto azd , também inclui um comando de conveniência para exibir o status atual dos recursos alfa:

azd config list-alpha

Saída de exemplo:

Name: aca.persistDomains
Description: Do not change custom domains when deploying Azure Container Apps.
Status: Off

Name: aca.persistIngressSessionAffinity
Description: Do not change Ingress Session Affinity when deploying Azure Container Apps.
Status: Off

Name: aks.helm
Description: Enable Helm support for AKS deployments.
Status: On

Name: aks.kustomize
Description: Enable Kustomize support for AKS deployments.
Status: Off

Name: azd.operations
Description: Extends provisioning providers with azd operations.
Status: Off

Name: deployment.stacks
Description: Enables Azure deployment stacks for ARM/Bicep based deployments.
Status: Off

Name: llm
Description: Enables the use of LLMs in the CLI.
Status: Off

Obter e definir configurações

Você pode obter, definir ou desafinar valores no config.json arquivo usando azd config comandos. Algumas configurações específicas são usadas por outros azd recursos e comandos, como ao habilitar recursos alfa ou definir fontes de modelo, mas você também pode definir seus próprios valores personalizados.

Gerenciar configurações usadas por azd

Use o azd config set <key> <value> comando para adicionar uma configuração ao config.json arquivo.

Por exemplo, para habilitar os recursos de LLM usados pela integração do GitHub Copilot:

azd config set alpha.llm on

Observação

Selecionar Configurar com o GitHub Copilot (pré-visualização) durante azd init habilita essa configuração automaticamente. Use a sintaxe . para navegar pelas estruturas de objetos JSON ao obter e definir valores de configuração.

Verifique se a configuração foi habilitada usando o azd config get <key> comando, como o seguinte:

azd config get alpha.llm

Saída de exemplo:

"on"

Nesse cenário, você também pode executar azd config get alpha para exibir todo o objeto JSON no config.json arquivo:

azd config get alpha

Saída de exemplo:

{
  "llm": "on"
}

Gerenciar configurações personalizadas

Você também pode definir valores de configuração personalizados para usar em ganchos e scripts de cliente azd. Esses valores de configuração fornecem uma alternativa ao uso de variáveis de ambiente.

Para definir um valor de configuração personalizado:

azd config get customVal hello-world

Obtenha o valor de configuração personalizado:

azd config get customVal

Saída de exemplo:

hello-world

Redefinir configurações

Você pode redefinir o arquivo da CLI config.json do Desenvolvedor do Azure de volta aos seus padrões usando o azd config reset comando, que exclui o conteúdo do arquivo:

azd config reset

Ao executar azd config show após uma redefinição, você simplesmente verá um objeto vazio:

{}

Próximas Etapas 

Visão geral do desenvolvimento de modelos

  • Última atualização em