你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
CosmosClientOptions 类
定义
重要
一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。 对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。
定义 CosmosClient 所需的所有可配置选项。
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonCosmosClientOptionsConverter))]
public class CosmosClientOptions : Azure.Core.ClientOptions[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Cosmos.TextJsonCosmosClientOptionsConverter))>]
type CosmosClientOptions = class
inherit ClientOptionsPublic Class CosmosClientOptions
Inherits ClientOptions- 继承
- 属性
示例
有关如何配置序列化选项以忽略空值 CosmosClientOptions clientOptions = new CosmosClientOptions () { SerializerOptions = new CosmosSerializationOptions () { IgnoreNullValues = true }， ConnectionMode = ConnectionMode.Gateway， };
CosmosClient client = new CosmosClient (“endpoint”， “key”， clientOptions) ;
构造函数
| CosmosClientOptions() |
创建新的 CosmosClientOptions |
属性
| ApplicationName |
获取或设置要包含在每个 Azure Cosmos DB 服务交互中的用户代理后缀。 |
| ApplicationRegion |
获取或设置用于 Azure Cosmos DB 服务交互的首选异地复制区域。 |
| ConnectionMode |
获取或设置客户端在连接到 Azure Cosmos DB 服务时使用的连接模式。 |
| ConsistencyLevel |
这可用于削弱读取操作的数据库帐户一致性级别。 如果未设置此设置，则数据库帐户一致性级别将用于所有请求。 |
| Diagnostics |
获取客户端诊断选项。 (继承自 ClientOptions) |
| GatewayModeMaxConnectionLimit |
获取或设置 Azure Cosmos DB 服务中目标服务终结点允许的最大并发连接数。 |
| IdleTcpConnectionTimeout |
(Direct/TCP) 控制关闭未使用连接的空闲时间量。 |
| LimitToEndpoint |
将操作限制为 CosmosClient 上提供的终结点。 |
| MaxRequestsPerTcpConnection |
(Direct/TCP) 控制通过单个 TCP 连接同时允许的请求数。 当更多请求同时处于未完成状态时，直接/TCP 客户端将打开其他连接。 |
| MaxRetryAttemptsOnRateLimitedRequests |
获取或设置客户端对速率限制的请求应重试的次数。 |
| MaxRetryWaitTimeOnRateLimitedRequests |
获取或设置允许客户端对速率限制的请求重试的最大时间。 |
| MaxTcpConnectionsPerEndpoint |
(Direct/TCP) 控制可向每个 Cosmos DB 后端打开的最大 TCP 连接数。 此设置与 MaxRequestsPerTcpConnection 一起限制同时发送到单个 Cosmos DB 后端的请求数， (MaxRequestsPerTcpConnection x MaxTcpConnectionPerEndpoint) 。 |
| OpenTcpConnectionTimeout |
(Direct/TCP) 控制尝试建立连接所允许的时间量。 |
| RequestTimeout |
获取连接到 Azure Cosmos DB 服务时的请求超时时间（以秒为单位）。 该数字指定等待网络对等方返回响应的时间。 |
| Retry |
获取客户端重试选项。 (继承自 ClientOptions) |
| RetryPolicy |
获取或设置用于重试的策略。 如果指定了策略，则将使用该策略来代替 Retry 属性。 RetryPolicy可以从 派生类型来修改默认行为，而无需完全实现重试逻辑。 如果 Process(HttpMessage, ReadOnlyMemory<HttpPipelinePolicy>) 重写或指定了自定义 HttpPipelinePolicy ，则实施者负责更新 ProcessingContext 值。 (继承自 ClientOptions) |
| Serializer |
获取 以设置可选的 JSON 序列化程序。 客户端将使用它来序列化或取消序列化用户的 cosmos 请求/响应。 SDK 拥有的类型（如 DatabaseProperties 和 ContainerProperties）将始终使用 SDK 默认序列化程序。 |
| SerializerOptions |
获取 以设置可选的序列化程序选项。 |
| Transport |
HttpPipelineTransport要用于此客户端的 。 默认为 的 HttpClientTransport实例。 (继承自 ClientOptions) |
| WebProxy |
(网关/Https) 获取或设置用于 Web 请求的代理信息。 |
方法
| AddPolicy(HttpPipelinePolicy, HttpPipelinePosition) |
将 HttpPipeline 策略添加到客户端管道中。 策略在管道中的位置由 |
