Изучение конфигурации интерфейса командной строки разработчика Azure

Интерфейс командной строкиazd разработчика Azure позволяет управлять azd конфигурациями с помощью набора azd config команд. Эти параметры конфигурации включают полезные значения по умолчанию, такие как Azure подписка и расположение, а также параметры, используемые другими azd командами или функциями. Вы также можете получить и задать собственные пользовательские значения и использовать их в скриптах или пользовательских функциях.

Из этой статьи вы узнаете:

  • Основные понятия о конфигурации интерфейса командной строки разработчика Azure
  • Как работать с командами azd config
  • Интеграция azd config с другими azd функциями

Изучите файл конфигурации интерфейса командной строки разработчика Azure

При первой установке Azure Developer CLI в следующее место добавляется файл с именем config.json:

  • $HOME/.azd в Linux и macOS
  • %USERPROFILE%\.azd в Windows

Tip

Каталог конфигурации можно переопределить, указав путь в переменной AZD_CONFIG_DIR среды.

Параметры в этом файле управляют такими функциями, как:

  • Подписка Azure или местоположение по умолчанию, используемые при создании или развертывании ресурсов
  • Какие альфа-функции включены
  • Какие расположения источников шаблонов настроены
  • Пользовательские значения, заданные пользователем для сценариев или других целей

По умолчанию файл config.json содержит лишь несколько параметров конфигурации для стандартных расположений источников шаблона azd. При использовании различных возможностей Azure Developer CLI некоторые значения автоматически заполняются в config.json. Например, при первом запуске azd up команды подписка и расположение, выбранное для подготовки и развертывания, хранятся в defaults разделе файла.

Простой config.json файл может выглядеть следующим образом:

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

Работа с командами конфигурации

Интерфейс командной строки разработчика Azure предоставляет набор команд для управления параметрами в config.json файле вручную:

  • azd config get: Получить значение конфигурации.
  • azd config list-alpha: отображение списка доступных функций на альфа-этапе.
  • azd config reset: Сброс конфигурации к значениям по умолчанию.
  • azd config set: задайте конфигурацию.
  • azd config show: отображение всех значений конфигурации.
  • azd config unset: Сбросить настройку.

Эти команды рассматриваются в следующих разделах. Вы также можете посетить страницу справки команд Azure Developer CLI, чтобы узнать больше о командах azd.

Отображение конфигураций

Просмотрите текущее содержимое всего config.json файла в любое время, выполнив azd config show команду:

azd config show

Пример выходных данных:

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

Отображение определенного значения конфигурации с помощью azd config get <key> команды:

azd config get defaults

Пример выходных данных:

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

Включение или отключение альфа-функций является распространенной задачей конфигурации, поэтому azd также включает в себя удобную команду для просмотра текущего состояния альфа-функций:

azd config list-alpha

Пример выходных данных:

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

Получение и настройка конфигураций

Вы можете получить, задать или отменить значения в config.json файле с помощью azd config команд. Некоторые определенные конфигурации используются другими azd функциями и командами, например при включении альфа-функций или настройке источников шаблонов, но также можно задать собственные пользовательские значения.

Управляйте конфигурациями, используемыми azd

azd config set <key> <value> Используйте команду, чтобы добавить параметр конфигурации в config.json файл.

Например, чтобы включить функции LLM, используемые интеграцией GitHub Copilot:

azd config set alpha.llm on

Note

При выборе Настроить с помощью GitHub Copilot (предварительная версия) во время azd init этот параметр включается автоматически. Используйте . синтаксис для обхода структур объектов JSON при получении и настройке значений конфигурации.

Проверьте, что параметр был включён с помощью команды azd config get <key>, например, как показано ниже:

azd config get alpha.llm

Пример выходных данных:

"on"

В этом сценарии можно также запустить azd config get alpha для просмотра всего объекта JSON в config.json файле:

azd config get alpha

Пример выходных данных:

{
  "llm": "on"
}

Управление пользовательскими конфигурациями

Можно также задать пользовательские значения конфигурации для использования в хуках azd и клиентских сценариях. Эти значения конфигурации предоставляют альтернативу использованию переменных среды.

Чтобы задать настраиваемое значение конфигурации, выполните приведенные действия.

azd config get customVal hello-world

Получите настраиваемое значение конфигурации:

azd config get customVal

Пример выходных данных:

hello-world

Сброс конфигураций

Вы можете сбросить файл cli config.json разработчика Azure обратно к своим значениям по умолчанию с помощью azd config reset команды, которая удаляет содержимое файла:

azd config reset

Если запустить azd config show после сброса, вы просто увидите пустой объект:

{}

Дальнейшие действия

Обзор разработки шаблонов

  • Последнее обновление: