将函数应用从 Azure Cosmos DB 扩展版本 3.x 迁移到版本 4.x

.NET 函数使用以 NuGet 包的形式安装在项目中的绑定。 根据 Functions 进程模型，要更新的 NuGet 包会有所不同。

更新 .csproj 项目文件，将最新的扩展版本用于进程模型。 以下 .csproj 文件使用 Azure Cosmos DB 扩展版本 4。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net7.0</TargetFramework>
    <AzureFunctionsVersion>v4</AzureFunctionsVersion>
    <OutputType>Exe</OutputType>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.Azure.Functions.Worker" Version="1.21.0" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.CosmosDB" Version="4.6.0" />
    <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="1.16.4" />
  </ItemGroup>
  <ItemGroup>
    <None Update="host.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
    <None Update="local.settings.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
      <CopyToPublishDirectory>Never</CopyToPublishDirectory>
    </None>
  </ItemGroup>
</Project>

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net7.0</TargetFramework>
    <AzureFunctionsVersion>v4</AzureFunctionsVersion>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Microsoft.Azure.WebJobs.Extensions.CosmosDB" Version="4.3.0" />
    <PackageReference Include="Microsoft.NET.Sdk.Functions" Version="4.1.1" />
  </ItemGroup>
  <ItemGroup>
    <None Update="host.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
    <None Update="local.settings.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
      <CopyToPublishDirectory>Never</CopyToPublishDirectory>
    </None>
  </ItemGroup>
</Project>

默认情况下，非 .NET 函数应用使用扩展捆绑包来安装绑定扩展。 Azure Cosmos DB 版本 4 扩展是 Azure Functions 版本 4 扩展捆绑包的一部分。

若要更新应用程序以使用最新版本的扩展捆绑包，请更新 host.json。 以下 host.json 文件使用 Azure Functions 扩展捆绑包版本 4。

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

进程内和独立进程 C# 库使用 CosmosDBTriggerAttribute 来定义函数。

下表仅包含已重命名或已从版本 3 扩展中删除的特性。 有关版本 4 扩展中可用的特性的完整列表，请访问特性参考。

更新 function.json 文件中的绑定配置属性。

下表仅包含已更改或已从版本 3.x 扩展中删除的特性。 有关版本 4 扩展中可用的特性的完整列表，请访问特性参考。

Azure Functions 扩展版本 4 基于 Azure Cosmos DB .NET SDK 版本 3 构建，该版本删除了对 Document 类的支持。 现在你可以直接接收自己类型的 Document 对象列表，而不是使用每个函数调用接收对象列表，然后必须将其反序列化为自己的对象类型。

此示例引用简单的 ToDoItem 类型。

namespace CosmosDBSamples
{
    // Customize the model with your own desired properties
    public class ToDoItem
    {
        public string id { get; set; }
        public string Description { get; set; }
    }
}

定义函数时，必须直接在代码中更改特性名称。

using System.Collections.Generic;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Host;
using Microsoft.Extensions.Logging;

namespace CosmosDBSamples
{
    public static class CosmosTrigger
    {
        [FunctionName("CosmosTrigger")]
        public static void Run([CosmosDBTrigger(
            databaseName: "databaseName",
            containerName: "containerName",
            Connection = "CosmosDBConnectionSetting",
            LeaseContainerName = "leases",
            CreateLeaseContainerIfNotExists = true)]IReadOnlyList<ToDoItem> input, ILogger log)
        {
            if (input != null && input.Count > 0)
            {
                log.LogInformation("Documents modified " + input.Count);
                log.LogInformation("First document Id " + input[0].id);
            }
        }
    }
}

此外，如果你使用输出绑定，请查看项 ID 生成中的更改，以确认你是否需要进行其他代码更改。

将 host.json 更新为使用正确的扩展捆绑包版本并将 function.json 修改为使用正确的特性名称后，在使用输入绑定或触发器的情况下无需进一步更改代码。 如果你使用输出绑定，请查看项 ID 生成中的更改，以确认你是否需要进行其他代码更改。