AzureFunctionApp@2 - Azure Functions部署 v2 任务

使用 .NET、Python、JavaScript、PowerShell、基于 Java 的 Web 应用程序更新函数应用。

语法

# Azure Functions Deploy v2
# Update a function app with .NET, Python, JavaScript, PowerShell, Java based web applications.
- task: AzureFunctionApp@2
  inputs:
    connectedServiceNameARM: # string. Alias: azureSubscription. Required. Azure Resource Manager connection. 
    appType: # 'functionApp' | 'functionAppLinux'. Required. App type. 
    appName: # string. Required. Azure Functions 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: # 'DOTNET|6.0' | 'DOTNET-ISOLATED|6.0' | 'DOTNET-ISOLATED|7.0' | 'DOTNET-ISOLATED|8.0' | 'JAVA|8' | 'JAVA|11' | 'JAVA|17' | 'JAVA|21' | 'NODE|14' | 'NODE|16' | 'NODE|18' | 'NODE|20' | 'PYTHON|3.8' | 'PYTHON|3.9' | 'PYTHON|3.10' | 'PYTHON|3.11'. Optional. Use when appType = functionAppLinux. Runtime stack. 
  # Application and Configuration Settings
    #appSettings: # string. App settings. 
  # Additional Deployment Options
    #deploymentMethod: 'auto' # 'auto' | 'zipDeploy' | 'runFromPackage'. Required when appType != "" && package NotEndsWith .war && Package NotEndsWith .jar. Deployment method. Default: auto.

输入

connectedServiceNameARM - Azure 资源管理器连接
输入别名： azureSubscription。 string. 必需。

选择用于部署的 Azure 资源管理器 订阅。

