大网数据广告活动
Azure 网站与应用

Azure Functions 开发指南

· 52CE 我爱测

了解在 Azure 中开发函数时需要掌握的 Azure Functions 概念和技术,包括各种编程语言和绑定。

在 Azure Functions 中,特定函数共享一些核心技术概念和组件,不受所用语言或绑定限制。 跳转学习某个特定语言或绑定的详细信息之前,请务必通读此通用概述。

本文假定你已阅读 Azure Functions 概述。

函数代码

函数是 Azure Functions 的基本概念。 函数包含两个重要部分,即可以用各种语言编写的代码,以及一些配置,function.json 文件。 对于编译语言,此配置文件是从代码中的注释自动生成的。 对于脚本语言,必须自己提供配置文件。

Function.json 文件定义函数触发器、绑定和其他配置设置。 每个函数有且只有一个触发器。 运行时使用此配置文件确定要监视的事件,以及如何将数据传入函数执行和从函数执行返回数据。 下面是一个示例 function.json 文件。

{
    "disabled":false,
    "bindings":[
        // ... bindings here
        {
            "type": "bindingType",
            "direction": "in",
            "name": "myParamName",
            // ... more depending on binding
        }
    ]
}

有关详细信息,请参阅 Azure Functions 触发器和绑定概念。

在 bindings 属性配置两个触发器和绑定。 每个绑定共享一些通用设置和一些特定于个别类型的绑定的设置。 每个绑定都需要以下设置:

属性 值 类型 注释
类型 绑定的名称。例如,queueTrigger。 string
direction in, out string 表示绑定是用于接收数据到函数中或是从函数发送数据。
name 函数标识符。例如,myQueue。 string 将用于函数中绑定数据的名称。 对于 C#,它将是参数名称;对于 JavaScript,它是键/值列表中的键。

函数应用

函数应用在 Azure 中提供用于运行函数的执行上下文。 因此,它是函数的部署和管理单元。 函数应用由一个或多个共同管理、部署和缩放的独立函数组成。 函数应用中的所有函数共享相同的定价计划、部署方法和运行时版本。 将函数应用视为组织和共同管理函数的一种方法。 若要了解详细信息,请参阅如何管理函数应用。

Note: 函数应用中的所有函数必须使用相同的语言编写。 在 Azure Functions 运行时的先前版本中,这不是必需的。

文件夹结构

特定函数应用中所有函数的代码均位于根项目文件夹中,其中包含主机配置文件和一个或多个子文件夹。 每个子文件夹包含单独函数的代码。 文件夹结构如下图所示:

FunctionApp
 | - host.json
 | - MyFirstFunction
 | | - function.json
 | | - ...  
 | - MySecondFunction
 | | - function.json
 | | - ...  
 | - SharedCode
 | - bin

在 2.x 版及更高版本的 Functions 运行时中,函数应用中的所有函数必须共享同一语言堆栈。

host.json 文件包含特定于运行时的配置,并位于函数应用的根文件夹中。 bin 文件夹包含函数应用所需的包和其他库文件。 查看函数应用项目的语言特定要求:

以上是 Function app 的默认(和推荐)文件夹结构。 如果要更改函数代码的文件位置,请修改 function.json 文件的 scriptFile 部分。 我们还建议使用包部署将项目部署到 Azure 中的函数应用。 也可以使用现有工具,比如持续集成和部署以及 Azure DevOps。

Note: 如果手动部署包,请确保将 host.json 文件和函数文件夹直接部署到 wwwroot 文件夹。 请勿在部署中包含 wwwroot 文件夹。 否则,最后将得到 wwwroot\wwwroot 文件夹。

使用本地工具和发布

可以使用各种工具创作和发布各种函数应用,包括 Visual Studio、Visual Studio Code、IntelliJ、Eclipse 和 Azure Functions Core Tools。 有关详细信息,请参阅在本地对 Azure Functions 进行编码和测试。

如何编辑 Azure 门户中的函数

