Explore Azure Developer CLI configuration

O Azure Developer CLI (azd) permite-lhe gerir azd configurações usando um conjunto de azd config comandos. Estas definições de configuração incluem predefinições úteis, como a sua subscrição e localização do Azure, bem como definições usadas por outros azd comandos ou funcionalidades. Também podes obter e definir os teus próprios valores personalizados e usá-los em scripts ou funcionalidades personalizadas.

Neste artigo, vai aprender a:

  • Conceitos-chave sobre a configuração do CLI do Azure Developer
  • Como trabalhar com azd config comandos
  • Como azd config se integra com outras azd funcionalidades

Explore o ficheiro de configuração da CLI do Azure Developer

Quando instala pela primeira vez a CLI do Azure Developer, um ficheiro nomeado config.json é adicionado na seguinte localização:

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

Dica

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

As definições deste ficheiro gerem funcionalidades como:

  • A subscrição ou localização padrão do Azure para usar quando provisionas ou implementas recursos
  • Quais funcionalidades alfa estão ativadas
  • Que localizações de origem dos templates estão configuradas
  • Valores personalizados definidos pelo utilizador para scripts ou outros fins

Por defeito, o config.json ficheiro contém apenas algumas configurações para as localizações de origem padrão azd dos templates. À medida que utilizas várias funcionalidades da CLI do Azure Developer, alguns valores são preenchidos automaticamenteconfig.json. Por exemplo, na primeira vez que executa o azd up comando, a subscrição e a localização que seleciona para provisionamento e implementação ficam armazenadas na defaults secção do ficheiro.

Um ficheiro simples config.json pode assemelhar-se 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"
      }
    }
  }
}

Trabalho com comandos de configuração

A CLI do Azure Developer fornece um conjunto de comandos para gerir manualmente as definições no config.json ficheiro:

  • azd config get: Obtenha um valor de configuração.
  • azd config list-alpha: Mostrar a lista de funcionalidades disponíveis na fase alfa.
  • azd config reset: Redefinir a configuração para o padrão.
  • azd config set: Defina uma configuração.
  • azd config show: Mostrar todos os valores de configuração.
  • azd config unset: Desconfigurar uma configuração.

Estes comandos são explorados mais detalhadamente nas secções seguintes. Também pode visitar a página de referência dos comandos da CLI do Azure Developer para saber mais acerca dos comandos azd.

Configurações de exibição

Veja o conteúdo atual de todo config.json o ficheiro a qualquer momento, executando o azd config show comando:

azd config show

Resultado do 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"
      }
    }
  }
}

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

azd config get defaults

Resultado do exemplo:

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

Ativar ou desativar funcionalidades alfa é uma tarefa comum de configuração, incluindo azd também um comando de conveniência para visualizar o estado atual das funcionalidades alfa:

azd config list-alpha

Resultado do 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

Podes obter, definir ou desdefinir valores no config.json ficheiro usando azd config comandos. Algumas configurações específicas são usadas por outras azd funcionalidades e comandos, como ao ativar funcionalidades alfa ou definir fontes de templates, mas também pode definir os seus próprios valores personalizados.

Gerir configurações usadas por azd

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

Por exemplo, para ativar as funcionalidades do LLM usadas pela integração do GitHub Copilot:

azd config set alpha.llm on

Note

Selecionar Configurar com o GitHub Copilot (Pré-visualização) durante azd init ativa automaticamente esta definição. Use a sintaxe . para navegar nas estruturas de objetos JSON ao obter e definir valores de configuração.

Verifique se a configuração estava ativada usando o azd config get <key> comando, como segue:

azd config get alpha.llm

Resultado do exemplo:

"on"

Neste cenário, também pode correr azd config get alpha para visualizar o objeto JSON completo no config.json ficheiro:

azd config get alpha

Resultado do exemplo:

{
  "llm": "on"
}

Gerir configurações personalizadas

Também é possível definir valores de configuração personalizados para utilizar nos hooks azd e nos scripts do cliente. Estes valores de configuração oferecem uma alternativa à utilização 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

Resultado do exemplo:

hello-world

Reiniciar configurações

Pode repor o ficheiro CLI config.json do Azure Developer para os seus valores predefinidos usando o azd config reset comando, que apaga o conteúdo do ficheiro:

azd config reset

Quando executas azd config show após um reset, vais simplesmente ver um objeto vazio:

{}

Passos seguintes

Visão geral do desenvolvimento de modelos

  • Última atualização a