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

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

  • Статья

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

Эта версия задачи устарела; используйте AzureRmWebAppDeployment@4, чтобы воспользоваться новейшими функциями, такими как федерация удостоверений рабочей нагрузки .

Примечание.

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

Используйте эту задачу для развертывания в Службе приложений 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 для развертывания.


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

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

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


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

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

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


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

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


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

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


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

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


слота
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.


тегов
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.


тегов
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.


тегов
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-файлом или файлом войны.

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

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


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

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

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

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


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

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


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

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


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

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


типа скрипта развертывания
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.jsweb.config будет иметься файл запуска и значения модуля iis_node. Дополнительные сведения о развертывании службы приложений Azure.


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

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


параметров приложения
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, а следующие параметры не поддерживаются.


файла 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 MSDEPLOY_RENAME_LOCKED_FILES=1 в параметрах приложения Службы приложений 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"
    }
  }
}

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

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


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

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

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

Нет.

Замечания

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

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

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

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

  • Формат пакета веб-развертывания используется в агенте 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
требования Нет
возможностей Эта задача не удовлетворяет требованиям к последующим задачам в задании.
ограничения команд Любое
переменные settable Любое
Версия агента 2.104.1 или более поздней версии
Категория задач Внедрять