使用 Azure 开发人员 CLI 部署到Azure Functions

Azure开发人员 CLI (azd) 支持用于Azure Functions的代码和容器部署。 在 azure.yaml 中将专用 function 主机用于这两种模式:

  • 代码部署 将生成的函数代码打包为 zip 存档,并将其上传到 Function App。
  • 容器部署生成或解析容器映像,在需要时将其发布到Azure 容器注册表(ACR),并更新 Function App 以运行映像。

Azure Functions和Azure 应用服务都使用Microsoft.Web/sites资源提供程序,其容器部署流共享一些内部机制。 但是,它们不是同一 azd 主机。 Functions 使用 host: function,具有特定于 Functions 的打包和远程生成行为,并且不使用应用服务部署槽工作流。

选择部署模式

azd 从服务配置中选择部署模式:

Configuration 部署模式
具有受支持的非 Docker project 且没有 docker.path 的源 language 代码部署
language: docker 容器部署
带有源语言的docker.path值 容器部署
预生成 image 容器部署

预配的 Function App 必须使用与服务配置相同的模式。 如果函数应用已配置为容器,但 azure.yaml 选择代码部署,或反之,azd deploy 会在上传前停止,并报告该不匹配。

部署函数代码

配置基于代码的函数服务,使用源项目、支持的语言和 host: function:

services:
  api:
    project: ./src/api
    language: ts
    host: function

在 azd deploy 期间,azd 生成项目、应用 .funcignore 排除项、创建 zip 存档,并通过 Azure Functions 部署 API 上传包。

Bicep 或 Terraform 必须预配基于代码的函数应用,然后标记它并将 azd-service-name 设置为服务名称,除非您使用 azure.yaml 中的 resourceName 来标识资源。 通过基础设施即代码配置托管计划、运行时、存储、标识、网络和应用程序设置。

为代码部署配置远程构建

顶级服务 remoteBuild 属性仅适用于 Flex Consumption 计划中基于代码的函数应用。 它控制Azure Functions是否使用 Oryx 生成上传的包:

services:
  api:
    project: ./src/api
    language: python
    host: function
    remoteBuild: true

在 Flex Consumption 上省略 remoteBuild 时, azd 根据语言和包内容选择默认值:

语言 默认行为
JavaScript 或 TypeScript 当node_modules排除.funcignore时,或不存在.funcignore文件时,使用远程生成。 否则,请使用本地生成的包。
Python 使用远程构建。
Go 在本地构建。 Go 函数应用不支持远程构建。
其他支持的语言 使用本地生成的包。

对于 JavaScript 和 TypeScript,如果该文件存在,显式配置的 remoteBuild 值必须与 .funcignore 一致。 当.funcignore排除remoteBuild: true时,设置node_modules。 当 .funcignore 在包中包含 node_modules 时,设置 remoteBuild: false。

不要为非 Flex 计划设置顶级 remoteBuild 属性。 若要在另一个受支持的计划上启用 Oryx 生成,请在基础结构中将 ENABLE_ORYX_BUILD=true 和 SCM_DO_BUILD_DURING_DEPLOYMENT=true 配置为 Function App 设置。

部署容器化函数

对于具有 Dockerfile 的源项目,请设置 language: docker或保留源语言并指定 docker.path。

以下示例将 TypeScript 项目与 Dockerfile 配合使用:

services:
  api:
    project: ./src/api
    language: ts
    host: function
    docker:
      path: ./Dockerfile

还可以在没有本地项目的情况下部署预生成映像:

services:
  api:
    host: function
    image: myregistry.azurecr.io/functions/api:1.0

对于预生成的映像,请省略 language 或将其设置为 docker。 不要将 image 和 project 结合。

在容器部署期间, azd:

  1. 本地或远程生成映像,或解析配置的预生成映像。
  2. 需要发布时,将映像发布到为项目配置的 ACR 实例。
  3. 更新 Function App 的linuxFxVersion,将其更改为 DOCKER|<image>。
  4. 部署到主 Function App 站点。

顶级服务 remoteBuild 属性不适用于容器。 若要使用 ACR 任务生成容器映像,请使用 docker.remoteBuild:

services:
  api:
    project: ./src/api
    language: docker
    host: function
    docker:
      path: ./Dockerfile
      remoteBuild: true

预配容器就绪函数应用

azd deploy 更新映像引用,但不会将基于代码的 Function App 转换为基于容器的 Function App。 在部署之前,基础结构必须预配一个兼容的站点。

要求 详细信息
Linux Function App 在Azure Functions高级或专用(应用服务)计划中预配 Linux 函数应用。 Flex Consumption 不支持自定义容器。 此host: function工作流面向Microsoft.Web/sites,而不是托管在 Azure 容器应用 上的 Azure Functions。
容器站点配置 将网站类型设置为包含 functionapp、 linux和 container。 使用 linuxFxVersion 值初始化 DOCKER\|<image>。 占位符图像就够了,因为 azd deploy 会替换它。
容器注册表 对于源版本,请预配 ACR 实例,并通过 AZURE_CONTAINER_REGISTRY_ENDPOINT 基础结构输出公开其登录服务器,或为服务配置 docker.registry。 无需单独的发布注册表即可直接使用完全限定的预生成 image。
注册表访问 授予发布映像的标识相关权限以在需要发布时推送到目标注册表。 单独配置 Function App 以拉取已部署的映像。 对于专用 ACR 映像,请授予 Function App 的托管标识拉取访问权限,并将站点配置为使用托管标识凭据。 对于另一个专用注册表,请在基础结构中配置相应的拉取凭据。
函数设置 通过 Bicep 或 Terraform 配置所需的设置,例如 FUNCTIONS_EXTENSION_VERSION、FUNCTIONS_WORKER_RUNTIME 和 AzureWebJobsStorage。
资源发现 应用一个 azd-service-name 标记,其值与 azure.yaml 中的服务名称匹配,或显式设置 resourceName。

不支持用于env主机的function服务级别设置。 请改为在基础结构中定义 Function App 设置。

了解部署槽位

azd 始终将 function 服务部署到主 Function App 站点。 它不会发现、提示输入或部署到 Function App 槽。 应用服务槽设置,例如 AZD_DEPLOY_{SERVICE}_SLOT_NAME 不会影响 Function App 部署。

如果需要基于槽的 Functions 发布过程,请在内置 host: function 工作流之外管理槽位和部署。

比较 Functions 和 App Service 主机

Functions 和应用服务共享 Microsoft.Web/sites 资源类型,但选择与工作负荷匹配的主机:

Behavior function 主机 appservice 主机
工作量 事件驱动的Azure Functions Web 应用和 API
代码部署 使用 Azure Functions zip 部署流程 使用应用服务部署流
容器部署 验证站点是否基于容器后更新 Function App 映像 验证网站是否为容器就绪后更新 Web 应用映像
远程代码构建 支持弹性消耗函数应用的服务级别 remoteBuild 选项 不要使用 Functions remoteBuild 选项
部署位置 始终部署到主站点 支持 azd 应用服务槽工作流
服务级别 env 不支持;请使用基础结构中的函数应用设置 在基础架构中配置应用设置