AzureRmWebAppDeployment@3 — Служба приложений Azure задачи развертывания версии 3

Используйте эту задачу для развертывания Служба приложений Azure веб-приложения, мобильного приложения или приложения API с помощью Docker, Java, .NET, .NET Core, Node.js, PHP, Python или Ruby.

Примечание

Используйте AzureFunctionApp@1 для развертывания приложений Функции Azure.

Синтаксис

# Azure App Service deploy v3
# Deploy to Azure App Service a web, mobile, or API app using Docker, Java, .NET, .NET Core, Node.js, PHP, Python, or Ruby.
- task: AzureRmWebAppDeployment@3
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure subscription. 
    appType: 'app' # 'app' | 'applinux' | 'functionapp' | 'api' | 'mobileapp'. Alias: WebAppKind. Required. App type. Default: app.
    WebAppName: # string. Required. App Service name. 
    #DeployToSlotFlag: false # boolean. Optional. Use when WebAppKind != "". Deploy to slot. Default: false.
    #ResourceGroupName: # string. Required when DeployToSlotFlag = true. Resource group. 
    #SlotName: # string. Required when DeployToSlotFlag = true. Slot. 
    #ImageSource: 'Registry' # 'Registry' | 'Builtin'. Optional. Use when WebAppKind = applinux || WebAppKind = linux. Image Source. Default: Registry.
    #AzureContainerRegistry: # string. Required when ImageSource = AzureContainerRegistry. Registry. 
    #AzureContainerRegistryLoginServer: # string. Optional. Use when ImageSource = invalidimagesource. Registry Login Server Name. 
    #AzureContainerRegistryImage: # string. Required when ImageSource = AzureContainerRegistry. Image. 
    #AzureContainerRegistryTag: # string. Optional. Use when ImageSource = AzureContainerRegistry. Tag. 
    #DockerRepositoryAccess: 'public' # 'private' | 'public'. Required when ImageSource = invalidImage. Repository Access. Default: public.
    #dockerRegistryConnection: # string. Alias: RegistryConnectedServiceName. Required when DockerRepositoryAccess = private || ImageSource = PrivateRegistry. Registry Connection. 
    #PrivateRegistryImage: # string. Required when ImageSource = PrivateRegistry. Image. 
    #PrivateRegistryTag: # string. Optional. Use when ImageSource = PrivateRegistry. Tag. 
    #DockerNamespace: # string. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource  = Registry. Registry or Namespace. 
    #DockerRepository: # string. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource  = Registry. Image. 
    #DockerImageTag: # string. Optional. Use when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource  = Registry. Tag. 
    #VirtualApplication: # string. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Virtual application. 
    #Package: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required when WebAppKind != linux && WebAppKind != applinux &&  WebAppKind != "". Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #packageForLinux: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Alias: BuiltinLinuxPackage. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #RuntimeStack: # string. Required when WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin. Runtime Stack. 
    #StartupCommand: # string. Optional. Use when WebAppKind = applinux || WebAppKind = linux. Startup command. 
  # Output
    #WebAppUri: # string. Optional. Use when WebAppKind != "". App Service URL. 
  # Post Deployment Action
    #ScriptType: # 'Inline Script' | 'File Path'. Optional. Use when WebAppKind != "". Deployment script type. 
    #InlineScript: ':: You can provide your deployment commands here. One command per line.' # string. Required when ScriptType == Inline Script && WebAppKind != "". Inline Script. Default: :: You can provide your deployment commands here. One command per line..
    #ScriptPath: # string. Required when ScriptType == File Path && WebAppKind != "". Deployment script path. 
  # File Transforms & Variable Substitution Options
    #GenerateWebConfig: false # boolean. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Generate Web.config. Default: false.
    #WebConfigParameters: # string. Required when GenerateWebConfig == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Web.config parameters. 
    #enableXmlTransform: false # boolean. Alias: XmlTransformation. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. XML transformation. Default: false.
    #enableXmlVariableSubstitution: false # boolean. Alias: XmlVariableSubstitution. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. XML variable substitution. Default: false.
    #JSONFiles: # string. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. JSON variable substitution. 
  # Application and Configuration Settings
    #AppSettings: # string. App settings. 
    #ConfigurationSettings: # string. Configuration settings. 
  # Additional Deployment Options
    #TakeAppOfflineFlag: false # boolean. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Take App Offline. Default: false.
    #UseWebDeploy: false # boolean. Optional. Use when WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Publish using Web Deploy. Default: false.
    #SetParametersFile: # string. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". SetParameters file. 
    #RemoveAdditionalFilesFlag: false # boolean. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Remove additional files at destination. Default: false.
    #ExcludeFilesFromAppDataFlag: false # boolean. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Exclude files from the App_Data folder. Default: false.
    #AdditionalArguments: # string. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Additional arguments. 
    #RenameFilesFlag: false # boolean. Optional. Use when UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Rename locked files. Default: false.

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

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

