你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
CosmosClientBuilder 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
这是一个 Builder 类，用于创建 cosmos 客户端
public class CosmosClientBuildertype CosmosClientBuilder = classPublic Class CosmosClientBuilder- 继承
-
CosmosClientBuilder
构造函数
| CosmosClientBuilder(String) |
从连接字符串中提取帐户终结点和密钥。 |
| CosmosClientBuilder(String, AzureKeyCredential) |
初始化一个新的 CosmosConfiguration 类，该类使用帐户终结点 URI 字符串和 AzureKeyCredential 保存 CosmosClient 所需的所有属性。 AzureKeyCredential 允许在 CosmosClient 仍在使用时更改/更新 master-key/ResourceToken。 |
| CosmosClientBuilder(String, String) |
初始化一个新的 CosmosConfiguration 类，该类保存 CosmosClient 所需的所有属性。 |
| CosmosClientBuilder(String, TokenCredential) |
使用 TokenCredential 实例初始化新的 CosmosClientBuilder 。 |
方法
| AddCustomHandlers(RequestHandler[]) |
将自定义处理程序数组设置为请求。 处理程序将按列出的顺序进行链接。 InvokerHandler.InnerHandler 需要为 null 才能允许管道链接处理程序。 |
| Build() |
创建 cosmos 客户端 CosmosClient 的方法是线程安全的。 建议在应用程序的生存期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。 |
| BuildAndInitializeAsync(IReadOnlyList<ValueTuple<String,String>>, CancellationToken) |
用于创建 cosmos 客户端并初始化提供的容器的方法。 此外，它还使用提供的容器初始化客户端，即 SDK 在首次调用服务之前预热缓存和连接。 使用它在应用程序启动时获得较低的延迟。 CosmosClient 是线程安全的。 建议在应用程序的生存期内维护 CosmosClient 的单个实例，从而实现高效的连接管理和性能。 请参阅 性能指南。 |
| WithApplicationName(String) |
要添加到 Azure Cosmos DB 服务的默认用户代理的后缀。 |
| WithApplicationPreferredRegions(IReadOnlyList<String>) |
为 Azure Cosmos DB 服务中的异地复制数据库帐户设置首选区域。 |
| WithApplicationRegion(String) |
设置要用于 Azure Cosmos DB 服务的首选异地复制区域。 |
| WithBulkExecution(Boolean) |
允许对服务请求进行乐观批处理。 设置此选项可能会影响操作的延迟。 因此，建议仅将此选项用于非延迟敏感方案。 |
| WithClientTelemetryOptions(CosmosClientTelemetryOptions) |
使用相应选项启用遥测功能 |
| WithConnectionModeDirect() |
将连接模式设置为“直接”。 客户端在连接到 Azure Cosmos DB 服务时使用此服务。 |
| WithConnectionModeDirect(Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<Int32>, Nullable<Int32>, Nullable<PortReuseMode>, Nullable<Boolean>) |
将连接模式设置为“直接”。 客户端在连接到 Azure Cosmos DB 服务时使用此服务。 |
| WithConnectionModeGateway(Nullable<Int32>, IWebProxy) |
将连接模式设置为网关。 客户端在连接到 Azure Cosmos DB 服务时使用此服务。 |
| WithConsistencyLevel(ConsistencyLevel) |
这可用于削弱读取操作的数据库帐户一致性级别。 如果未设置此设置，则数据库帐户一致性级别将用于所有请求。 |
| WithContentResponseOnWrite(Boolean) |
获取或设置布尔值，以仅返回 Cosmos DB 响应中写入项操作（如 Create、Upsert、Patch 和 Replace）中的标头和状态代码。 将选项设置为 false 将导致响应具有 null 资源。 这可以通过不通过网络发送回资源并在客户端上对其进行序列化来减少网络和 CPU 负载。 |
| WithCustomSerializer(CosmosSerializer) |
设置自定义 JSON 序列化程序。 |
| WithHttpClientFactory(Func<HttpClient>) |
设置一个委托，用于获取要用于 HTTPS 通信的 HttpClient 实例。 |
| WithLimitToEndpoint(Boolean) |
将操作限制为 CosmosClientBuilder 构造函数上提供的终结点。 |
| WithRequestTimeout(TimeSpan) |
设置连接到 Azure Cosmos DB 服务时的请求超时（以秒为单位）。 |
| WithSerializerOptions(CosmosSerializationOptions) |
设置自定义序列化程序选项。 |
| WithThrottlingRetryOptions(TimeSpan, Int32) |
设置重试之间的最长等待时间，以及针对受限制的请求重试的最大次数。 |
