Настройка приложения Службы приложений

В этой статье объясняется, как настроить общие параметры для веб-приложений, серверной части для мобильных устройств или приложения API. Если вы используете Функции Azure, см. статью Справочник по параметрам приложений для Функций Azure.

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

В Службе приложений параметры приложения являются переменными, передаваемыми как переменные среды в код приложения. Для приложений и настраиваемых контейнеров Linux Служба приложений передает параметры приложения в контейнер с помощью флага --env, чтобы задать переменную среды в контейнере. В обоих случаях они внедряются в среду приложения при запуске приложения. При добавлении, удалении или изменении параметров приложения Служба приложений перезапускает приложение.

Для разработчиков ASP.NET и ASP.NET Core настройка параметров приложения в Службе приложений выполняется так же, как и настройка их в <appSettings> в Web.config или appsettings.json, но значения в Службе приложений переопределяют значения в Web.config или appsettings.json. Вы можете безопасно сохранить параметры разработки (например, локальный пароль MySQL) в Web.config или appsettings.json, а производственные секреты (например, пароль базы данных MySQL Azure) — в Службе приложений. Один и тот же код использует параметры разработки при локальной отладке, а производственные секреты — при развертывании в Azure.

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

• ASP.NET Core
• Node.js
• PHP
• Python
• Java
• Ruby
• Пользовательские контейнеры

Параметры приложения всегда шифруются при хранении.

Примечание

Параметры приложения можно также разрешить из Key Vault с помощью ссылок на Key Vault.

Портал Azure

1. На Портал Azure найдите и выберите Службы приложений, а затем выберите приложение.

   

2. В меню приложения слева выберите Конфигурация>Параметры приложения.

   

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

3. Чтобы добавить новый параметр приложения, нажмите Создать параметр приложения. Чтобы изменить параметр, нажмите кнопку Правка справа.

4. В диалоговом окне можно прикрепить параметр к текущему слоту.

   Имена параметров приложения не могут содержать точки (.). Если параметр приложения содержит точку, в контейнере точка заменяется символом подчеркивания.

   Примечание

   В службе приложений Linux по умолчанию или в настраиваемом контейнере Linux любая вложенная структура ключей JSON в имени параметра приложения, например ApplicationInsights:InstrumentationKey, должна указываться в службе приложений для имени ключа как ApplicationInsights__InstrumentationKey. Другими словами, символы : следует заменять на __ (двойное подчеркивание).

5. Завершив изменение, нажмите Обновить. Не забудьте снова нажать кнопку Сохранить на странице Конфигурация.

Azure CLI

Добавьте или измените параметр приложения с помощью команды az webapp config app settings set:

az webapp config appsettings set --name <app-name> --resource-group <group-name> --settings <setting-name>="<value>"

Замените <setting-name> на имя параметра, а <value> — на значение для этого параметра.

Отобразите все параметры и их значения с помощью команды az webapp config appsettings list.

az webapp config appsettings list --name <app-name> --resource-group <group-name>

Удалите один параметр или несколько с помощью команды az webapp config app settings delete.

az webapp config appsettings delete --name <app-name> --resource-group <group-name> --setting-names {<setting-name1>,<setting-name2>,...}

Azure PowerShell

Задайте одно или несколько параметров приложения с помощью Set-AzWebApp:

Set-AzWebApp -ResourceGroupName <group-name> -Name <app-name> -AppSettings @{"<setting-name1>"="<value1>"; "<setting-name2>"="<value2>";...}

Этот командлет заменяет весь набор параметров приложения на указанные вами. Чтобы добавить или изменить параметр приложения в существующем наборе, включите существующие параметры приложения во входную хэш-таблицу с помощью командлета Get-AzWebApp. Пример:

# Get app configuration
$webapp=Get-AzWebApp -ResourceGroupName <group-name> -Name <app-name>

# Copy app settings to a new Hashtable
$appSettings = @{}
ForEach ($item in $webapp.SiteConfig.AppSettings) {
$appSettings[$item.Name] = $item.Value
}

# Add or edit one or more app settings
$appSettings['<setting-name1>'] = '<value1>'
$appSettings['<setting-name2>'] = '<value2>'

# Save changes
Set-AzWebApp -ResourceGroupName <group-name> -Name <app-name> -AppSettings $appSettings

Чтобы проверить, зависит ли параметр приложения от слота, используйте команду Get-AzWebAppSlotConfigName:

Get-AzWebAppSlotConfigName -ResourceGroupName <group-name> -Name <app-name> | select AppSettingNames

Чтобы сделать один или несколько параметров приложения зависимыми от слота, используйте команду Set-AzWebAppSlotConfigName:

