Utforska cli-konfigurationen för Azure developer

Med Azure Developer CLI (azd) kan du hantera azd konfigurationer med hjälp av en uppsättning azd config kommandon. De här konfigurationsinställningarna innehåller användbara standardvärden som din Azure prenumeration och plats, samt inställningar som används av andra azd kommandon eller funktioner. Du kan också hämta och ange egna anpassade värden och använda dem i skript eller anpassade funktioner.

I den här artikeln lär du dig:

  • Viktiga begrepp om cli-konfiguration för Azure utvecklare
  • Så här arbetar du med azd config kommandon
  • Så azd config integreras med andra azd funktioner

Utforska cli-konfigurationsfilen Azure Developer

När du först installerar Azure Developer CLI läggs en fil med namnet config.json till på följande plats:

  • $HOME/.azd på Linux och macOS
  • %USERPROFILE%\.azd på Windows

Tip

Konfigurationskatalogen kan åsidosättas genom att ange en sökväg i AZD_CONFIG_DIR miljövariabeln.

Inställningarna i den här filen hanterar funktioner som:

  • Standardprenumerationen eller platsen för Azure som ska användas när du etablerar eller distribuerar resurser
  • Vilka alfafunktioner är aktiverade
  • Vilka källplatser för mallar har konfigurerats
  • Anpassade värden som angetts av användaren för skript eller andra ändamål

Som standard config.json innehåller filen bara några konfigurationer för standardmallens azd källplatser. När du använder olika funktioner i Azure Developer CLI fylls vissa värden i config.json automatiskt. Första gången du till exempel kör azd up kommandot lagras den prenumeration och plats som du väljer för etablering och distribution i avsnittet i defaults filen.

En enkel config.json fil kan likna följande:

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

Arbeta med konfigurationskommandon

AZURE Developer CLI innehåller en uppsättning kommandon för att hantera inställningarna i config.json filen manuellt:

  • azd config get: Hämta ett konfigurationsvärde.
  • azd config list-alpha: Visa listan över tillgängliga funktioner i alfasteget.
  • azd config reset: Återställ konfigurationen till standard.
  • azd config set: Ställ in en konfiguration.
  • azd config show: Visa alla konfigurationsvärden.
  • azd config unset: Ta bort en konfiguration.

Dessa kommandon utforskas mer i följande avsnitt. Du kan också gå till referenssidan för cli-kommandon för Azure Developer för att lära dig mer om azd kommandon.

Konfigurationer för visning

Visa det aktuella innehållet i hela config.json filen när som helst genom att azd config show köra kommandot:

azd config show

Exempel på utdata:

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

Visa ett specifikt konfigurationsvärde azd config get <key> med kommandot :

azd config get defaults

Exempel på utdata:

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

Att aktivera eller inaktivera alfafunktioner är en vanlig konfigurationsuppgift, så azd innehåller även ett bekvämlighetskommando för att visa den aktuella statusen för alfafunktioner:

azd config list-alpha

Exempel på utdata:

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

Hämta och ange konfigurationer

Du kan hämta, ange eller ta bort värden i config.json filen med hjälp av azd config kommandon. Vissa specifika konfigurationer används av andra azd funktioner och kommandon, till exempel när du aktiverar alfafunktioner eller ställer in mallkällor, men du kan också ange egna anpassade värden.

Hantera konfigurationer som används av azd

azd config set <key> <value> Använd kommandot för att lägga till en konfigurationsinställning i config.json filen.

Till exempel för att aktivera de LLM-funktioner som används av GitHub Copilot-integreringen:

azd config set alpha.llm on

Note

Om du väljer Konfigurera med GitHub Copilot (förhandsgranskning) under azd init aktiveras den här inställningen automatiskt. Använd . syntax för att bläddra i JSON-objektstrukturer när du hämtar och anger konfigurationsvärden.

Kontrollera att inställningen har aktiverats med kommandot azd config get <key> , till exempel följande:

azd config get alpha.llm

Exempel på utdata:

"on"

I det här scenariot kan du också köra azd config get alpha för att visa hela JSON-objektet i config.json filen:

azd config get alpha

Exempel på utdata:

{
  "llm": "on"
}

Hantera anpassade konfigurationer

Du kan också ange anpassade konfigurationsvärden som ska användas i azd krokar och kundskript. Dessa konfigurationsvärden är ett alternativ till att använda miljövariabler.

Så här anger du ett anpassat konfigurationsvärde:

azd config get customVal hello-world

Hämta det anpassade konfigurationsvärdet:

azd config get customVal

Exempel på utdata:

hello-world

Återställa konfigurationer

Du kan återställa cli-filen Azure Developer config.json till dess standardvärden med hjälp av azd config reset kommandot som tar bort innehållet i filen:

azd config reset

När du kör azd config show efter en återställning visas helt enkelt ett tomt objekt:

{}

Nästa steg

Översikt över mallutveckling

  • Uppdaterades senast