通过 Azure 门户中内置的函数编辑器可直接内联更新代码和 function.json 文件。 建议仅用于小的更改或概念证明 - 最佳做法是使用 VS Code 等本地开发工具。

并行执行

多个触发事件发生的速度超过了单线程函数运行的处理速度时,运行时可并行多次调用函数。 如果 Function App 正在使用消耗量托管计划,则 Function App 可自动扩大。 无论应用是在消耗量托管计划还是常规应用服务托管计划上运行,每个 Function App 实例都可能使用多个线程并行处理并发函数调用。 每个 Function App 实例中并发函数的最大调用数根据所用触发器类型以及 Function App 中其他函数所用资源而有所不同。

Functions 运行时版本控制

可使用 FUNCTIONS_EXTENSION_VERSION 应用设置配置 Functions 运行时的版本。 例如,值“~3”表示函数应用将使用 3.x 作为其主版本。 函数应用在发布后,将升级到各个新的次要版本。 有关详细信息(包括如何查看函数应用的确切版本),请参阅如何针对 Azure Functions 运行时版本。

存储库

Azure Functions 代码为开放源,位于 GitHub 存储库:

绑定

下面是所有受支持的绑定表。

下表显示了 Azure Functions 运行时的主版本支持的绑定:

类型 1.x 2.x 及更高版本<sup>1</sup> 触发器 输入 输出
Blob 存储 ✔ ✔ ✔ ✔ ✔
Azure Cosmos DB ✔ ✔ ✔ ✔ ✔
Dapr<sup>3</sup> ✔ ✔ ✔ ✔
事件网格 ✔ ✔ ✔ ✔
事件中心 ✔ ✔ ✔ ✔
HTTP 和 Webhook ✔ ✔ ✔ ✔
IoT 中心 ✔ ✔ ✔ ✔
Kafka<sup>2</sup> ✔ ✔ ✔
移动应用 ✔ ✔ ✔
通知中心 ✔ ✔
队列存储 ✔ ✔ ✔ ✔
RabbitMQ<sup>2</sup> ✔ ✔ ✔
SendGrid ✔ ✔ ✔
服务总线 ✔ ✔ ✔ ✔
SignalR ✔ ✔ ✔
表存储 ✔ ✔ ✔ ✔
计时器 ✔ ✔ ✔
Twilio ✔ ✔ ✔

<sup>1</sup> 从版本 2.x 运行时开始,除了 HTTP 和 Timer 以外,所有绑定都必须注册。 请参阅注册绑定扩展。

<sup>2</sup> 消耗计划中不支持触发器。 需要运行时驱动的触发器。

<sup>3</sup> 仅支持 Kubernetes、IoT Edge 和其他自托管模式。

对来自绑定的错误怀有疑问? 请查看 Azure Functions 绑定错误代码文档。

连接

函数项目通过名称从其配置提供程序引用连接信息。 它不直接接受连接详细信息,从而允许跨环境更改它们。 例如,触发器定义可能包括 connection 属性。 这可能引用连接字符串,但不能直接在中设置连接字符串 function.json 。 相反,应将设置 connection 为包含连接字符串的环境变量的名称。

默认配置提供程序使用环境变量。 在 Azure Functions 服务中运行时,或在本地开发时, 应用程序设置可能会设置这些设置。

连接值

当连接名称解析为单个精确值时,运行时将值标识为 连接字符串,通常包括一个机密。 连接字符串的详细信息由你要连接到的服务定义。

不过,连接名称还可以引用多个配置项目的集合。 可以通过使用以双下划线结尾的共享前缀将环境变量视为集合 __ 。 然后,可以通过将连接名称设置为此前缀来引用该组。

例如, connection Azure Blob 触发器定义的属性可能是 Storage1 。 只要没有配置单个字符串值 Storage1 作为其名称,就会将用于 Storage1__serviceUri 连接的 serviceUri 属性。 每个服务的连接属性都是不同的。 请参阅使用连接的扩展的文档。

配置基于标识的连接

Azure Functions 中的某些连接配置为使用标识而不是机密。 支持取决于使用连接的扩展。 在某些情况下,即使连接到的服务支持基于标识的连接,函数中仍可能需要连接字符串。