appType - 应用类型
string. 必需。 允许的值： functionApp Windows) 上的 (Function App， functionAppLinux (Linux) 上的 Function App。

选择用于部署的 Azure 函数应用类型。

appName - Azure Functions 应用名称
string. 必需。

指定现有Azure Functions应用的名称。 列出的函数应用将基于所选应用类型。

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

部署到现有部署槽位或Azure 应用服务环境。 对于这两个目标，任务都需要资源组名称。

如果部署目标是槽，则默认为 生产 槽。 也可以提供任何其他现有槽名称。

如果部署目标是Azure 应用服务环境，请将槽名称保留为“生产”并指定资源组名称。

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

当部署目标为部署槽位或应用服务环境时，资源组名称是必需的。

输入或选择包含上面指定的Azure 应用服务的 Azure 资源组。

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

输入或选择现有槽，不包括生产槽。

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

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

runtimeStack - 运行时堆栈
string. 可选。 在 时 appType = functionAppLinux使用 。 允许的值：DOTNET|6.0、DOTNET-ISOLATED|6.0、、DOTNET-ISOLATED|7.0、DOTNET-ISOLATED|8.0、JAVA|8JAVA|11、JAVA|17JAVA|21、NODE|18NODE|20NODE|14NODE|16、、PYTHON|3.8、、PYTHON|3.9、PYTHON|3.10、 。 PYTHON|3.11

指定运行函数应用的框架和版本。 可以使用任何 受支持的运行时版本。 旧值（如 ） DOCKER|microsoft/azure-functions-* 已弃用。 新值列在任务助手的下拉列表中。 如果 支持的运行时 版本中有较新版本的框架可用，则可以指定它，即使它不在列表中也是如此。

appSettings - 应用设置
string.

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

deploymentMethod - 部署方法
string. 当 appType != "" && package NotEndsWith .war && Package NotEndsWith .jar 时，需要此选项。 允许的值： auto (Auto-detect) 、 zipDeploy (Zip Deploy) 、 runFromPackage (Zip Deploy with Run From Package) 。 默认值：auto。

指定应用的 部署方法 。 Linux 消耗应用不支持此配置。

任务控制选项

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

输出变量

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

AppServiceApplicationUrl
所选 Azure 函数应用的应用程序 URL。

注解

Azure 函数部署任务用于更新Azure Functions，以便将 Functions 部署到 Azure。 该任务适用于运行 Windows、Linux 或 Mac 的跨平台 Azure Pipelines 代理，并使用 RunFromPackage、Zip 部署和 Kudu REST API 的基础部署技术。

该任务适用于Azure Functions支持的语言。

任务的先决条件

需要在目标计算机中设置以下先决条件， () 才能使任务正常工作。

Azure 函数

该任务用于将Azure Functions项目部署到现有 Azure 函数。 运行任务之前，应存在 Azure 函数应用。 可以从 Azure 门户创建 Azure 函数应用。 或者，可以使用Azure PowerShell任务来运行 AzureRM PowerShell 脚本来预配和配置 Azure 函数应用。

该任务可用于 (Windows/Linux ) 部署Azure Functions。

Azure 订阅

若要部署到 Azure，必须使用“帐户管理”部分中的“服务”选项卡将 Azure 订阅链接到 Azure Pipelines。 通过打开屏幕右上角的“帐户管理”屏幕 (齿轮图标，然后单击“服务”选项卡，添加在“生成) 或Release Management”定义中使用的 Azure 订阅。

Create ARM 服务终结点并使用 Azure 资源管理器终结点类型。 有关更多详细信息，请按照 此处链接中列出的步骤操作。

该任务不适用于 Azure 经典服务终结点，并且不会在任务的参数中列出这些连接。

部署方法

在此任务中可以使用多种部署方法。

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

根据 Azure 应用服务 和 Azure Pipelines 代理的类型，该任务使用合适的部署技术。 任务使用的部署技术如下所示：

• Kudu REST API
• Zip 部署
• 从程序包运行

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

• 如果提供了部署后脚本，请使用 Zip 部署。
• 如果App 服务类型是 Linux 上的 Web 应用，请使用 Zip 部署。
• 如果提供了 .war 文件，请使用 War Deploy。
• 如果提供了.jar文件，请使用 Run-From-Zip。
• 对于所有其他任务，请使用通过 Zip 部署) 从包 (运行。

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

Kudu REST API

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

Zip 部署

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

从包运行

从包运行将创建与 Zip 部署相同的部署包。 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. 清除“在存档路径前面附加根文件夹名称”复选框：

      

Windows 上的函数应用部署成功，但应用不起作用

如果应用中不存在 web.config 文件，则可能会出现此问题。 可以将 web.config 文件添加到源，也可以使用任务的 “应用程序和配置设置” 自动生成一个文件。

1. 选择任务，然后转到 为 Python、Node.js、Go 和 Java 应用生成 web.config 参数：

   

2. 选择“为 Python、Node.js、 Go 和 Java 应用生成 web.config 参数 ”下的“更多”按钮 (...) 以编辑参数：

   

3. 在“应用程序 框架 ”列表中选择应用程序类型。

4. 选择“确定” 。 这样做将填充生成 web.config 文件所需的 web.config 参数。

常见问题

如何配置我的服务连接？

此任务需要 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 代理后面的自托管代理。

无法使用 Azure 资源管理器 服务连接和 Microsoft 托管代理部署到内部应用服务环境

根据设计，Microsoft 托管的代理不适用于应用服务环境。 相反，需要在与应用服务环境位于同一虚拟网络中的虚拟机上配置专用代理。 此外，设置专用 DNS 区域以启用资源之间的通信。

示例

下面是在 Windows 上部署 Azure 函数的示例 YAML 代码片段：

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

steps:
- task: AzureFunctionApp@2
  displayName: Azure Function App Deploy
  inputs:
    azureSubscription: $(azureSubscription)
    appName: samplefunctionapp
    appType: functionApp
    package: $(System.DefaultWorkingDirectory)/**/*.zip

若要在 Linux 上部署函数，请添加 appType 参数并将其设置为 appType: functionAppLinux。 如果未指定值，则 functionApp 是默认值。

若要将部署方法显式指定为 Zip 部署，请添加 参数 deploymentMethod: zipDeploy。 此参数支持的另一个值是 runFromPackage。 如果未指定值，则 auto 是默认值。

有关演示如何创建 CI/CD 管道的演练，请参阅生成 Java 并将其部署到Azure Functions。

要求

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