Укажите подписку azure Resource Manager для развертывания.

appType - Тип приложения
Входной псевдоним: WebAppKind. string. Обязательный. Допустимые значения: app (веб-приложение), applinux (веб-приложение Linux), functionapp (приложение-функция (не рекомендуется, использовать Функции Azure задача)), api (приложение API), mobileapp (мобильное приложение). Значение по умолчанию: app.

Укажите тип развертываемого веб-приложения.

Примечание. Укажите веб-приложение Linux для встроенных образов платформы или развертываний пользовательских образов контейнеров.

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

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

DeployToSlotFlag - Развертывание в слоте
boolean. Необязательный элемент. Используйте при WebAppKind != "". Значение по умолчанию: false.

Используйте этот параметр для развертывания в существующем слоте, отличном от рабочего слота. Если этот параметр не выбран, Служба приложений Azure будет развернут в рабочем слоте.

ResourceGroupName - Группа ресурсов
string. Требуется, если DeployToSlotFlag = true.

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

SlotName - Слот
string. Требуется, если DeployToSlotFlag = true.

Укажите существующий слот, отличный от рабочего слота.

ImageSource - Источник изображения
string. Необязательный элемент. Используйте при WebAppKind = applinux || WebAppKind = linux. Допустимые значения: Registry (Реестр контейнеров), Builtin (встроенный образ). Значение по умолчанию: Registry.

Служба приложений в Linux предлагает два варианта публикации приложения:

Развертывание пользовательского образа или приложения со встроенным образом платформы.

AzureContainerRegistry - Реестра
string. Требуется, если ImageSource = AzureContainerRegistry.

Глобально уникальное доменное имя верхнего уровня для конкретного реестра.

Примечание. Полное имя образа будет иметь формат: <registry>/<repository>:.<tag> Например, myregistry.azurecr.io/nginx:latest.

AzureContainerRegistryLoginServer - Имя сервера входа в реестр
string. Необязательный элемент. Используйте при ImageSource = invalidimagesource.

Укажите имя сервера входа реестра контейнеров Azure.

AzureContainerRegistryImage - Изображения
string. Требуется, если ImageSource = AzureContainerRegistry.

Имя репозитория, в котором хранятся образы контейнеров.

Примечание. Полное имя образа будет иметь формат: <registry>/<repository>:.<tag> Например, myregistry.azurecr.io/nginx:.latest

AzureContainerRegistryTag - Тег
string. Необязательный элемент. Используйте при ImageSource = AzureContainerRegistry.

Это механизм, который реестры используют для предоставления образам Docker версии.

Примечание. Полное имя образа будет иметь формат: <registry>/<repository>:.<tag> Например, myregistry.azurecr.io/nginx:.latest

DockerRepositoryAccess - Доступ к репозиторию
string. Требуется, если ImageSource = invalidImage. Допустимые значения: private, public. Значение по умолчанию: public.

Укажите доступ к репозиторию Docker.

dockerRegistryConnection - Подключение к реестру
Входной псевдоним: RegistryConnectedServiceName. string. Требуется, если DockerRepositoryAccess = private || ImageSource = PrivateRegistry.

Укажите подключение к реестру.

PrivateRegistryImage - Изображения
string. Требуется, если ImageSource = PrivateRegistry.

Имя репозитория, в котором хранятся образы контейнеров.

Примечание. Полное имя образа будет иметь формат: <registry><repository>:<tag>. Например, myregistry.azurecr.io/nginx:.latest

PrivateRegistryTag - Тег
string. Необязательный элемент. Используйте при ImageSource = PrivateRegistry.

Теги — это механизм, который реестры используют для предоставления образам Docker версии.

Примечание. Полное имя образа будет иметь формат :<registry>/<repository>:.<tag> Например, myregistry.azurecr.io/nginx:.latest

DockerNamespace - Реестр или пространство имен
string. Требуется, если WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

Глобально уникальное доменное имя верхнего уровня для конкретного реестра или пространства имен.

Примечание. Полное имя образа будет иметь формат: <registry or namespace>/<repository>:.<tag> Например, myregistry.azurecr.io/nginx:.latest

DockerRepository - Изображения
string. Требуется, если WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

Имя репозитория, в котором хранятся образы контейнеров.

Примечание. Полное имя образа будет иметь формат : "<registry or namespace>/<repository>:.<tag> Например, myregistry.azurecr.io/nginx:.latest

DockerImageTag - Тег
string. Необязательный элемент. Используйте при WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Registry.

Это механизм, который реестры используют для предоставления образам Docker версии.

Примечание. Полное имя образа будет иметь формат :<registry or namespace>/<repository>:.<tag> Например, myregistry.azurecr.io/nginx:.latest

