AzureWebApp@1 - Azure Web 应用 v1 任务

  • 项目

此任务部署适用于 Linux 或 Windows 的 Azure Web 应用。

语法

# Azure Web App v1
# Deploy an Azure Web App for Linux or Windows.
- task: AzureWebApp@1
  inputs:
    azureSubscription: # string. Required. Azure subscription. 
    appType: # 'webApp' | 'webAppLinux'. Required. App type. 
    appName: # string. Required. App name. 
    #deployToSlotOrASE: false # boolean. Optional. Use when appType != "". Deploy to Slot or App Service Environment. Default: false.
    #resourceGroupName: # string. Required when deployToSlotOrASE = true. Resource group. 
    #slotName: 'production' # string. Required when deployToSlotOrASE = true. Slot. Default: production.
    package: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #customDeployFolder: # string. Optional. Use when package EndsWith .war. Custom Deploy Folder. 
    #runtimeStack: # string. Optional. Use when appType = webAppLinux. Runtime stack. 
    #startUpCommand: # string. Optional. Use when appType = webAppLinux. Startup command. 
  # Application and Configuration Settings
    #customWebConfig: # string. Optional. Use when appType != webAppLinux && package NotEndsWith .war. Generate web.config parameters for Python, Node.js, Go and Java apps. 
    #appSettings: # string. App settings. 
    #configurationStrings: # string. Configuration settings. 
  # Additional Deployment Options
    #deploymentMethod: 'auto' # 'auto' | 'zipDeploy' | 'runFromPackage'. Required when appType != webAppLinux && appType != "" && package NotEndsWith .war && package NotEndsWith .jar. Deployment method. Default: auto.

# Azure Web App v1
# Deploy an Azure Web App for Linux or Windows.
- task: AzureWebApp@1
  inputs:
    azureSubscription: # string. Required. Azure subscription. 
    appType: # 'webApp' | 'webAppLinux'. Required. App type. 
    appName: # string. Required. App name. 
    #deployToSlotOrASE: false # boolean. Optional. Use when appType != "". Deploy to Slot or App Service Environment. Default: false.
    #resourceGroupName: # string. Required when deployToSlotOrASE = true. Resource group. 
    #slotName: 'production' # string. Required when deployToSlotOrASE = true. Slot. Default: production.
    package: '$(System.DefaultWorkingDirectory)/**/*.zip' # string. Required. Package or folder. Default: $(System.DefaultWorkingDirectory)/**/*.zip.
    #runtimeStack: # string. Optional. Use when appType = webAppLinux. Runtime stack. 
    #startUpCommand: # string. Optional. Use when appType = webAppLinux. Startup command. 
  # Application and Configuration Settings
    #customWebConfig: # string. Optional. Use when appType != webAppLinux && package NotEndsWith .war. Generate web.config parameters for Python, Node.js, Go and Java apps. 
    #appSettings: # string. App settings. 
    #configurationStrings: # string. Configuration settings. 
  # Additional Deployment Options
    #deploymentMethod: 'auto' # 'auto' | 'zipDeploy' | 'runFromPackage'. Required when appType != webAppLinux && appType != "" && package NotEndsWith .war && package NotEndsWith .jar. Deployment method. Default: auto.

输入

azureSubscription - Azure 订阅
string. 必需。

指定部署的 Azure 资源管理器 订阅连接。