Important: 即使绑定扩展支持基于标识的连接,也可能不支持在消耗计划中使用该配置。 请参阅下表中的支持表。

以下触发器和绑定扩展支持基于标识的连接:

扩展名称 扩展版本 在消耗计划中支持基于标识的连接
Azure Blob 版本 5.0.0-beta1 或更高版本 否
Azure 队列 版本 5.0.0-beta1 或更高版本 否

Note: 对于用于核心行为的函数运行时所使用的存储连接,尚不支持基于标识的连接。 这意味着 AzureWebJobsStorage 设置必须为连接字符串。

连接属性

Azure 服务的基于标识的连接接受以下属性:

properties 环境变量 是否必需 说明
服务 URI <CONNECTION_NAME_PREFIX>__serviceUri 是 要连接到的服务的数据平面 URI。

给定的连接类型可能支持其他选项。 请参阅建立连接的组件的文档。

在 Azure Functions 服务中托管时,基于标识的连接将使用 托管标识。 默认情况下,使用系统分配的标识。 当在其他上下文(如本地开发)中运行时,将使用开发人员标识,尽管可以使用替代连接参数对其进行自定义。

本地开发

在本地运行时,上述配置会告知运行时使用你的本地开发人员标识。 连接将尝试从以下位置获取令牌,顺序如下:

  • Microsoft 应用程序之间共享的本地缓存
  • Visual Studio 中的当前用户上下文
  • Visual Studio Code 中的当前用户上下文
  • Azure CLI 中的当前用户上下文

如果这些选项都不成功,则会出现错误。

在某些情况下,你可能希望指定使用不同的标识。 你可以添加指向备用标识的连接的配置属性。

Note: 在 Azure Functions 服务中托管时,不支持以下配置选项。

若要使用具有客户端 ID 和机密的 Azure Active Directory 服务主体进行连接,请使用以下属性定义连接:

properties 环境变量 是否必需 说明
服务 URI <CONNECTION_NAME_PREFIX>__serviceUri 是 要连接到的服务的数据平面 URI。
租户 ID <CONNECTION_NAME_PREFIX>__tenantId 是 Azure Active Directory 租户 (目录) ID。
客户端 ID <CONNECTION_NAME_PREFIX>__clientId 是 客户端 (应用程序在租户中注册的应用) ID。
客户端机密 <CONNECTION_NAME_PREFIX>__clientSecret 是 为应用注册生成的客户端密码。
向标识授予权限

无论使用何种标识,都必须具有执行所需操作的权限。 这通常是通过在 Azure RBAC 中分配角色或在访问策略中指定标识来完成的,具体取决于要连接到的服务。 请参阅每个服务的相关文档,了解需要哪些权限以及如何设置这些权限。

Important: 某些权限可能由不是所有上下文都需要的服务公开。 如果可能,请遵守 最低权限原则,仅授予标识所需的权限。 例如,如果应用只需从 blob 读取数据,请使用 存储 Blob 数据读取器 角色,因为 存储 blob 数据所有者 包含对读取操作的过多权限。

报告问题

Item 说明 链接
运行时 脚本主机、触发器和绑定及语言支持 提出问题
模板 创建模板的代码问题 提出问题
门户 用户界面或体验问题 提出问题

后续步骤

有关详细信息,请参阅以下资源:

历史资料。此文对应 2022-08-12 的中文文档快照,适用产品版本和命令行为以原文为准。

来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。

资料来源与适用范围

资料来源
Microsoft / Azure 中文运维文档历史快照
适用范围
历史中文快照 2022-08-12;详见原文产品版本;文档日期 10/12/2017
内容语言
中文;命令、路径和错误标识保留技术原文
本地收录日期
2026-11-16
授权说明
CC BY 4.0(文档)/ MIT(示例代码)

正文与所需资源由本站本地存储。查看来源及更新记录 ↗

请按适用版本和实际日志确认原因;本站没有对每一种系统或设备逐项执行文中的操作。