VirtualApplication - Виртуальное приложение
string. Необязательный элемент. Используйте при WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

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

Package - Пакет или папка
string. Требуется при .WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" Значение по умолчанию: $(System.DefaultWorkingDirectory)/**/*.zip.

Путь к пакету или папке, содержащей содержимое службы приложений, созданное MSBuild или сжатым ZIP-файлом или war- файлом.

Переменные: Build и Release. Поддерживаются подстановочные знаки.

Например, $(System.DefaultWorkingDirectory)/\*\*/\*.zip или $(System.DefaultWorkingDirectory)/\*\*/\*.war.

packageForLinux - Пакет или папка
Входной псевдоним: BuiltinLinuxPackage. string. Требуется при .WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin Значение по умолчанию: $(System.DefaultWorkingDirectory)/**/*.zip.

Путь к пакету или папке, содержащей содержимое службы приложений, созданное MSBuild или сжатым ZIP-файлом или war- файлом.

Переменные: Build и Release. Поддерживаются подстановочные знаки.

Например, $(System.DefaultWorkingDirectory)/\*\*/\*.zip или $(System.DefaultWorkingDirectory)/\*\*/\*.war.

RuntimeStack - Стек среды выполнения
string. Требуется при .WebAppKind != app && WebAppKind != functionapp && WebAppKind != api && WebAppKind != mobileapp && ImageSource = Builtin

Укажите платформу и версию.

StartupCommand - Команда запуска
string. Необязательный элемент. Используйте при WebAppKind = applinux || WebAppKind = linux.

Укажите команду запуска.

WebAppUri - URL-адрес Служба приложений
string. Необязательный элемент. Используйте при WebAppKind != "".

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

ScriptType - Тип скрипта развертывания
string. Необязательный элемент. Используйте при WebAppKind != "". Допустимые значения: Inline Script, File Path (Путь к файлу скрипта).

Настраивает развертывание, предоставляя скрипт, который будет выполняться в службе приложение Azure после успешного завершения задачи развертывания . Например, это может восстановить пакеты для приложений Node, PHP и Python. Дополнительные сведения о развертывании Служба приложений Azure.

InlineScript - Встроенный скрипт
string. Требуется при .ScriptType == Inline Script && WebAppKind != "" Значение по умолчанию: :: You can provide your deployment commands here. One command per line..

ScriptPath - Путь к скрипту развертывания
string. Требуется при .ScriptType == File Path && WebAppKind != ""

GenerateWebConfig - Создание Web.config
boolean. Необязательный элемент. Используйте при WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Значение по умолчанию: false.

Web.config Стандарт будет создан и развернут в Служба приложений Azure, если у приложения его нет. Значения в web.config можно изменять и изменять в зависимости от платформы приложений. Например, для node.js приложения web.config будут содержаться значения файла запуска и iis_node модуля. Дополнительные сведения о развертывании Служба приложений Azure.

WebConfigParameters - параметрыWeb.config
string. Требуется при .GenerateWebConfig == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war

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

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

Изменяет параметры приложения веб-приложения в соответствии со значением синтаксиса -key . Значения, содержащие пробелы, должны быть заключены в двойные кавычки. Примеры: -Port 5000-RequestTimeout 5000-WEBSITE_TIME_ZONE"Eastern Standard Time".

ConfigurationSettings - Параметры конфигурации
string.

Изменяет параметры конфигурации веб-приложения в соответствии со значением синтаксиса -key . Значения, содержащие пробелы, должны быть заключены в двойные кавычки.

Примеры: -phpVersion 5.6-linuxFxVersion: node|6.11.

TakeAppOfflineFlag - Перевести приложение в автономный режим
boolean. Необязательный элемент. Используйте при WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Значение по умолчанию: false.

Используйте этот параметр, чтобы перевести Служба приложений Azure в автономный app_offline.htm режим, разместив файл в корневом каталоге Служба приложений перед началом операции синхронизации. Файл будет удален после успешного завершения операции синхронизации.

UseWebDeploy - Публикация с помощью веб-развертывания
boolean. Необязательный элемент. Используйте при WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Значение по умолчанию: false.

Publish using Web Deploy параметры поддерживаются только при использовании агента Windows. На других платформах задача использует REST API Kudu для развертывания Служба приложений Azure, и следующие параметры не поддерживаются.

SetParametersFile - Файл SetParameters
string. Необязательный элемент. Используйте при UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

Расположение используемого SetParameters.xml файла.

RemoveAdditionalFilesFlag - Удаление дополнительных файлов в месте назначения
boolean. Необязательный элемент. Используйте при UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Значение по умолчанию: false.

Используйте этот параметр для удаления файлов на Служба приложений Azure, которые не имеют соответствующих файлов в пакете Служба приложений или папке.

