Explorar la configuración de la CLI para desarrolladores de Azure

La CLI de Azure Developer (azd) permite administrar azd configuraciones mediante un conjunto de azd config comandos. Estas opciones de configuración incluyen valores predeterminados útiles, como la suscripción y la ubicación de la Azure, así como la configuración que usan otros azd comandos o características. También puede obtener y establecer sus propios valores personalizados y usarlos en scripts o funcionalidad personalizada.

En este artículo, aprenderá lo siguiente:

  • Conceptos clave sobre la configuración de la CLI para desarrolladores de Azure
  • Cómo trabajar con azd config comandos
  • Cómo azd config se integra con otras azd funciones

Exploración del archivo de configuración de la CLI para desarrolladores de Azure

Al instalar por primera vez la CLI de Azure Developer, se agrega un archivo denominado config.json en la siguiente ubicación:

  • $HOME/.azd en Linux y macOS
  • %USERPROFILE%\.azd en Windows

Tip

El directorio de configuración se puede anular especificando una ruta en la variable de entorno AZD_CONFIG_DIR.

Los ajustes de este archivo gestionan funcionalidades como las siguientes:

  • La suscripción de Azure o la ubicación predeterminadas que se usarán al aprovisionar o implementar recursos
  • Qué características alfa están habilitadas
  • Qué ubicaciones de origen de las plantillas están configuradas
  • Valores personalizados establecidos por el usuario para scripts u otros fines

De forma predeterminada, el config.json archivo contiene solo algunas configuraciones para las ubicaciones de origen de plantilla predeterminadas azd . A medida que usa varias características de la CLI de Azure Developer, algunos valores se rellenan automáticamenteconfig.json. Por ejemplo, la primera vez que ejecute el azd up comando, la suscripción y la ubicación que seleccione para el aprovisionamiento y la implementación se almacenan en la defaults sección del archivo.

Un archivo simple config.json podría ser similar al siguiente:

{
  "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"
      }
    }
  }
}

Trabajar con comandos de configuración

La CLI de Azure Developer proporciona un conjunto de comandos para administrar la configuración en el config.json archivo manualmente:

  • azd config get: Obtiene un valor de configuración.
  • azd config list-alpha: muestra la lista de características disponibles en la fase alfa.
  • azd config reset: restablezca la configuración al valor predeterminado.
  • azd config set: Establezca una configuración.
  • azd config show: muestra todos los valores de configuración.
  • azd config unset: Elimine una configuración.

Estos comandos se exploran más en las secciones siguientes. También puede visitar la página de referencia de comandos de la CLI para desarrolladores de Azure para obtener más información sobre azd los comandos.

Configuraciones de visualización

Para ver el contenido actual del archivo completo config.json en cualquier momento, ejecute el azd config show comando :

azd config show

Resultados del ejemplo:

{
  "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"
      }
    }
  }
}

Muestra un valor de configuración específico mediante el azd config get <key> comando :

azd config get defaults

Resultados del ejemplo:

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

Habilitar o deshabilitar características alfa es una tarea de configuración común, por lo que azd también incluye un comando cómodo para ver el estado actual de las características alfa:

azd config list-alpha

Resultados del ejemplo:

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

Obtener y establecer configuraciones

Puede obtener, establecer o anular valores en el config.json archivo mediante azd config comandos. Algunas configuraciones específicas las usan otras azd funciones y comandos, por ejemplo al habilitar funciones alfa o configurar los orígenes de las plantillas, pero también puedes establecer tus propios valores personalizados.

Administrar configuraciones usadas por azd

Use el azd config set <key> <value> comando para agregar una configuración al config.json archivo.

Por ejemplo, para habilitar las características de LLM usadas por la integración de GitHub Copilot:

azd config set alpha.llm on

Nota:

Seleccionar Configurar con GitHub Copilot (versión preliminar) durante azd init activa esta configuración automáticamente. Use la sintaxis . para recorrer estructuras de objetos JSON al obtener y definir valores de configuración.

Compruebe que la configuración se ha habilitado mediante el azd config get <key> comando , como el siguiente:

azd config get alpha.llm

Resultados del ejemplo:

"on"

En este escenario, también puede ejecutar azd config get alpha para ver todo el objeto JSON en el config.json archivo:

azd config get alpha

Resultados del ejemplo:

{
  "llm": "on"
}

Administración de configuraciones personalizadas

También puede establecer valores de configuración personalizados para usarlos en azd enlaces y scripts de cliente. Estos valores de configuración proporcionan una alternativa al uso de variables de entorno.

Para establecer un valor de configuración personalizado:

azd config get customVal hello-world

Obtenga el valor de configuración personalizado:

azd config get customVal

Resultados del ejemplo:

hello-world

Restablecer configuraciones

Puede restablecer el archivo de la CLI config.json para desarrolladores de Azure a sus valores predeterminados mediante el azd config reset comando , que elimina el contenido del archivo:

azd config reset

Cuando se ejecuta azd config show después de un restablecimiento, simplemente verá un objeto vacío:

{}

Pasos siguientes

Información general sobre el desarrollo de plantillas

  • Se actualizó por última vez el