Set-AzWebAppSlotConfigName -ResourceGroupName <group-name> -Name <app-name> -AppSettingNames <setting-name1>,<setting-name2>,...

Групповое изменение параметров приложения

Портал Azure

Нажмите кнопку Расширенное редактирование. Измените параметры в текстовой области. Завершив изменение, нажмите Обновить. Не забудьте снова нажать кнопку Сохранить на странице Конфигурация.

Параметры приложения задаются в следующем формате JSON.

[
  {
    "name": "<key-1>",
    "value": "<value-1>",
    "slotSetting": false
  },
  {
    "name": "<key-2>",
    "value": "<value-2>",
    "slotSetting": false
  },
  ...
]

Azure CLI

Выполните команду az webapp config app settings set с указанием имени файла JSON.

az webapp config appsettings set --resource-group <group-name> --name <app-name> --settings "@fileName.json"

Совет

Заключение имени файла в кавычки требуется только в PowerShell.

Необходимый формат файла — это массив параметров JSON, в котором поле параметра слота является необязательным. Пример:

[
  {
    "name": "key1",
    "slotSetting": false,
    "value": "value1"
  },
  {
    "name": "key2",
    "value": "value2"
  }
]

Для удобства можно сохранить существующие параметры в JSON-файл, выполнив команду az webapp config appsettings list. Следующий пример можно выполнить в Bash.

# Save the settings
az webapp config appsettings list --name <app-name> --resource-group <group-name> > settings.json

# Edit the JSON file
...

# Update the app with the JSON file
az webapp config appsettings set --resource-group <group-name> --name <app-name> --settings @settings.json

Azure PowerShell

Невозможно выполнить групповое изменение параметров приложения с помощью JSON-файла и Azure PowerShell.

Настройка строк подключения

На Портал Azure найдите и выберите Службы приложений, а затем выберите приложение. В меню приложения слева выберите Конфигурация>Параметры приложения.

Для разработчиков ASP.NET и ASP.NET Core установка строк подключения в Службе приложений выполняется так же, как и установка их в <connectionStrings> в Web.config, но значения, заданные в Службе приложений, переопределяют значения в Web.config. Вы можете безопасно сохранить параметры разработки (например, файл базы данных) в Web.config, а производственные секреты (например, учетные данные базы данных SQL) — в Службе приложений. Один и тот же код использует параметры разработки при локальной отладке, а производственные секреты — при развертывании в Azure.

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

Примечание

Единственный случай, когда вместо параметров приложения для языков, не относящихся к группе .NET, может быть предпочтительнее использовать строки подключения: некоторые типы Базы данных Azure архивируются вместе с приложением, только если вы настроили строку подключения для базы данных в своем приложении Службы приложений. Дополнительные сведения см. в разделе Создание пользовательской резервной копии. Если вам не нужно автоматическое резервное копирование, используйте параметры приложения.

Во время выполнения строки подключения доступны в виде переменных среды с соответствующими префиксами для каждого типа соединения.

• SQLServer: SQLCONNSTR_
• MySQL: MYSQLCONNSTR_
• SQLAzure: SQLAZURECONNSTR_
• Пользовательская: CUSTOMCONNSTR_
• PostgreSQL: POSTGRESQLCONNSTR_

Например, к строке подключения MySQL с именем connectionstring1 можно обращаться как к переменной среды MYSQLCONNSTR_connectionString1. Инструкции для конкретных стеков языка см. в следующих разделах.

• ASP.NET Core
• Node.js
• PHP
• Python
• Java
• Ruby
• Пользовательские контейнеры

Строки подключения всегда шифруются при хранении.

Примечание

Строки подключения также можно разрешить из Key Vault с помощью ссылок на Key Vault.

Портал Azure

1. На Портал Azure найдите и выберите Службы приложений, а затем выберите приложение.

   

2. В меню приложения слева выберите Конфигурация>Параметры приложения.

   

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

3. Чтобы добавить новую строку подключения, нажмите Создать строку подключения. Чтобы изменить строку подключения, нажмите кнопку Правка справа.

4. В диалоговом окне можно прикрепить строку подключения к текущему слоту.

5. Завершив изменение, нажмите Обновить. Не забудьте снова нажать кнопку Сохранить на странице Конфигурация.

Azure CLI

Добавьте или измените параметр приложения с помощью команды az webapp config connection-string set:

az webapp config connection-string set --name <app-name> --resource-group <group-name> --connection-string-type <type> --settings <string-name>='<value>'

Замените <string-name> на имя строки подключения, а <value> — на значение для нее. Возможные значения <type> (например, SQLAzure) см. в документации по командам CLI.

