Изменить

Поделиться через

Настройка параметров приложения для Статические веб-приложения Azure

  • Практическое руководство

Параметры приложения содержат значения конфигурации, которые могут измениться, например строка подключения базы данных. Добавление параметров приложения позволяет изменять входные данные конфигурации в приложении без необходимости изменения кода приложения.

Параметры приложения:

  • Доступны как переменные среды для серверного API статического веб-приложения
  • Можно использовать для хранения секретов, используемых в конфигурации проверки подлинности
  • Шифруются, когда неактивны
  • Копируются в промежуточную и рабочую среды
  • Могут содержать только буквенно-цифровые символы, . и _

Внимание

Параметры приложения, описанные в этой статье, применимы только к API серверной части Статического веб-приложения Azure.

Сведения о настройке переменных среды, необходимых для создания внешнего веб-приложения, см. в разделе "Конфигурация сборки".

Необходимые компоненты

  • Приложение Статических веб-приложений Azure
  • Требуется Azure CLI, если вы используете командную строку

Настройка параметров приложения API для локальной разработки

API в Статические веб-приложения Azure используются Функции Azure, что позволяет определять параметры приложения в файле local.settings.json при локальном запуске приложения. Этот файл определяет параметры приложения в свойстве Values конфигурации.

Примечание.

Файл local.settings.json используется только для локальной разработки. Используйте портал Azure для настройки параметров приложения для рабочей среды.

В следующем примере файла local.settings.json показано, как добавить значение для DATABASE_CONNECTION_STRING.

{
  "IsEncrypted": false,
  "Values": {
    "AzureWebJobsStorage": "",
    "FUNCTIONS_WORKER_RUNTIME": "node",
    "DATABASE_CONNECTION_STRING": "<YOUR_DATABASE_CONNECTION_STRING>"
  }
}

Settings defined in the Values property can be referenced from code as environment variables. In Node.js functions, for example, they're available in the process.env object.

const connectionString = process.env.DATABASE_CONNECTION_STRING;

The local.settings.json file isn't tracked by the GitHub repository because sensitive information, like database connection strings, are often included in the file. Since the local settings remain on your machine, you need to manually configure your settings in Azure.

Generally, configuring your settings is done infrequently, and isn't required with every build.

Настройка параметров приложения

Параметры приложения можно настроить с помощью портал Azure или с помощью Azure CLI.

Использование портала Azure

Портал Azure предоставляет интерфейс для создания, обновления и удаления параметров приложения.

  1. Переход на портал Azure.

  2. Откройте статическое веб-приложение.

  3. Выберите переменные среды на боковой панели.

  4. Выберите среду, в которую требуется создать переменные среды. Вы можете создавать переменные для каждой среды. При создании запроса на вытягивание промежуточные среды создаются автоматически, а затем повышаются в рабочую среду при слиянии запроса на вытягивание.

  5. Нажмите кнопку +Добавить, чтобы добавить новую переменную среды. Снимок экрана: представление переменных среды Статические веб-приложения Azure

  6. Введите имя и значение.

  7. Нажмите ОК.

  8. Выберите Сохранить.

Использование командной строки Azure CLI

az staticwebapp appsettings Используйте команду для обновления параметров в Azure.

В терминале или командной строке выполните следующую команду, чтобы добавить или обновить параметр с именемmessage.Hello world Обязательно замените заполнитель <YOUR_APP_ID> вашим значением.

az staticwebapp appsettings set --name <YOUR_APP_ID> --setting-names "message=Hello world"

Tip

You can add or update multiple settings by passing multiple name-value pairs to --setting-names.

View application settings with the Azure CLI

In a terminal or command line, execute the following command. Make sure to replace the placeholder <YOUR_APP_ID> with your value.

az staticwebapp appsettings list --name <YOUR_APP_ID>

Delete application settings with the Azure CLI

In a terminal or command line, execute the following command to delete a setting named message. Make sure to replace the placeholder <YOUR_APP_ID> with your value.

az staticwebapp appsettings delete --name <YOUR_APP_ID> --setting-names "message"

Tip

Delete multiple settings by passing multiple setting names to --setting-names.

Связанный контент