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

CosmosClientOptions 类

定义

命名空间:

Microsoft.Azure.Cosmos

程序集:

Microsoft.Azure.Cosmos.Client.dll

包:

Microsoft.Azure.Cosmos v3.36.0

定义 CosmosClient 所需的所有可配置选项。

public class CosmosClientOptions

type CosmosClientOptions = class

Public Class CosmosClientOptions

继承

Object

CosmosClientOptions

示例

有关如何将序列化选项配置为忽略 null 值的示例。

CosmosClientOptions clientOptions = new CosmosClientOptions()
{
    SerializerOptions = new CosmosSerializationOptions(){
        IgnoreNullValues = true
    },
    ConnectionMode = ConnectionMode.Gateway,
};

CosmosClient client = new CosmosClient("endpoint", "key", clientOptions);

构造函数

CosmosClientOptions()

创建新的 CosmosClientOptions

属性

AllowBulkExecution	允许对服务请求进行乐观批处理。 设置此选项可能会影响操作的延迟。 因此，建议仅将此选项用于非延迟敏感方案。
ApplicationName	获取或设置要包含在每个 Azure Cosmos DB 服务交互中的用户代理后缀。
ApplicationPreferredRegions	获取并设置 Azure Cosmos DB 服务中异地复制数据库帐户的首选区域。
ApplicationRegion	获取或设置运行应用程序的位置。 这将影响 SDK 对 Azure Cosmos DB 服务交互的选择。
ConnectionMode	获取或设置客户端在连接到 Azure Cosmos DB 服务时使用的连接模式。
ConsistencyLevel	这可用于削弱读取操作的数据库帐户一致性级别。 如果未设置此设置，则数据库帐户一致性级别将用于所有请求。
CosmosClientTelemetryOptions	获取或设置客户端遥测选项，例如功能标志和相应的选项
CustomHandlers	获取在进程之前运行的处理程序
EnableContentResponseOnWrite	获取或设置布尔值，以仅返回 Cosmos DB 响应中写入项操作（如 Create、Upsert、Patch 和 Replace）中的标头和状态代码。 将选项设置为 false 将导致响应具有 null 资源。 这可以通过不通过网络发送回资源并在客户端上对其进行序列化来减少网络和 CPU 负载。
EnableTcpConnectionEndpointRediscovery	获取或设置在 TCP 连接重置通知上启用地址缓存刷新的标志。
GatewayModeMaxConnectionLimit	获取或设置 Azure Cosmos DB 服务中目标服务终结点允许的最大并发连接数。
HttpClientFactory	获取或设置一个委托，用于获取要用于 HTTPS 通信的 HttpClient 实例。
IdleTcpConnectionTimeout	(Direct/TCP) 控制关闭未使用连接的空闲时间量。
LimitToEndpoint	将操作限制为 CosmosClient 上提供的终结点。
MaxRequestsPerTcpConnection	(Direct/TCP) 控制通过单个 TCP 连接同时允许的请求数。 当更多请求同时处于未完成状态时，直接/TCP 客户端将打开其他连接。
MaxRetryAttemptsOnRateLimitedRequests	获取或设置在请求失败的情况下的最大重试次数，因为 Azure Cosmos DB 服务已对客户端应用速率限制。
MaxRetryWaitTimeOnRateLimitedRequests	获取或设置 Azure Cosmos DB 服务的最大重试时间（以秒为单位）。
MaxTcpConnectionsPerEndpoint	(Direct/TCP) 控制可向每个 Cosmos DB 后端打开的最大 TCP 连接数。 此设置与 MaxRequestsPerTcpConnection 配合使用，限制同时发送到单个 Cosmos DB 后端 (MaxRequestsPerTcpConnection x MaxTcpConnectionPerEndpoint) 的请求数。
OpenTcpConnectionTimeout	(Direct/TCP) 控制尝试建立连接所允许的时间量。
PortReuseMode	(Direct/TCP) 控制传输堆栈使用的客户端端口重用策略。
RequestTimeout	获取连接到 Azure Cosmos DB 服务时的请求超时时间（以秒为单位）。 该数字指定等待网络对等方返回响应的时间。
Serializer	获取 以设置可选的 JSON 序列化程序。 客户端将使用它来序列化或取消序列化用户的 cosmos 请求/响应。 SDK 拥有的类型（如 DatabaseProperties 和 ContainerProperties）将始终使用 SDK 默认序列化程序。
SerializerOptions	获取 以设置可选的序列化程序选项。
ServerCertificateCustomValidationCallback	一个回调委托，用于对 HTTP 和 TCP 执行自定义证书验证。
TokenCredentialBackgroundRefreshInterval	SDK 根据为刷新令牌凭据而设置的时间间隔执行后台刷新。 这可以避免延迟问题，因为在检索新令牌之前会使用旧令牌。
WebProxy	(网关/Https) 获取或设置用于 Web 请求的代理信息。