AzureAppServiceSettings@1 — задача "Параметры Служба приложений Azure" версии 1

  • Мақала

Обновления или добавляет параметры службы приложений в веб-приложение Azure для Linux или Windows.

Синтаксис

# Azure App Service Settings v1
# Update/Add App settings an Azure Web App for Linux or Windows.
- task: AzureAppServiceSettings@1
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    appName: # string. Required. App Service name. 
    resourceGroupName: # string. Required. Resource group. 
    #slotName: 'production' # string. Slot. Default: production.
  # Application and Configuration Settings
    #appSettings: # string. App settings. 
    #generalSettings: # string. General settings. 
    #connectionStrings: # string. Connection Strings.

Входные данные

azureSubscription - Подписка Azure
Входной псевдоним: ConnectedServiceName. string. Обязательный.

Выбирает подписку azure Resource Manager.


appName - имя Служба приложений
string. Обязательный.

Вводит или выбирает имя существующего Служба приложений Azure.


resourceGroupName - Группа ресурсов
string. Обязательный.

Вводит или выбирает группу ресурсов Azure, содержащую указанные выше Служба приложений Azure.


slotName - Слот
string. Значение по умолчанию: production.

Вводит или выбирает существующий слот. Если не выбрать слот, в рабочую среду будут внесены изменения.


appSettings - Параметры приложения
string.

Параметры приложения в синтаксисе JSON. Заключите значения, содержащие пробелы, в двойные кавычки. Дополнительные сведения см. в разделе Настройка параметров приложения.

Ниже приведен пример синтаксиса JSON.

[
   {
    "name": "key1",
    "value": "valueabcd",
    "slotSetting": false
   },
   {
    "name": "key2",
    "value": "valueefgh",
    "slotSetting": true
   }
]

generalSettings - Общие параметры
string.

Общие параметры в синтаксисе JSON. Заключите значения, содержащие пробелы, в двойные кавычки. Список доступных свойств см. в документации по объекту Служба приложений SiteConfig. Дополнительные сведения см. в разделе Настройка общих параметров.

Ниже приведен пример синтаксиса JSON.

[
   {
    "alwaysOn": true,
    "webSocketsEnabled": false
   }
]

connectionStrings - Строки подключения
string.

Строки подключения в синтаксисе JSON. Заключите значения, содержащие пробелы, в двойные кавычки. Дополнительные сведения см. в статье Настройка строк подключения.

Ниже приведен пример синтаксиса JSON.

[
   {
    "name": "key1",
    "value": "valueabcd",
    "type": "MySql",
    "slotSetting": false
   },
   {
    "name": "key2",
    "value": "valueefgh",
    "type": "Custom",
    "slotSetting": true
   }
]

Параметры управления задачами

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

Выходные переменные

Нет.

Remarks

Используйте эту задачу для массовой настройки параметров приложения, строк подключения и других общих параметров с помощью синтаксиса JSON в веб-приложении или любом из его слотов развертывания. Задача работает с кроссплатформенными агентами Azure Pipelines под управлением Windows, Linux или Mac. Эта задача работает для веб-приложений на основе ASP.NET, ASP.NET Core, PHP, Java, Python, Go и Node.js.

Примеры

В следующем примере фрагмента YAML развертывается веб-приложение в службе веб-приложений Azure, работающей в Windows.


variables:
  azureSubscription: Contoso
  WebApp_Name: sampleWebApp
  # To ignore SSL error uncomment the below variable
  # VSTS_ARM_REST_IGNORE_SSL_ERRORS: true

steps:

- task: AzureWebApp@1
  displayName: Azure Web App Deploy
  inputs:
    azureSubscription: $(azureSubscription)
    appName: $(WebApp_Name)
    package: $(System.DefaultWorkingDirectory)/**/*.zip

- task: AzureAppServiceSettings@1
  displayName: Azure App Service Settings
  inputs:
    azureSubscription: $(azureSubscription)
    appName: $(WebApp_Name)
   # To deploy the settings on a slot, provide slot name as below. By default, the settings would be applied to the actual Web App (Production slot)
   # slotName: staging
    appSettings: |
      [
        {
          "name": "APPINSIGHTS_INSTRUMENTATIONKEY",
          "value": "$(Key)",
          "slotSetting": false
        },
        {
          "name": "MYSQL_DATABASE_NAME",
          "value": "$(DB_Name)", 
          "slotSetting": false
        }
      ]
    generalSettings: |
      [
        {
          "alwaysOn": true,
          "webSocketsEnabled": false
        }
      ]
    connectionStrings: |
      [
        {
          "name": "MysqlCredentials",
          "value": "$(MySQl_ConnectionString)",
          "type": "MySql",
          "slotSetting": false
        }
      ]

Требования

Требование Описание
Типы конвейеров YAML, классическая сборка, классический выпуск
Выполняется в Агент, DeploymentGroup
Требования Нет
Capabilities Эта задача не удовлетворяет требованиям для последующих задач в задании.
Ограничения команд Любой
Устанавливаемые переменные Любой
Версия агента 2.104.1 или более поздней версии
Категория задач Развертывание