Примечание. При этом также будут удалены все файлы, связанные с любым расширением, установленным на этом Служба приложений Azure. Чтобы избежать этого, установите Exclude files from App_Data folder флажок.

ExcludeFilesFromAppDataFlag - Исключение файлов из папки App_Data
boolean. Необязательный элемент. Используйте при UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Значение по умолчанию: false.

Используйте этот параметр, чтобы предотвратить развертывание файлов в App_Data папке или удаление из Служба приложений Azure.

AdditionalArguments - Дополнительные аргументы
string. Необязательный элемент. Используйте при UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "".

Дополнительные аргументы веб-развертывания, следующие синтаксису -key:value.

Они будут применяться при развертывании Служба приложений Azure. Примеры: -disableLink:AppPoolExtension-disableLink:ContentExtension.

См. дополнительные примеры параметров операции веб-развертывания.

RenameFilesFlag - Переименование заблокированных файлов
boolean. Необязательный элемент. Используйте при UseWebDeploy == true && WebAppKind != linux && WebAppKind != applinux && WebAppKind != "". Значение по умолчанию: false.

Используйте этот параметр, чтобы включить флаг MSDEPLOY_RENAME_LOCKED_FILES=1 msdeploy в Служба приложений Azure параметрах приложения. Параметр позволяет msdeploy переименовывать заблокированные файлы, заблокированные во время развертывания приложения.

enableXmlTransform - Преобразование XML
Входной псевдоним: XmlTransformation. boolean. Необязательный элемент. Используйте при WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Значение по умолчанию: false.

Преобразования конфигурации будут выполняться для *.Release.config и *.<EnvironmentName>.config в *.config file.

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

Преобразования XML поддерживаются только для платформы Windows.

enableXmlVariableSubstitution - Подстановка переменных XML
Входной псевдоним: XmlVariableSubstitution. boolean. Необязательный элемент. Используйте при WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war. Значение по умолчанию: false.

Переменные, определенные в конвейере сборки или выпуска, будут сопоставляться с key записями или name в appSettingsразделах , applicationSettingsи connectionStrings любого файла конфигурации и parameters.xml. Подстановка переменных выполняется после преобразования конфигурации.

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

JSONFiles - Подстановка переменных JSON
string. Необязательный элемент. Используйте при WebAppKind != linux && WebAppKind != applinux && WebAppKind != "" && Package NotEndsWith .war.

Предоставляет новый разделенный строками список ФАЙЛОВ JSON для замены значений переменных. Имена файлов должны быть указаны относительно корневой папки.

Чтобы заменить вложенные или иерархические переменные JSON, укажите их с помощью JSONPath выражений.

Например, чтобы заменить значение ConnectionString в приведенном ниже примере, необходимо определить переменную как Data.DefaultConnection.ConnectionString в конвейере сборки и выпуска (или в среде конвейера выпуска).

{
  "Data": {
    "DefaultConnection": {
      "ConnectionString": "Server=(localdb)\SQLEXPRESS;Database=MyDB;Trusted_Connection=True"
    }
  }
}

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

Примечание. Переменные конвейера исключаются в подстановке.

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

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

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

Нет.

Remarks

Доступна более новая версия этой задачи. Дополнительные сведения см. в разделе AzureRmWebAppDeployment@4.

Устранение неполадок

Не удается выполнить веб-развертывание на Служба приложений Azure с использованием проверки подлинности Microsoft Entra ID из агента Windows

Задача развертывания Служба приложений Azure поддерживает подключение к Microsoft Azure с помощью подключения к службе ARM с помощью Microsoft Entra ID, если не выполняются следующие три условия:

• Вы используете формат пакета веб-развертывания в агенте Windows
• Агент работает с более ранней версией msdeploy.exe (например, при использовании образа размещенного агента windows-2019 ).
• Обычная проверка подлинности отключена для Служба приложений Azure

Если эти три условия присутствуют, вы получите сообщение об ошибке, например App Service is configured to not use basic authentication. This requires Web Deploy msdeploy.exe version 7.1.7225.2108 or higher. You need a version of Visual Studio that includes an updated version of msdeploy.exe. For more information, visit https://aka.ms/azdo-webapp-msdeploy.

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

1. Обновите образ агента. Если вы используете размещенные агенты, перейдите с windows-2019 на windows-2022 (или windows-latest). Если вы используете локальные агенты, установите Visual Studio 2022 на агенте, чтобы получить более новую версию msdeploy.exe.
2. Если вы зависите от более старого образа агента и не можете обновить агент для конвейера, рассмотрите возможность разделения задания, чтобы задача развертывания Служба приложений Azure выполнялась в windows-2022 (или windows-latest).
3. Если ни то из этих вариантов не существует, вы можете включить обычную проверку подлинности для Служба приложений Azure.

Требования

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