你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

CosmosClient 类

定义

命名空间:

Microsoft.Azure.Cosmos

程序集:

Microsoft.Azure.Cosmos.Client.dll

包:

Microsoft.Azure.Cosmos v3.39.0

Source:

CosmosClient.cs

提供 Azure Cosmos DB 帐户的客户端逻辑表示形式。 此客户端可用于在 Azure Cosmos DB 数据库服务中配置和执行请求。

CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。

public class CosmosClient : IDisposable

type CosmosClient = class
    interface IDisposable

Public Class CosmosClient
Implements IDisposable

继承

Object

CosmosClient

实现

IDisposable

示例

此示例创建 CosmosClient、 Database和 Container。 CosmosClient 是使用 连接字符串创建的，并配置为使用“美国东部 2”区域。

using Microsoft.Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "connection-string-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

Database db = await cosmosClient.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

此示例创建 CosmosClient、 Database和 Container。 CosmosClient 是使用 AccountEndpoint、AccountKey 或 ResourceToken 创建的，并配置为使用“美国东部 2”区域。

using Microsoft.Azure.Cosmos;

CosmosClient cosmosClient = new CosmosClient(
            "account-endpoint-from-portal", 
            "account-key-from-portal", 
            new CosmosClientOptions()
            {
                ApplicationRegion = Regions.EastUS2,
            });

Database db = await cosmosClient.CreateDatabaseAsync("database-id");
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

此示例创建 CosmosClient、 Database和 Container。 CosmosClient 是使用 CosmosClientBuilder通过生成器模式创建的。

using Microsoft.Azure.Cosmos;
using Microsoft.Azure.Cosmos.Fluent;

CosmosClient cosmosClient = new CosmosClientBuilder("connection-string-from-portal")
    .WithApplicationRegion("East US 2")
    .Build();

Database db = await cosmosClient.CreateDatabaseAsync("database-id")
Container container = await db.CreateContainerAsync("container-id");

// Dispose cosmosClient at application exit

注解

返回的未初始化引用不能保证凭据或连接验证，因为创建不会进行任何网络调用

构造函数

CosmosClient()	创建用于模拟测试的新 CosmosClient
CosmosClient(String, AzureKeyCredential, CosmosClientOptions)	使用帐户终结点 URI 字符串和 AzureKeyCredential 创建新的 CosmosClient。 AzureKeyCredential 允许在 CosmosClient 仍在使用时更改/更新 master-key/ResourceToken。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。
CosmosClient(String, CosmosClientOptions)	使用 连接字符串创建新的 CosmosClient。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。
CosmosClient(String, String, CosmosClientOptions)	使用帐户终结点 URI 字符串和帐户密钥创建新的 CosmosClient。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。
CosmosClient(String, TokenCredential, CosmosClientOptions)	使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。

属性

ClientOptions	CosmosClientOptions使用的 初始化 CosmosClient。
Endpoint	获取 Azure Cosmos DB 服务的终结点 URI。
ResponseFactory	用于创建 CosmosClient 响应类型的响应工厂。

方法

CreateAndInitializeAsync(String, AzureKeyCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	使用帐户终结点 URI 字符串和 AzureKeyCredential 创建新的 CosmosClient。 AzureKeyCredential 允许在 CosmosClient 仍在使用时更改/更新 master-key/ResourceToken。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。
CreateAndInitializeAsync(String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。
CreateAndInitializeAsync(String, String, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。
CreateAndInitializeAsync(String, TokenCredential, IReadOnlyList<ValueTuple<String,String>>, CosmosClientOptions, CancellationToken)	使用帐户终结点 URI 字符串和 TokenCredential 创建新的 CosmosClient。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生命周期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。
CreateDatabaseAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)	发送创建数据库的请求。 数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。 每个数据库由一个或多个容器组成，每个容器又包含一个或多个文档。 由于数据库是一种管理资源，因此需要使用服务主密钥才能使用用户 API 访问并成功完成任何操作。
CreateDatabaseAsync(String, ThroughputProperties, RequestOptions, CancellationToken)	发送创建数据库的请求。 数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。 每个数据库由一个或多个容器组成，每个容器又包含一个或多个文档。 由于数据库是一种管理资源，因此需要使用服务主密钥才能使用用户 API 访问并成功完成任何操作。
CreateDatabaseIfNotExistsAsync(String, Nullable<Int32>, RequestOptions, CancellationToken)	检查数据库是否存在，如果不存在，请创建它。 仅使用数据库 ID 来验证是否存在现有数据库。 其他数据库属性（如吞吐量）未验证，可能不同于传递的属性。 数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。 每个数据库由一个或多个容器组成，每个容器又包含一个或多个文档。 由于数据库是一种管理资源，因此需要使用服务主密钥才能使用用户 API 访问并成功完成任何操作。
CreateDatabaseIfNotExistsAsync(String, ThroughputProperties, RequestOptions, CancellationToken)	检查数据库是否存在，如果不存在，请创建它。 仅使用数据库 ID 来验证是否存在现有数据库。 其他数据库属性（如吞吐量）未验证，可能不同于传递的属性。 数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。 每个数据库由一个或多个容器组成，每个容器又包含一个或多个文档。 由于数据库是一种管理资源，因此需要使用服务主密钥才能使用用户 API 访问并成功完成任何操作。
CreateDatabaseStreamAsync(DatabaseProperties, Nullable<Int32>, RequestOptions, CancellationToken)	发送创建数据库的请求。 数据库管理用户、权限和一组容器。 每个 Azure Cosmos DB 数据库帐户都能够支持多个独立的命名数据库，数据库是数据的逻辑容器。 每个数据库由一个或多个容器组成，每个容器又包含一个或多个文档。 由于数据库是一种管理资源，因此需要使用服务主密钥才能使用用户 API 访问并成功完成任何操作。
Dispose()	释放 cosmos 客户端
Dispose(Boolean)	释放 cosmos 客户端
GetContainer(String, String)	返回对容器的代理引用。
GetDatabase(String)	返回对数据库的代理引用。
GetDatabaseQueryIterator<T>(QueryDefinition, String, QueryRequestOptions)	此方法使用具有参数化值的 SQL 语句为 Cosmos DB 帐户下的数据库创建查询。 它返回 FeedIterator。 有关使用参数化值准备 SQL 语句的详细信息，请参阅 QueryDefinition。
GetDatabaseQueryIterator<T>(String, String, QueryRequestOptions)	此方法使用 SQL 语句为 Cosmos DB 帐户下的数据库创建查询。 它返回 FeedIterator。
GetDatabaseQueryStreamIterator(QueryDefinition, String, QueryRequestOptions)	此方法使用具有参数化值的 SQL 语句为 Cosmos DB 帐户下的数据库创建查询。 它返回 FeedIterator。 有关使用参数化值准备 SQL 语句的详细信息，请参阅 QueryDefinition。
GetDatabaseQueryStreamIterator(String, String, QueryRequestOptions)	此方法使用 SQL 语句为 Cosmos DB 帐户下的数据库创建查询。 它返回 FeedIterator。
ReadAccountAsync()	AccountProperties读取 Azure Cosmos DB 帐户的 。

另请参阅

• CosmosClientBuilder
• CosmosClientOptions