Prozkoumání konfigurace rozhraní příkazového řádku pro vývojáře Azure

Azure Developer CLI (azd) umožňuje spravovat konfigurace azd pomocí sady příkazů azd config. Tato nastavení konfigurace zahrnují užitečné výchozí hodnoty, jako jsou vaše Azure předplatné a umístění, a také nastavení používaná jinými azd příkazy nebo funkcemi. Můžete také získat a nastavit vlastní hodnoty a použít je ve skriptech nebo vlastních funkcích.

V tomto článku se dozvíte:

  • Klíčové koncepty konfigurace rozhraní příkazového řádku pro vývojáře Azure
  • Jak pracovat s azd config příkazy
  • Integrace azd config s dalšími azd funkcemi

Prozkoumejte konfigurační soubor Azure Developer CLI

Při první instalaci rozhraní příkazového řádku pro vývojáře Azure se do následujícího umístění přidá soubor s názvemconfig.json:

  • $HOME/.azd v Linuxu a macOS
  • %USERPROFILE%\.azd ve Windows

Tip

Konfigurační adresář lze přepsat zadáním cesty v AZD_CONFIG_DIR proměnné prostředí.

Nastavení v tomto souboru spravují funkce, jako jsou:

  • Výchozí Azure předplatné nebo umístění, které se má použít při zřizování nebo nasazování prostředků
  • Které alfa funkce jsou povolené
  • Která umístění zdrojů šablon jsou nakonfigurována
  • Vlastní hodnoty nastavené uživatelem pro skripty nebo jiné účely

Soubor config.json ve výchozím nastavení obsahuje pouze několik konfigurací pro výchozí umístění zdrojů šablon azd. Při používání různých funkcí Azure Developer CLI se některé hodnoty v config.json vyplní automaticky. Například při prvním spuštění příkazu azd up se předplatné a umístění, které vyberete pro zřizování a nasazení, uloží do sekce defaults souboru.

Jednoduchý config.json soubor může vypadat přibližně takto:

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

Práce s příkazy konfigurace

Rozhraní příkazového řádku pro vývojáře Azure poskytuje sadu příkazů pro správu nastavení v config.json souboru ručně:

  • azd config get: Získejte hodnotu konfigurace.
  • azd config list-alpha: Zobrazí seznam dostupných funkcí ve fázi alfa.
  • azd config reset: Resetujte konfiguraci na výchozí.
  • azd config set: Nastavte konfiguraci.
  • azd config show: Zobrazí všechny hodnoty konfigurace.
  • azd config unset: Zrušení nastavení konfigurace

Tyto příkazy jsou podrobněji prozkoumány v následujících částech. Další informace o azd příkazech najdete také na stránce s referenčními informacemi k příkazům rozhraní příkazového řádku pro vývojáře Azure.

Zobrazení konfigurací

Spuštěním azd config show příkazu můžete kdykoli zobrazit aktuální obsah celého config.json souboru:

azd config show

Ukázkový výstup:

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

Zobrazte konkrétní hodnotu konfigurace pomocí příkazu azd config get <key>:

azd config get defaults

Ukázkový výstup:

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

Povolení nebo zakázání alfa funkcí je běžnou úlohou konfigurace, takže azd zahrnuje také příkaz pro usnadnění zobrazení aktuálního stavu alfa funkcí:

azd config list-alpha

Ukázkový výstup:

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

Získat a nastavit konfigurace

Hodnoty v config.json souboru můžete získat, nastavit nebo zrušit pomocí azd config příkazů. Některé konkrétní konfigurace používají jiné azd funkce a příkazy, například při povolování alfa funkcí nebo nastavení zdrojů šablon, ale můžete také nastavit vlastní hodnoty.

Správa konfigurací používaných službou azd

Pomocí příkazu azd config set <key> <value> přidejte do souboru config.json nastavení konfigurace.

Pokud chcete například povolit funkce LLM používané integrací GitHub Copilot:

azd config set alpha.llm on

Note

Výběrem možnosti Nastavit pomocí GitHub Copilot (Preview) během azd init se toto nastavení automaticky povolí. Pomocí syntaxe . můžete procházet struktury objektů JSON při získávání a nastavování konfiguračních hodnot.

Ověřte, že bylo nastavení povoleno pomocí příkazu azd config get <key>, například následovně:

azd config get alpha.llm

Ukázkový výstup:

"on"

V tomto scénáři můžete také spustit azd config get alpha, abyste zobrazili celý objekt JSON v souboru config.json:

azd config get alpha

Ukázkový výstup:

{
  "llm": "on"
}

Správa vlastních konfigurací

Můžete také nastavit vlastní konfigurační hodnoty tak, aby se používaly v azd hácích a skriptech zákazníků. Tyto hodnoty konfigurace poskytují alternativu k používání proměnných prostředí.

Nastavení vlastní hodnoty konfigurace:

azd config get customVal hello-world

Získejte hodnotu vlastní konfigurace:

azd config get customVal

Ukázkový výstup:

hello-world

Resetování konfigurací

Soubor rozhraní příkazového řádku pro config.json vývojáře Azure můžete obnovit zpět na výchozí hodnoty pomocí azd config reset příkazu, který odstraní obsah souboru:

azd config reset

Když po resetování spustíte azd config show , jednoduše se zobrazí prázdný objekt:

{}

Další kroky