如何通过C# Azure HTTP Trigger函数删除CosmosDB的单个数据项

你之前使用的IAsyncCollector属于Azure Functions的输出绑定，设计上仅支持写入（新增、更新）操作，没有对应删除的方法，要实现单条数据删除需要直接操作Cosmos DB的客户端实例，两种常用实现方案如下：

方案1：使用Cosmos DB输入绑定复用内置客户端（推荐） #

该方案无需手动初始化Cosmos客户端，复用Functions运行时维护的单例客户端，性能开销更低，适配绝大多数场景。

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.Documents;
using Microsoft.Azure.Documents.Client;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Extensions.Logging;
using System;
using System.Net;
using System.Threading.Tasks;

[FunctionName("DeleteCosmosItem")]
public static async Task<IActionResult> Run(
    // 配置HTTP Trigger仅接受DELETE请求，路由携带待删除条目ID
    [HttpTrigger(AuthorizationLevel.Function, "delete", Route = "items/{id}")] HttpRequest req,
    // Cosmos DB输入绑定，自动注入DocumentClient实例
    [CosmosDB(
        databaseName: "替换为你的数据库名",
        containerName: "替换为你的容器名",
        Connection = "CosmosDBConnectionString")] DocumentClient client,
    string id,
    ILogger log)
{
    log.LogInformation($"发起ID为 {id} 的条目删除请求");
    try
    {
        // *特别注意：Cosmos DB删除操作必须同时提供文档ID和分区键值
        // 如果你使用的分区键不是/id，请将下方PartitionKey参数替换为对应分区键的值
        await client.DeleteDocumentAsync(
            UriFactory.CreateDocumentUri("替换为你的数据库名", "替换为你的容器名", id),
            new RequestOptions { PartitionKey = new PartitionKey(id) });
        
        return new OkResult();
    }
    catch (DocumentClientException ex) when (ex.StatusCode == HttpStatusCode.NotFound)
    {
        // 待删除条目不存在的情况处理
        return new NotFoundResult();
    }
    catch (Exception ex)
    {
        log.LogError(ex, "删除条目发生异常");
        return new StatusCodeResult(StatusCodes.Status500InternalServerError);
    }
}

你需要提前在配置文件中添加对应配置：

• 本地开发时在local.settings.json的Values节点添加"CosmosDBConnectionString": "你的Cosmos DB连接字符串"
• 云端部署时在Azure Functions应用的「配置」-「应用程序设置」中添加同名配置项

方案2：手动初始化Cosmos SDK客户端 #

如果你的场景不适合使用绑定，可以直接引用Microsoft.Azure.Cosmos NuGet包，自行维护客户端实例：

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.Cosmos;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.Extensions.Logging;
using System;
using System.Net;
using System.Threading.Tasks;

// 全局静态客户端，避免重复初始化导致的连接耗尽问题
private static readonly CosmosClient _cosmosClient = new CosmosClient(Environment.GetEnvironmentVariable("CosmosDBConnectionString"));

[FunctionName("DeleteCosmosItem")]
public static async Task<IActionResult> Run(
    [HttpTrigger(AuthorizationLevel.Function, "delete", Route = "items/{id}")] HttpRequest req,
    string id,
    ILogger log)
{
    try
    {
        var container = _cosmosClient.GetContainer("替换为你的数据库名", "替换为你的容器名");
        // 同样注意替换为实际的分区键值
        await container.DeleteItemAsync<object>(id, new PartitionKey(id));
        return new OkResult();
    }
    catch (CosmosException ex) when (ex.StatusCode == HttpStatusCode.NotFound)
    {
        return new NotFoundResult();
    }
    catch (Exception ex)
    {
        log.LogError(ex, "删除失败");
        return new StatusCodeResult(500);
    }
}

Blazor端调用示例 #

在你的Blazor应用中直接发起DELETE请求即可触发删除操作：

await Http.DeleteAsync($"api/items/{待删除条目的ID}");

内容的提问来源于stack exchange，提问作者Matt Ingham