Для просмотра всех строк подключения и их значений воспользуйтесь командой az webapp config connection-string list:

az webapp config connection-string list --name <app-name> --resource-group <group-name>

Удалите одну или несколько строк подключения с помощью команды az webapp config connection-string delete:

az webapp config connection-string delete --name <app-name> --resource-group <group-name> --setting-names {<string-name1>,<string-name2>,...}

Azure PowerShell

Задайте одну или несколько строк подключения с помощью Set-AzWebApp:

$PropertiesObject = @{
  "<string-name1>" = @{
    value="<connection-string1>";
    type="<type>"};
  "<string-name2>" = @{
    value="<connection-string2>";
    type="<type>"}
}

Set-AzWebApp -ResourceGroupName <group-name> -Name <app-name> -ConnectionStrings $PropertiesObject

Каждая строка подключения содержит имя (<string-name1>), значение (<connection-string1>) и тип, который представляет собой числовое значение, соответствующее одному из полей перечисления ConnectionStringType. Например, для SQL Azure укажите type="2".

Этот командлет заменяет целый набор строк подключения на указанные вами. Чтобы добавить или изменить параметр приложения в существующем наборе, включите существующие параметры приложения во входную хэш-таблицу с помощью командлета Get-AzWebApp. Пример:

# Get app configuration
$webapp=Get-AzWebApp -ResourceGroupName <group-name> -Name <app-name>

# Copy connection strings to a new hashtable
$connStrings = @{}
ForEach ($item in $webapp.SiteConfig.ConnectionStrings) {
$connStrings[$item.Name] = @{value=$item.Value; type=item.Type}
}

# Add or edit one or more connection strings
$connStrings['<string-name1>'] = @{value='<connection-string1>', type='<type>'}
$connStrings['<string-name2>'] = @{value='<connection-string2>', type='<type>'}

# Save changes
Set-AzWebApp -ResourceGroupName <group-name> -Name <app-name> -ConnectionStrings $connStrings

Чтобы проверить, зависит ли строка подключения от слота, используйте команду Get-AzWebAppSlotConfigName:

Get-AzWebAppSlotConfigName -ResourceGroupName <group-name> -Name <app-name> | select ConnectionStringNames

Чтобы сделать одну или несколько строк подключения зависимыми от слота, используйте команду Set-AzWebAppSlotConfigName:

Set-AzWebAppSlotConfigName -ResourceGroupName <group-name> -Name <app-name> -ConnectionStringNames <string-name1>,<string-name2>,...

Групповое изменение строк подключения

Портал Azure

Нажмите кнопку Расширенное редактирование. Измените строки подключения в текстовой области. Завершив изменение, нажмите Обновить. Не забудьте снова нажать кнопку Сохранить на странице Конфигурация.

Строки подключения задаются в следующем формате JSON.

[
  {
    "name": "name-1",
    "value": "conn-string-1",
    "type": "SQLServer",
    "slotSetting": false
  },
  {
    "name": "name-2",
    "value": "conn-string-2",
    "type": "PostgreSQL",
    "slotSetting": false
  },
  ...
]

Azure CLI

Выполните команду az webapp config connection-string set с указанием имени JSON-файла.

az webapp config connection-string set --resource-group <group-name> --name <app-name> --settings "@fileName.json"

Совет

Заключение имени файла в кавычки требуется только в PowerShell.

Необходимый формат файла — это массив строк подключения JSON, в котором поле параметра слота является необязательным. Пример:

[
  {
    "name": "name-1",
    "value": "conn-string-1",
    "type": "SQLServer",
    "slotSetting": false
  },
  {
    "name": "name-2",
    "value": "conn-string-2",
    "type": "PostgreSQL",
  },
  ...
]

Для удобства можно сохранить существующие строки подключения в файл JSON с помощью команды az webapp config connection-string list. Следующий пример можно выполнить в Bash.

# Save the connection strings
az webapp config connection-string list --resource-group <group-name> --name <app-name> > settings.json

# Edit the JSON file
...

# Update the app with the JSON file
az webapp config appsettings set --resource-group <group-name> --name <app-name> --settings @settings.json

Azure PowerShell

Невозможно выполнить групповое изменение строк подключения с помощью JSON-файла и Azure PowerShell.

Настройка параметров языкового стека

• ASP.NET Core
• Node.js
• PHP
• Python
• Java
• Ruby

Настройка общих параметров

Портал Azure

На Портал Azure найдите и выберите Службы приложений, а затем выберите приложение. В меню приложения слева выберите Конфигурация>Общие параметры.