appType - 应用类型
string. 必需。 允许的值： webApp Windows) 上的 (Web 应用， webAppLinux (Linux) 上的 Web 应用。

指定 Azure Web 应用类型。


appName - 应用名称
string. 必需。

指定现有Azure 应用服务的名称。 仅列出基于所选应用类型的应用服务。


deployToSlotOrASE - 部署到槽或应用服务环境
boolean. 可选。 在 时 appType != ""使用 。 默认值：false。

选择部署到现有部署槽位或Azure 应用服务环境的选项。
对于这两个目标，任务都需要资源组名称。
如果部署目标是槽，则默认为生产槽。 也可以提供任何其他现有槽名称。
如果部署目标是Azure 应用服务环境，请将槽名称保留为“production”，并指定资源组名称。


resourceGroupName - 资源组
string. 当 deployToSlotOrASE = true 时，需要此选项。

当部署目标为部署槽位或Azure 应用服务环境时，资源组名称是必需的。
指定包含上述Azure 应用服务的 Azure 资源组。


slotName - 槽
string. 当 deployToSlotOrASE = true 时，需要此选项。 默认值：production。

指定现有槽，不包括生产槽。


package - 包或文件夹
string. 必需。 默认值：$(System.DefaultWorkingDirectory)/**/*.zip。

包或文件夹的文件路径，其中包含 MSBuild 生成的App 服务内容、压缩 zip 文件或 war 文件。 支持变量 ( 生成 | 版本) 和通配符。 例如 $(System.DefaultWorkingDirectory)/**/*.zip 或 $(System.DefaultWorkingDirectory)/**/*.war。


customDeployFolder - 自定义部署文件夹
string. 可选。 在 时 package EndsWith .war使用 。

指定要部署到的自定义文件夹名称。
如果 字段为空，则包将部署到 <appname>.azurewebsites.net/<warpackagename>。
如果输入 ROOT，则包将部署到 <appname>.azurewebsited.net。
在所有其他实例中，它将部署到 <appname>.azurewebsited.net/<customWarName>。


runtimeStack - 运行时堆栈
string. 可选。 在 时 appType = webAppLinux使用 。

Linux 上的 Web 应用提供两个不同的选项来发布应用程序：自定义映像部署 (用于容器的 Web 应用) ，以及使用内置平台映像的应用部署 (Linux) 上的 Web 应用。 仅当在任务中选择 Linux Web 应用 作为应用类型时，此参数才可用。


startUpCommand - 启动命令
string. 可选。 在 时 appType = webAppLinux使用 。

指定启动命令。
例如：
dotnet run
dotnet filename.dll.


customWebConfig - 为 Python、Node.js、Go 和 Java 应用生成 web.config 参数
string. 可选。 在 时 appType != webAppLinux && package NotEndsWith .war使用 。

如果应用程序没有标准 web.config，则会生成标准 web.config 并将其部署到Azure 应用服务。 web.config 中的值因应用程序框架而异，并且可以对其进行编辑。 例如，对于 node.js 应用程序，web.config 将具有启动文件和iis_node模块值。 此编辑功能仅适用于 生成的 web.config。


appSettings - 应用设置
string.

使用语法 -key value (指定 Web 应用应用程序设置，例如： -Port 5000-RequestTimeout 5000-WEBSITE_TIME_ZONE) 。 将包含空格的值括在双引号中， (例如： "Eastern Standard Time") 。


configurationStrings - 配置设置
string.

使用语法 -key value (指定 Web 应用配置设置，例如： -phpVersion 5.6-linuxFxVersion: node|6.11) 。 将包含空格的值括在双引号中。


deploymentMethod - 部署方法
string. 当 appType != webAppLinux && appType != "" && package NotEndsWith .war && package NotEndsWith .jar 时，需要此选项。 允许的值： auto (自动检测) 、 zipDeploy (Zip 部署) (runFromPackage 从包) 运行。 默认值：auto。

选择应用的 部署方法 。 可接受的值为 auto、 zipDeploy 和 runFromPackage。


任务控制选项

除了任务输入，所有任务都有控制选项。 有关详细信息，请参阅 控制选项和常见任务属性。

输出变量

此任务定义以下 输出变量，可在下游步骤、作业和阶段中使用。

AppServiceApplicationUrl
所选Azure 应用服务的应用程序 URL。

注解

使用此任务可将 Web 应用程序部署到 Azure 应用服务。

部署方法

在此任务中可以使用多种部署方法。 Auto 是默认选项。

若要在设计器任务中更改基于包的部署选项，请展开 “其他部署选项” 并启用 “选择部署方法”。

该任务根据 Azure 应用服务和 Azure Pipelines 代理的类型选择合适的部署技术。 该任务使用的不同部署技术包括：

  • Kudu REST API
  • Zip 部署
  • RunFromPackage

默认情况下，根据输入包、应用服务类型和代理 OS，任务会尝试选择适当的部署技术。

  • 当应用服务类型为 Linux 应用上的 Web 应用时，请使用 Zip 部署
  • 如果提供了 War 文件，请使用 War Deploy
  • 如果提供了 Jar 文件，请使用 “从包运行”
  • 对于所有其他项，请通过 Zip 部署 (使用 “从 Zip 运行 ”)

在任何应用服务类型) 的非 Windows 代理 (上，任务依赖于 Kudu REST API 来部署 Web 应用。

Kudu REST API

当目标是 Windows 上的 Web 应用、Linux 上的 Web 应用 (内置源) 或函数应用时，Kudu REST API 适用于 Windows 或 Linux 自动化代理。 该任务使用 Kudu 将文件复制到Azure 应用服务。

Zip 部署

创建所选包或文件夹的 .zip 部署包。 然后将文件内容部署到 Azure 应用服务 中函数应用的 wwwroot 文件夹。 此选项将覆盖 wwwroot 文件夹中的所有现有内容。 有关详细信息，请参阅 Azure Functions 的 Zip 部署。

RunFromPackage

创建与 Zip 部署相同的部署包。 但是，整个包由Azure Functions运行时装载，而不是将文件部署到 wwwroot 文件夹。 使用此选项时，wwwroot 文件夹中的文件将变为只读。 有关详细信息，请参阅从包文件运行 Azure Functions。

错误：无法提取 Azure 的访问令牌。 请确认使用的服务主体有效且未过期。

该任务使用服务连接中的服务主体向 Azure 进行身份验证。 如果该服务主体已过期或无权访问应用服务，该任务将会失败并出现此错误。 验证所使用的服务主体的有效期以及该主体是否存在于应用注册中。 有关详细信息，请参阅使用基于角色的访问控制来管理对 Azure 订阅资源的访问。 此博客文章也提供了有关使用服务主体身份验证的详细信息。

SSL 错误

如果你要在应用服务中使用证书，该证书必须已由受信任的证书颁发机构签名。 如果 Web 应用显示证书验证错误，可能是因为使用了自签名证书。 在生成或发布管道中将名为 VSTS_ARM_REST_IGNORE_SSL_ERRORS 的变量设置为值 true 即可解决该错误。

发布长时间挂起，然后失败

此问题可能是因应用服务计划中容量不足而导致。 若要解决此问题，可以纵向扩展应用服务实例以增加可用的 CPU、RAM 和磁盘空间，或者尝试使用其他应用服务计划。

5xx 错误代码

如果出现 5xx 错误，请检查 Azure 服务的状态。

Azure 函数突然停止工作

如果自上次部署以来已超过一年时间，Azure Functions可能会突然停止工作。 如果在“deploymentMethod”中使用“RunFromPackage”进行部署，则会生成过期日期为 1 年的 SAS，并在应用程序配置中将其设置为“WEBSITE_RUN_FROM_PACKAGE”的值。 Azure Functions使用此 SAS 来引用用于执行函数的包文件，因此如果 SAS 已过期，则不会执行函数。 若要解决此问题，请再次部署以生成过期日期为一年的 SAS。

错误：找不到具有指定模式的包

检查任务中提及的包是否在生成或上一阶段中作为项目发布，以及是否已在当前作业中下载。

错误：msBuild 包类型不支持使用 zip 部署选项进行发布

通过 MSBuild 任务创建的 Web 包（使用默认参数）具有嵌套文件夹结构，只能由 Web 部署正确部署。 发布到 zip 部署选项不能用于部署这些包。 若要转换打包结构，请执行以下步骤：

  1. 在“生成解决方案”任务中，将“MSBuild 参数”更改为 /p:DeployOnBuild=true /p:DeployDefaultTarget=WebPublish /p:WebPublishMethod=FileSystem /p:DeleteExistingFiles=True /p:publishUrl="$(System.DefaultWorkingDirectory)\\WebAppContent"：

    显示“生成解决方案”值的屏幕截图。

  2. 添加“存档”任务并更改值，如下所示：

    1. 将“要存档的根文件夹或文件”更改为 $(System.DefaultWorkingDirectory)\\WebAppContent。

    2. 清除“在存档路径前面附加根文件夹名称”复选框：

      显示“存档”值的屏幕截图。

常见问题

和 AzureRmWebAppDeployment 任务之间的区别AzureWebApp是什么？

Azure Web 应用任务 (AzureWebApp) 是部署到 Azure Web 应用的最简单方法。 默认情况下，部署发生在 Azure Web 应用中的根应用程序。

Azure 应用服务部署任务 (AzureRmWebAppDeployment) 可以处理更多自定义方案，例如：

  • 修改 Web 包和 XML 参数文件中的配置设置。
  • 如果你习惯了 IIS 部署过程，请使用 Web 部署进行部署。
  • 部署到虚拟应用程序。
  • 部署到其他应用类型，如容器应用、函数应用、WebJobs 或 API 和移动应用。

注意

用于 Azure Pipelines 的单独文件转换任务也支持文件转换和变量替换。 可以使用文件转换任务对任何配置文件及参数文件应用文件转换和变量替换。

Windows 上的 Web 应用部署成功，但应用无法正常运行

这可能是因为应用中不存在 web.config。 可以将 web.config 文件添加到源，也可以使用 应用程序和配置设置自动生成文件。

  • 单击任务，然后转到 为 Python、Node.js、Go 和 Java 应用生成 web.config 参数。

    “生成 web.config 参数”对话框的屏幕截图。

  • 单击“更多”按钮 ... 以编辑参数。

    下拉对话框的屏幕截图。

  • 从下拉列表中选择你的应用程序类型。

  • 单击“确定”。 这将填充生成 web.config 所需的 web.config 参数。

应用服务环境 (ASE) 上的 Web 应用部署无法正常运行

  • 确保 Azure DevOps 生成代理与 ASE 的内部负载均衡器 (ILB) 位于同一 VNET 上（子网可以不同）。 这样，代理便可以从 Azure DevOps 中拉取代码并部署到 ASE。
  • 如果使用 Azure DevOps，则无需从 Internet 访问代理，只需出站访问权限即可连接到 Azure DevOps 服务。
  • 如果使用部署在虚拟网络中的 TFS/Azure DevOps Server，则可以完全隔离代理。
  • 必须使用需要部署到的 Web 应用的 DNS 配置来配置生成代理。 虚拟网络中的专用资源在 Azure DNS 中没有条目，因此需要将其添加到代理计算机上的主机文件中。
  • 如果将自签名证书用于 ASE 配置， -allowUntrusted 则需要在 MSDeploy 的部署任务中设置选项。 还建议将 变量 VSTS_ARM_REST_IGNORE_SSL_ERRORS 设置为 true。 如果将证书颁发机构颁发的证书用于 ASE 配置，则没有必要这样做。

如何配置我的服务连接？

此任务需要 Azure 资源管理器服务连接。

如何使用 Application Insights 配置 Web 作业部署？

部署到应用服务时，如果配置了 Application Insights 并启用了 Remove additional files at destination，则还需要启用 Exclude files from the App_Data folder。 启用此选项可使 Application Insights 扩展保持安全状态。 此步骤是必需的，因为 Application Insights 连续 WebJob 已安装到 App_Data 文件夹中。

如果在部署到应用服务时我的代理位于 Web 代理后面，我应该如何配置我的代理？

如果自托管代理需要 Web 代理，你可以在配置期间向自托管代理告知有关该 Web 代理的信息。 这样，你的代理便可以通过 Web 代理连接到 Azure Pipelines 或 Azure DevOps Server。 详细了解如何运行位于 Web 代理后面的自托管代理。

示例

下面是将 Web 应用程序部署到 Windows 上运行的 Azure Web App 服务的示例 YAML 代码片段。

variables:
  azureSubscription: Contoso
  # 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: samplewebapp
    package: $(System.DefaultWorkingDirectory)/**/*.zip

若要在 Linux 上部署 Web 应用，请添加 appType 参数并将其设置为 appType: webAppLinux。

若要将部署方法指定为 Zip 部署，请添加参数 deploymentMethod: zipDeploy。 此参数支持的另一个值是 runFromPackage。

如果未指定， auto 则为默认值。

要求

要求 说明
管道类型 YAML、经典版本、经典版本
运行平台 Agent、DeploymentGroup
需求 无
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任意
可设置变量 任意
代理版本 2.104.1 或更高版本
任务类别 部署