Eksplorowanie konfiguracji interfejsu wiersza polecenia dla deweloperów platformy Azure

Interfejs wiersza polecenia dla deweloperów platformy Azure (azd) umożliwia zarządzanie konfiguracjami azd przy użyciu zestawu poleceń azd config. Te ustawienia konfiguracji obejmują przydatne wartości domyślne, takie jak subskrypcja i lokalizacja platformy Azure, a także ustawienia używane przez inne polecenia lub funkcje azd. Możesz również pobierać i ustawiać własne wartości niestandardowe i używać ich w skryptach lub funkcjach niestandardowych.

Z tego artykułu dowiesz się:

  • Kluczowe pojęcia dotyczące konfiguracji interfejsu wiersza polecenia dla deweloperów platformy Azure
  • Jak pracować z poleceniami azd config
  • Jak azd config integruje się z innymi funkcjami azd

Eksplorowanie pliku konfiguracji interfejsu wiersza polecenia dla deweloperów platformy Azure

Podczas pierwszej instalacji interfejsu wiersza polecenia dla deweloperów platformy Azure plik o nazwie config.json jest dodawany w następującej lokalizacji:

  • $HOME/.azd w systemach Linux i macOS
  • %USERPROFILE%\.azd w systemie Windows

Napiwek

Katalog konfiguracji można zastąpić, określając ścieżkę w zmiennej środowiskowej AZD_CONFIG_DIR.

Ustawienia w tym pliku zarządzają funkcjami, takimi jak:

  • Domyślna subskrypcja lub lokalizacja platformy Azure używana podczas aprowizowania lub wdrażania zasobów
  • Które funkcje alfa są włączone
  • Które lokalizacje źródłowe szablonu są skonfigurowane
  • Wartości niestandardowe ustawiane przez użytkownika na potrzeby skryptów lub innych celów

Domyślnie plik config.json zawiera tylko kilka konfiguracji domyślnych lokalizacji źródłowych szablonu azd. W miarę korzystania z różnych funkcji Azure Developer CLI, niektóre wartości są automatycznie wprowadzane w config.json. Na przykład przy pierwszym uruchomieniu polecenia azd up subskrypcja i lokalizacja wybrana do aprowizacji i wdrażania są przechowywane w sekcji defaults pliku.

Prosty plik config.json może wyglądać podobnie do następującego:

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

Praca z poleceniami konfiguracji

Interfejs wiersza polecenia dla deweloperów platformy Azure udostępnia zestaw poleceń umożliwiających ręczne zarządzanie ustawieniami w pliku config.json:

  • azd config get: pobierz wartość konfiguracji.
  • azd config list-alpha: wyświetl listę dostępnych funkcji na etapie alfa.
  • azd config reset: zresetuj konfigurację domyślnie.
  • azd config set: Skonfiguruj ustawienia.
  • azd config show: Pokaż wszystkie wartości konfiguracji.
  • azd config unset: cofnij ustawienie konfiguracji.

Te polecenia są bardziej szczegółowo opisane w poniższych sekcjach. Możesz również odwiedzić stronę referencyjną poleceń CLI dla deweloperów platformy Azure, aby dowiedzieć się więcej na temat azd poleceń.

Konfiguracje wyświetlania

Wyświetl bieżącą zawartość całego pliku config.json w dowolnym momencie, uruchamiając polecenie azd config show:

azd config show

Przykładowe dane wyjściowe:

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

Wyświetl określoną wartość konfiguracji przy użyciu polecenia azd config get <key>:

azd config get defaults

Przykładowe dane wyjściowe:

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

Włączanie lub wyłączanie funkcji alfa jest typowym zadaniem konfiguracji, dlatego azd zawiera również wygodne polecenie umożliwiające wyświetlenie bieżącego stanu funkcji alfa:

azd config list-alpha

Przykładowe dane wyjściowe:

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

Pobieranie i ustawianie konfiguracji

Wartości w pliku config.json można pobierać, ustawiać lub nie ustawiać przy użyciu poleceń azd config. Niektóre konkretne konfiguracje są używane przez inne funkcje i polecenia azd, na przykład przy włączaniu funkcji alfa lub ustawianiu źródeł szablonów, ale można również ustawić własne, niestandardowe wartości.

Zarządzanie konfiguracjami używanymi przez azd

Użyj polecenia azd config set <key> <value>, aby dodać ustawienie konfiguracji do pliku config.json.

Aby na przykład włączyć funkcje LLM używane przez integrację GitHub Copilot:

azd config set alpha.llm on

Uwaga

Wybranie pozycji Skonfiguruj za pomocą usługi GitHub Copilot (wersja zapoznawcza) podczas azd init spowoduje automatyczne włączenie tego ustawienia. Użyj składni ., aby poruszać się po strukturach obiektów JSON podczas pobierania i ustawiania wartości konfiguracyjnych.

Sprawdź, czy ustawienie zostało włączone przy użyciu polecenia azd config get <key>, na przykład następującego:

azd config get alpha.llm

Przykładowe dane wyjściowe:

"on"

W tym scenariuszu można również uruchomić azd config get alpha, aby wyświetlić cały obiekt JSON w pliku config.json:

azd config get alpha

Przykładowe dane wyjściowe:

{
  "llm": "on"
}

Zarządzanie konfiguracjami niestandardowymi

Można również ustawić niestandardowe wartości konfiguracji do użycia w hookach azd i skryptach klienckich. Te wartości konfiguracji stanowią alternatywę dla używania zmiennych środowiskowych.

Aby ustawić niestandardową wartość konfiguracji:

azd config get customVal hello-world

Pobierz wartość konfiguracji niestandardowej:

azd config get customVal

Przykładowe dane wyjściowe:

hello-world

Resetowanie konfiguracji

Możesz zresetować plik config.json interfejsu wiersza polecenia dewelopera platformy Azure z powrotem do jego wartości domyślnych przy użyciu polecenia azd config reset, które usuwa zawartość pliku:

azd config reset

Po uruchomieniu azd config show po zresetowaniu zobaczysz po prostu pusty obiekt:

{}

Następne kroki

Omówienie tworzenia szablonów

  • Last updated on