通过 .NET 开始使用适用于NoSQL 的Azure Cosmos DB

适用范围： NoSQL

本文介绍如何使用 .NET SDK 连接到 Azure Cosmos DB for NoSQL。 连接后，可对数据库、容器和项执行操作。

包 (NuGet) | 示例 | API 参考 | 库源代码 | 反馈

先决条件

• 具有活动订阅的 Azure 帐户。 创建试用版订阅。
• Azure Cosmos DB for NoSQL 帐户。 创建 API for NoSQL 帐户。
• .NET 6.0 或更高版本
• Azure 命令行接口 (CLI) 或 Azure PowerShell

设置项目

通过将 dotnet new 命令与控制台模板一起使用，创建一个新的 .NET 应用程序。

dotnet new console

使用 dotnet add package 命令导入 Microsoft.Azure.Cosmos NuGet 包。

dotnet add package Microsoft.Azure.Cosmos

使用 dotnet build 命令生成项目。

dotnet build

连接到 Azure Cosmos DB for NoSQL

若要连接到 Azure Cosmos DB 的 API for NoSQL，请创建 CosmosClient 类的实例。 此类是针对数据库执行所有操作的起点。

若要使用 Microsoft Entra 连接到 NoSQL 帐户的 API，请使用安全主体。 主体的确切类型将取决于应用程序代码的托管位置。 下表可用作快速参考指南。

导入 Azure.Identity

Azure.Identity NuGet 包包含所有 Azure SDK 库之间共享的核心身份验证功能。

使用 dotnet add package 命令导入 Azure.Identity NuGet 包。

dotnet add package Azure.Identity

使用 dotnet build 命令重新生成项目。

dotnet build

在代码编辑器中，添加 Azure.Core 和 Azure.Identity 命名空间的 using 指令。

using Azure.Core;
using Azure.Identity;

使用默认凭据实现创建 CosmosClient

如果在本地计算机上进行测试，或者应用程序将在 Azure 服务上运行，并直接支持托管标识，则通过创建 DefaultAzureCredential 实例来获取 OAuth 令牌。

在此示例中，我们将实例保存在类型为 TokenCredential 的变量中，因为这是一种可在 SDK 中重复使用的更通用的类型。

// Credential class for testing on a local machine or Azure services
TokenCredential credential = new DefaultAzureCredential();

使用 COSMOS_ENDPOINT 环境变量和 TokenCredential 对象作为参数，创建 CosmosClient 类的新实例。

// New instance of CosmosClient class using a connection string
using CosmosClient client = new(
    accountEndpoint: Environment.GetEnvironmentVariable("COSMOS_ENDPOINT")!,
    tokenCredential: credential
);

使用自定义凭据实现创建 CosmosClient

如果计划在 Azure 之外部署应用程序，则可以通过使用适用于 .NET 的 Azure.Identity 客户端库中的其他类来获取 OAuth 令牌。 这些其他类也派生自 TokenCredential 类。

在此示例中，我们使用客户端和租户标识符以及客户端密码来创建 ClientSecretCredential 实例。

// Custom credential class for servers and clients outside of Azure
TokenCredential credential = new ClientSecretCredential(
    tenantId: Environment.GetEnvironmentVariable("AAD_TENANT_ID")!,
    clientId: Environment.GetEnvironmentVariable("AAD_CLIENT_ID")!,
    clientSecret: Environment.GetEnvironmentVariable("AAD_CLIENT_SECRET")!,
    options: new TokenCredentialOptions()
);

在 Azure Active Directory (AD) 中注册应用程序时，可以获取客户端 ID、租户 ID 和客户端密码。 有关如何注册 Azure AD 应用程序的详细信息，请参阅将应用程序注册到 Microsoft 标识平台。

使用 COSMOS_ENDPOINT 环境变量和 TokenCredential 对象作为参数，创建 CosmosClient 类的新实例。

// New instance of CosmosClient class using a connection string
using CosmosClient client = new(
    accountEndpoint: Environment.GetEnvironmentVariable("COSMOS_ENDPOINT")!,
    tokenCredential: credential
);

生成应用程序

在生成应用程序时，代码主要与四种类型的资源交互：

• API for NoSQL 帐户，它是 Azure Cosmos DB 数据的唯一顶级命名空间。

• 数据库，它用于组织帐户中的容器。

• 容器，它包含数据库中的一组单个项。

• 项，它表示容器中的 JSON 文档。

以下图示显示了这些资源之间的关系。

每种类型的资源由一个或多个关联的 .NET 类表示。 下面列出了最常见的类：

以下指南介绍了如何使用上述每个类来生成应用程序。

请参阅

• 包 (NuGet)
• 示例
• API 参考
• 库源代码
• 提供反馈

后续步骤