Erkunden Azure Entwickler-CLI-Konfiguration

Mit der Azure Developer CLI (azd) können Sie Konfigurationen mithilfe einer Reihe von azd config Befehlen verwaltenazd. Diese Konfigurationseinstellungen umfassen nützliche Standardwerte wie Ihr Azure Abonnement und Standort sowie Einstellungen, die von anderen azd Befehlen oder Features verwendet werden. Sie können auch eigene benutzerdefinierte Werte abrufen und festlegen und in Skripts oder benutzerdefinierten Funktionen verwenden.

In diesem Artikel erfahren Sie:

  • Wichtige Konzepte zur Konfiguration der Azure Developer CLI
  • So arbeiten Sie mit azd config Befehlen
  • Wie sich azd config in andere azd Funktionen integriert

Erkunden der Konfigurationsdatei Azure Developer CLI

Wenn Sie die Azure Developer CLI zum ersten Mal installieren, wird am folgenden Speicherort eine Datei mit dem Namen config.json hinzugefügt:

  • $HOME/.azd unter Linux und macOS
  • %USERPROFILE%\.azd unter Windows

Tip

Das Konfigurationsverzeichnis kann überschrieben werden, indem ein Pfad in der AZD_CONFIG_DIR Umgebungsvariable angegeben wird.

Die Einstellungen in dieser Datei verwalten Funktionen wie:

  • Das Azure-Standardabonnement oder der Azure-Standort, der bzw. die beim Erstellen oder Bereitstellen von Ressourcen verwendet wird
  • Welche Alphafeatures aktiviert sind
  • Welche Quellspeicherorte für Vorlagen sind konfiguriert?
  • Benutzerdefinierte Werte, die vom Benutzer für Skripts oder andere Zwecke festgelegt werden

Standardmäßig enthält die config.json Datei nur einige Konfigurationen für die Standardspeicherorte azd der Vorlagen. Bei der Verwendung verschiedener Funktionen der Azure Developer CLI werden einige Werte automatisch in config.json eingetragen. Wenn Sie beispielsweise den Befehl azd up zum ersten Mal ausführen, werden das Abonnement und der Standort, die Sie für die Provisionierung und Bereitstellung auswählen, im Abschnitt defaults der Datei gespeichert.

Eine einfache config.json Datei könnte wie folgt aussehen:

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

Arbeiten mit Konfigurationsbefehlen

Die Azure Developer CLI bietet eine Reihe von Befehlen zum manuellen Verwalten der Einstellungen in der config.json Datei:

  • azd config get: Dient zum Abrufen eines Konfigurationswerts.
  • azd config list-alpha: Zeigt die Liste der verfügbaren Features in alpha-Stufe an.
  • azd config reset: Konfiguration auf Standard zurücksetzen.
  • azd config set: Legen Sie eine Konfiguration fest.
  • azd config show: Zeigt alle Konfigurationswerte an.
  • azd config unset: Aufheben einer Konfiguration.

Diese Befehle werden in den folgenden Abschnitten näher erläutert. Sie können auch die Referenzseite der Azure Developer CLI-Befehle besuchen, um mehr über azd Befehle zu erfahren.

Displaykonfigurationen

Zeigen Sie den aktuellen Inhalt der gesamten config.json Datei jederzeit an, indem Sie den azd config show Befehl ausführen:

azd config show

Beispielausgabe:

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

Anzeigen eines bestimmten Konfigurationswerts mithilfe des azd config get <key> Befehls:

azd config get defaults

Beispielausgabe:

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

Das Aktivieren oder Deaktivieren von Alphafeatures ist eine häufige Konfigurationsaufgabe. Außerdem ist ein Benutzerfreundlichkeitsbefehl enthalten, azd um den aktuellen Status von Alphafeatures anzuzeigen:

azd config list-alpha

Beispielausgabe:

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

Abrufen und Festlegen von Konfigurationen

Sie können Werte in der config.json Datei mithilfe von azd config Befehlen abrufen, festlegen oder aufheben. Einige bestimmte Konfigurationen werden von anderen azd Features und Befehlen verwendet, z. B. beim Aktivieren von Alphafeatures oder Festlegen von Vorlagenquellen, aber Sie können auch eigene benutzerdefinierte Werte festlegen.

Von azd verwendete Konfigurationen verwalten

Verwenden Sie den azd config set <key> <value> Befehl, um der config.json Datei eine Konfigurationseinstellung hinzuzufügen.

So aktivieren Sie beispielsweise die LLM-Features, die von der GitHub Copilot Integration verwendet werden:

azd config set alpha.llm on

Note

Wenn Sie "Mit GitHub-Copilot (Vorschau) einrichten" auswählenazd init, wird diese Einstellung automatisch aktiviert. Verwenden Sie . die Syntax, um JSON-Objektstrukturen zu durchlaufen, wenn Sie Konfigurationswerte abrufen und festlegen.

Überprüfen Sie, ob die Einstellung mithilfe des azd config get <key> Befehls aktiviert wurde, z. B. folgendes:

azd config get alpha.llm

Beispielausgabe:

"on"

In diesem Szenario können Sie auch ausführen azd config get alpha , um das gesamte JSON-Objekt in der config.json Datei anzuzeigen:

azd config get alpha

Beispielausgabe:

{
  "llm": "on"
}

Verwalten von benutzerdefinierten Konfigurationen

Sie können auch benutzerdefinierte Konfigurationswerte festlegen, die in azd Hooks und Kundenskripts verwendet werden sollen. Diese Konfigurationswerte stellen eine Alternative zur Verwendung von Umgebungsvariablen bereit.

So legen Sie einen benutzerdefinierten Konfigurationswert fest:

azd config get customVal hello-world

Rufen Sie den benutzerdefinierten Konfigurationswert ab:

azd config get customVal

Beispielausgabe:

hello-world

Zurücksetzen von Konfigurationen

Sie können die Azure Developer CLI-Datei config.json mithilfe des azd config reset Befehls zurück auf die Standardwerte zurücksetzen, wodurch der Inhalt der Datei gelöscht wird:

azd config reset

Wenn Sie azd config show nach einem Zurücksetzen ausführen, sehen Sie einfach ein leeres Objekt:

{}

Nächste Schritte

Übersicht über die Vorlagenentwicklung

  • Zuletzt aktualisiert um