注册 Azure Functions 绑定扩展

Azure Functions 支持 HTTP 和现成的计时器。 若要使用其他服务,你需要安装或注册绑定扩展。 绑定扩展是通过 Azure Core Tools 或 NuGet 程序包提供的。

下表指明了何时以及如何注册绑定。

开发环境 注册
Functions 1.x 中注册
注册
Functions 2.x 中注册
Azure 门户 自动 自动,带有提示
非 .NET 语言或本地 Azure Core Tools 开发 自动 使用 Core Tools CLI 命令
使用 Visual Studio 2017 的 C# 类库 使用 NuGet 工具 使用 NuGet 工具
使用 Visual Studio Code 的 C# 类库 不适用 使用 .NET Core CLI

以下绑定类型例外,它们不需要显式注册,因为它们会在所有版本和环境中自动注册:HTTP 和计时器。

Important

本文的其余内容仅适用于 Functions 2.x。 在 Functions 1.x 中,除了使用 Visual Studio 2017 创建 C# 类库时,绑定扩展不是显式注册的。

使用 Azure 门户进行开发

创建函数或添加绑定时,如果触发器或绑定的扩展需要注册,则系统会显示提示。 单击“安装”注册扩展,以响应提示。

对于给定的函数应用,只需安装每个扩展一次。 对于门户中不可用的受支持绑定或要更新已安装的扩展,还可以从门户手动安装或更新 Azure Functions 绑定扩展

使用 Azure Functions Core Tools 进行本地开发

在本地开发函数时,可以使用 Azure Functions Core Tools 从终端或从命令提示符安装所需的扩展。

更新 function.json 文件以包含函数所需的所有绑定后,请在项目文件夹中运行以下命令。

func extensions install

该命令读取 function.json 文件以了解所需的程序包,安装这些包并重新生成扩展项目。 它在当前版本中添加任何新绑定,但不更新现有绑定。 使用 --force 选项可在安装新版本时将现有绑定更新为最新版本。

如要安装特定版本的包或要在编辑 function.json 文件之前安装包,请对包名称使用 func extensions install 命令,如下例所示:

func extensions install --package Microsoft.Azure.WebJobs.ServiceBus --version <target_version>

<target_version> 替换为特定包版本,例如 3.0.0-beta5。 在 NuGet.org 上的单个包页上列出了有效版本。

使用 Visual Studio 2017 的 C# 类库

在“Visual Studio 2017”中,可使用 Install-Package 命令从包管理器控制台安装包,如以下示例所示:

Install-Package Microsoft.Azure.WebJobs.Extensions.ServiceBus -Version <target_version>

用于给定绑定的包的名称在该绑定的参考文章中提供。 有关示例,请参阅服务总线绑定参考文章的“包”部分

将示例中的 <target_version> 替换为特定包版本,例如 3.0.0-beta5。 在 NuGet.org 上的单个包页上列出了有效版本。与 Functions 运行时 1.x 或 2.x 对应的主版本在绑定的参考文章中指定。

使用 Visual Studio Code 的 C# 类库

在“Visual Studio Code”中,可在 .NET Core CLI 中,通过命令提示符使用 dotnet add package 命令来安装包,如以下示例所示:

dotnet add package Microsoft.Azure.WebJobs.Extensions.ServiceBus --version <target_version>

.NET Core CLI 只能用于 Azure Functions 2.x 开发。

用于给定绑定的包的名称在该绑定的参考文章中提供。 有关示例,请参阅服务总线绑定参考文章的“包”部分

将示例中的 <target_version> 替换为特定包版本,例如 3.0.0-beta5。 在 NuGet.org 上的单个包页上列出了有效版本。与 Functions 运行时 1.x 或 2.x 对应的主版本在绑定的参考文章中指定。

后续步骤