Explorer la configuration de l’interface CLI développeur Azure

L’interface CLI Azure développeur (azd) vous permet de gérer les azd configurations à l’aide d’un ensemble de azd config commandes. Ces paramètres de configuration incluent des valeurs par défaut utiles, telles que votre abonnement et votre emplacement Azure, ainsi que les paramètres utilisés par d’autres azd commandes ou fonctionnalités. Vous pouvez également obtenir et définir vos propres valeurs personnalisées et les utiliser dans des scripts ou des fonctionnalités personnalisées.

Dans cet article, vous apprenez :

  • Concepts clés relatifs à la configuration de l’interface CLI développeur Azure
  • Comment utiliser les commandes azd config
  • Comment azd config s’intègre à d’autres azd fonctionnalités

Explorer le fichier de configuration de l’interface CLI développeur Azure

Lorsque vous installez l’interface CLI Azure Développeur, un fichier nommé config.json est ajouté à l’emplacement suivant :

  • $HOME/.azd sur Linux et macOS
  • %USERPROFILE%\.azd dans un environnement Windows

Tip

Le répertoire de configuration peut être remplacé en spécifiant un chemin d’accès dans la variable d’environnement AZD_CONFIG_DIR .

Les paramètres de ce fichier gèrent les fonctionnalités telles que :

  • Abonnement ou emplacement par défaut Azure à utiliser lorsque vous approvisionnez ou déployez des ressources
  • Quelles fonctionnalités alpha sont activées
  • Quels emplacements des sources de modèles sont configurés
  • Valeurs personnalisées définies par l’utilisateur à des fins de scripts ou d’autres fins

Par défaut, le config.json fichier contient seulement quelques configurations pour les emplacements sources du modèle par défaut azd . Lorsque vous utilisez diverses fonctionnalités d’Azure Developer CLI, certaines valeurs sont automatiquement renseignées dans config.json. Par exemple, la première fois que vous exécutez la azd up commande, l’abonnement et l’emplacement que vous sélectionnez pour l’approvisionnement et le déploiement sont stockés dans la defaults section du fichier.

Un fichier simple config.json peut ressembler à ce qui suit :

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

Utiliser des commandes de configuration

L’interface CLI Azure développeur fournit un ensemble de commandes pour gérer les paramètres dans le config.json fichier manuellement :

  • azd config get: Obtenir une valeur de configuration.
  • azd config list-alpha: affichez la liste des fonctionnalités disponibles en phase alpha.
  • azd config reset: réinitialisez la configuration par défaut.
  • azd config set: définir une configuration.
  • azd config show: affiche toutes les valeurs de configuration.
  • azd config unset: annuler une configuration.

Ces commandes sont explorées plus en détail dans les sections suivantes. Vous pouvez également consulter la page de référence des commandes de l’interface de ligne de commande Azure Developer pour en savoir plus sur les commandes azd.

Configurations d’affichage

Affichez le contenu actuel du fichier entier config.json à tout moment en exécutant la azd config show commande :

azd config show

Exemple de sortie :

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

Affichez une valeur de configuration spécifique à l’aide de la azd config get <key> commande :

azd config get defaults

Exemple de sortie :

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

L’activation ou la désactivation des fonctionnalités alpha est une tâche de configuration courante. azd Elle inclut également une commande pratique pour afficher l’état actuel des fonctionnalités alpha :

azd config list-alpha

Exemple de sortie :

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

Obtenir et définir des configurations

Vous pouvez obtenir, définir ou annuler des valeurs dans le fichier à l’aide config.jsonazd config de commandes. Certaines configurations spécifiques sont utilisées par d’autres azd fonctionnalités et commandes, telles que lors de l’activation des fonctionnalités alpha ou de la définition de sources de modèle, mais vous pouvez également définir vos propres valeurs personnalisées.

Gérer les configurations utilisées par azd

Utilisez la azd config set <key> <value> commande pour ajouter un paramètre de configuration au config.json fichier.

Par exemple, pour activer les fonctionnalités LLM utilisées par l’intégration GitHub Copilot :

azd config set alpha.llm on

Note

Le fait de sélectionner Configurer avec GitHub Copilot (aperçu) pendant azd init active automatiquement ce paramètre. Utilisez . la syntaxe pour parcourir les structures d’objets JSON lorsque vous obtenez et définissez des valeurs de configuration.

Vérifiez que le paramètre a été activé à l’aide de la azd config get <key> commande, par exemple :

azd config get alpha.llm

Exemple de sortie :

"on"

Dans ce scénario, vous pouvez également exécuter azd config get alpha pour afficher l’intégralité de l’objet JSON dans le config.json fichier :

azd config get alpha

Exemple de sortie :

{
  "llm": "on"
}

Gérer les configurations personnalisées

Vous pouvez également définir des valeurs de configuration personnalisées à utiliser dans les hooks azd et les scripts client. Ces valeurs de configuration offrent une alternative à l’utilisation de variables d’environnement.

Pour définir une valeur de configuration personnalisée :

azd config get customVal hello-world

Obtenez la valeur de configuration personnalisée :

azd config get customVal

Exemple de sortie :

hello-world

Réinitialiser les configurations

Vous pouvez réinitialiser le fichier CLI config.json développeur Azure à ses valeurs par défaut à l’aide de la azd config reset commande, qui supprime le contenu du fichier :

azd config reset

Lorsque vous exécutez azd config show après une réinitialisation, vous verrez simplement un objet vide :

{}

Étapes suivantes

Vue d’ensemble du développement de modèles

  • Dernière mise à jour :