Здесь можно настроить некоторые общие параметры для приложения. Для некоторых параметров необходимо выполнить масштабирование до более высокой ценовой категории.

• Параметры стека: программный стек для запуска приложения, включая версии языка и пакета SDK.

  Для приложений Linux можно выбрать версию языковой среды выполнения и задать необязательную команду запуска или файл команд запуска.

  

• Параметры платформы: позволяют настраивать параметры для платформы размещения, включая следующие.

  • Состояние FTP: возможность разрешить только FTPS или отключить протокол FTP в целом.

  • Bitness (Разрядность): 32-разрядная или 64-разрядная. Только для приложений для Windows.

  • WebSocket protocol (Протокол WebSocket): например, для ASP.NET SignalR или socket.io.

  • Always On: приложение остается загруженным даже при отсутствии трафика. Если параметр Всегда включено не включен (по умолчанию), приложение выгружается, если к нему не направляются запросы в течение 20 минут. Выгруженное приложение может вызвать высокую задержку для новых запросов, так как ему нужно снова загрузиться. Если параметр Всегда включено включен, внешняя подсистема балансировки нагрузки отправляет запрос GET к корню приложения каждые пять минут. Непрерывная проверка связи предотвращает выгрузку приложения.

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

  • HTTP version (Версия HTTP): задайте значение 2.0, чтобы включить поддержку протокола HTTPS/2.

  Примечание

  Большинство современных браузеров поддерживают протокол HTTP/2 только через TLS, а для незашифрованного трафика продолжает использоваться протокол HTTP/1.1. Чтобы клиентские браузеры могли подключаться к приложению по протоколу HTTP/2, обеспечьте безопасность настраиваемого DNS-имени. Дополнительные сведения см. в учебнике Защита пользовательского DNS-имени с помощью привязки TLS/SSL в Службе приложений Azure.

  • ARR affinity (Сходство для маршрутизации запросов приложений): в развертывании с несколькими экземплярами убедитесь, что в течение всего сеанса клиент направляется в один и тот же экземпляр. Для приложений без отслеживания состояния этот параметр можно установить в значение Off (Выкл.).

• Debugging (Отладка): включение удаленной отладки для приложений ASP.NET, ASP.NET Core или Node.js. Этот параметр автоматически отключается через 48 часов.

• Incoming client certificates (Входящие сертификаты клиента): требование сертификатов клиента при взаимной проверке подлинности.

Azure CLI

Многие из общих настраиваемых параметров можно задать с помощью команды az webapp config set. В следующем примере показано подмножество настраиваемых параметров.

az webapp config set --resource-group <group-name> --name <app-name> --use-32bit-worker-process [true|false] --web-sockets-enabled [true|false] --always-on [true|false]--http20-enabled --auto-heal-enabled [true|false] --remote-debugging-enabled [true|false] --number-of-workers

Чтобы отобразить существующие параметры, используйте команду az webapp config show.

Azure PowerShell

Можно задать множество общих настраиваемых параметров с помощью команды Set-AzWebApp. В следующем примере показано подмножество настраиваемых параметров.

Set-AzWebApp -ResourceGroupName <group-name> -Name <app-name> -Use32BitWorkerProcess [True|False] -WebSocketsEnabled [True|False] -AlwaysOn [True|False] -NumberOfWorkers

Чтобы отобразить существующие параметры, используйте команду Get-AzWebApp.

Настройка документов по умолчанию

Этот параметр существует только для приложений для Windows.

Документ по умолчанию — это веб-страница, которая отображается в корневом URL-адресе приложения в Службе приложений. Используется первый найденный файл в списке. Если приложение использует модули, которые выполняют маршрутизацию на основе URL-адреса, а не обслуживают статическое содержимое, нет необходимости в документах по умолчанию.

Портал Azure

1. На Портал Azure найдите и выберите Службы приложений, а затем выберите приложение.

2. В меню приложения слева выберите Конфигурация>Документы по умолчанию.

   

3. Чтобы добавить документ по умолчанию, нажмите Создать документ. Чтобы удалить документ по умолчанию, нажмите кнопку Удалить справа от него.

Azure CLI

Добавьте документ по умолчанию с помощью команды az resource update:

az resource update --resource-group <group-name> --resource-type "Microsoft.Web/sites/config" --name <app-name>/config/web --add properties.defaultDocuments <filename>

Azure PowerShell

Добавьте документ по умолчанию, изменив объект PowerShell приложения для обновления:

$webapp = Get-AzWebApp -ResourceGroupName <group-name> -Name <app-name>
$webapp.SiteConfig.DefaultDocuments.Add("<filename>")
Set-AzWebApp $webapp

Сопоставление URL-пути с каталогом

