适用于 Azure Functions 2.x 及更高版本的 Azure Cosmos DB 触发器和绑定概述

函数在独立的 C# 工作进程中执行。 若要了解详细信息，请参阅有关在独立工作进程中运行 C# Azure Functions 的指南。

函数在与函数主机相同的进程中执行。 若要了解详细信息，请参阅使用 Azure Functions 开发 C# 类库函数。

在此模型的变体中，可以使用 C# 脚本运行 Functions，该脚本主要用于 C# 门户编辑。 若要更新在门户中运行的 C# 脚本应用程序的现有绑定扩展，而无需重新发布函数应用，请参阅更新扩展。

本节介绍如何使用类库。 对于 C# 脚本，需要改为安装扩展捆绑包版本 4.x。

此版 Azure Cosmos DB 绑定扩展引入了使用标识而不是机密进行连接的功能。 有关使用托管标识配置函数应用的教程，请参阅使用基于标识的连接创建函数应用教程。

此版本还会更改你可绑定到的类型，并将 v2 SDK Microsoft.Azure.DocumentDB 中的类型替换为 v3 SDK Microsoft.Azure.Cosmos 中更新的类型。 通过 SDK 迁移指南、触发器、输入绑定和输出绑定示例，详细了解这些新类型在哪些方面有变化以及如何迁移到这些新类型。

此扩展版本以 NuGet 包 4.x 版的形式提供。

本节介绍如何使用类库。 对于 C# 脚本，需要改为安装扩展捆绑包版本 2.x 或 3.x。

使用触发器和绑定需要引用相应的 NuGet 包。 安装 NuGet 包版本 3.x。

此版 Azure Cosmos DB 绑定扩展引入了使用标识而不是机密进行连接的功能。 有关使用托管标识配置函数应用的教程，请参阅使用基于标识的连接创建函数应用教程。

通过安装 NuGet 包 4.x 版将扩展添加到项目。

如果要使用 F# 编写应用程序，则还必须将此扩展配置为应用的启动配置的一部分。 在对 ConfigureFunctionsWorkerDefaults() 或 ConfigureFunctionsWebApplication() 的调用中，添加接受 IFunctionsWorkerApplication 参数的委托。 然后在该委托的正文中，在对象上调用 ConfigureCosmosDBExtension()：

let hostBuilder = new HostBuilder()
hostBuilder.ConfigureFunctionsWorkerDefaults(fun (context: HostBuilderContext) (appBuilder: IFunctionsWorkerApplicationBuilder) ->
    appBuilder.ConfigureCosmosDBExtension() |> ignore
) |> ignore

通过安装 NuGet 包版本 3.x 将扩展添加到项目。

这个版本的捆绑包包含 Azure Cosmos DB 绑定扩展 4.x 版，该扩展引入了使用标识而不是机密进行连接的功能。 有关使用托管标识配置函数应用的教程，请参阅使用基于标识的连接创建函数应用教程。

可以通过在 host.json 文件中添加或替换以下代码，从预览版扩展捆绑包 v4 添加此扩展版本：

{
  "version": "2.0",
  "extensionBundle": {
    "id": "Microsoft.Azure.Functions.ExtensionBundle.Preview",
    "version": "[4.0.0, 5.0.0)"
  }
}

若要了解详细信息，请参阅更新扩展。

可以通过注册扩展捆绑包版本 2.x 或 3.x 在函数应用中安装此版本的扩展。

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[3.3.0, 4.0.0)"
    }
}

独立工作进程类库的已编译 C# 函数在独立于运行时的进程中运行。

进程内类库是编译的 C# 函数，该函数在与 Functions 运行时相同的进程中运行。

Azure Cosmos DB 扩展支持下表所示的参数类型。

¹ 包含 JSON 数据的文档可以反序列化为已知的普通旧 CLR 对象 (POCO) 类型。

早期版本的扩展公开了现已弃用的 Microsoft.Azure.Documents 命名空间中的类型。 Microsoft.Azure.Cosmos 中的较新类型专用于扩展 4.x 及更高版本。

独立工作进程支持下表所示的参数类型。 支持在预览中绑定到 Microsoft.Azure.Cosmos 中的类型。

Cosmos DB 触发器

如果你希望函数处理单个文档，可将 Cosmos DB 触发器绑定到以下类型：

如果你希望函数处理一批文档，可将 Cosmos DB 触发器绑定到以下类型：

Cosmos DB 输入绑定

如果你希望函数处理单个文档，可将 Cosmos DB 输入绑定绑到以下类型：

如果你希望函数处理查询中的多个文档，可将 Cosmos DB 输入绑定绑到以下类型：

¹ 若要使用这些类型，需要引用 Microsoft.Azure.Functions.Worker.Extensions.CosmosDB 4.3.1-preview1 或更高版本以及 SDK 类型绑定的常见依赖项。

Cosmos DB 输出绑定

如果希望函数写入单个文档，Cosmos DB 输出绑定可以绑定到以下类型：

如果希望函数写入多个文档，Cosmos DB 输出绑定可以绑定到以下类型：

对于其他输出方案，请直接从 Microsoft.Azure.Cosmos 创建和使用类型。

独立工作进程中早期版本的扩展仅支持绑定到可 JSON 序列化类型。 扩展 4.x 及更高版本可以使用其他选项。