По умолчанию Служба приложений запускает приложение из корневого каталога кода приложения. Однако некоторые веб-платформы не запускаются в корневом каталоге. Например, Laravel запускается в подкаталоге public. Такое приложение будет доступно по адресу http://contoso.com/public, например, но обычно требуется направить http://contoso.com в каталог public. Если файл запуска приложения находится в другой папке или в репозитории имеется несколько приложений, можно изменить или добавить виртуальные приложения и каталоги.

Портал Azure

1. На Портал Azure найдите и выберите Службы приложений, а затем выберите приложение.

2. В меню приложения слева выберите Конфигурация>Сопоставления путей

3. Щелкните Добавить новое виртуальное приложение или каталог.

   • Чтобы сопоставить виртуальный каталог с физическим путем, установите флажок Каталог. Укажите виртуальный каталог и соответствующий относительный (физический) путь к корню веб-сайта (D:\home).
   • Чтобы пометить виртуальный каталог как веб-приложение, снимите флажок Каталог.

   

4. Нажмите кнопку ОК.

Azure CLI

В следующем примере задается корневой путь / к подкаталогу public (который работает для Laravel), а также добавляется второе виртуальное приложение по пути /app2. Чтобы его запустить, создайте файл json.txt со следующим содержимым.

[
  {
    "physicalPath"':' "site\\wwwroot\\public",
    "preloadEnabled"':' false,
    "virtualDirectories"':' null,
    "virtualPath"':' "/"
  },
  {
    "physicalPath"':' "site\\wwwroot\\app2",
    "preloadEnabled"':' false,
    "virtualDirectories"':' null,
    "virtualPath"':' "/app2"
  }
]

Измените <group-name> и <app-name> для ресурсов и выполните следующую команду. При выполнении этой команды следует учитывать escape-символы. Дополнительные сведения о escape-символах см. в статье Советы по эффективному использованию Azure CLI.

az resource update --resource-group <group-name> --resource-type Microsoft.Web/sites/config --name <app-name>/config/web --set properties.virtualApplications="@json.txt"

Azure PowerShell

В следующем примере задается корневой путь / к подкаталогу public (который работает для Laravel), а также добавляется второе виртуальное приложение по пути /app2. Чтобы запустить его, измените <group-name> и <app-name>.

$webapp=Get-AzWebApp -ResourceGroupName <group-name> -Name <app-name>

# Set default / path to public subdirectory
$webapp.SiteConfig.VirtualApplications[0].PhysicalPath= "site\wwwroot\public"

# Add a virtual application
$virtualApp = New-Object Microsoft.Azure.Management.WebSites.Models.VirtualApplication
$virtualApp.VirtualPath = "/app2"
$virtualApp.PhysicalPath = "site\wwwroot\app2"
$virtualApp.PreloadEnabled = $false
$webapp.SiteConfig.VirtualApplications.Add($virtualApp)

# Save settings
Set-AzWebApp $webapp

Настройка сопоставлений обработчиков

Для приложений для Windows можно настроить сопоставления обработчика IIS и виртуальных приложений и каталогов. Сопоставления обработчиков позволяют добавлять пользовательские обработчики скриптов, обрабатывающие запросы для определенных расширений файлов.

Чтобы добавить пользовательский обработчик, выполните следующие действия:

1. На Портал Azure найдите и выберите Службы приложений, а затем выберите приложение.

2. В меню приложения слева выберите Конфигурация>Сопоставления путей.

   

3. Щелкните Новое сопоставление обработчика. Настройте обработчик следующим образом.

   • Расширение. Расширение обрабатываемого файла, например *.php или handler.fcgi.
   • Обработчик скриптов. Абсолютный путь к обработчику скриптов. Обработчиком скриптов будут обрабатываться запросы к файлам, соответствующим указанному расширению. Используйте путь D:\home\site\wwwroot для указания корневого каталога веб-приложения.
   • Аргументы. Необязательные аргументы командной строки для обработчика скриптов.

4. Нажмите кнопку ОК.

Настройка пользовательских контейнеров

• Настройка контейнера клиента в Службе приложений Azure
• Добавление пользовательского хранилища для контейнерного приложения

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

• Справочные материалы по переменным среды и параметрам приложений
• Настройка личного доменного имени в службе приложений Azure
• Настройка промежуточных сред в Службе приложений Azure
• Защита пользовательского доменного имени с помощью привязки TLS/SSL в Службе приложений Azure
• Включение журналов диагностики
• Масштабирование приложения в службе приложений Azure
• Основы мониторинга в службе приложений Azure
• Изменение параметров applicationHost.config с помощью applicationHost.xdt