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

ConnectionPolicy interface

包:

@azure/cosmos

表示与 Azure Cosmos DB 数据库服务中的 CosmosClient 关联的连接策略。

属性

connectionMode	确定使用哪种模式连接到 Cosmos。 (目前仅支持网关选项)
enableBackgroundEndpointRefreshing	用于启用/禁用终结点后台刷新的标志。 默认为 false。 使用 的 enableEndpointsDiscovery 终结点发现仍适用于失败的请求。
enableEndpointDiscovery	用于启用/禁用基于读/写操作的请求自动重定向的标志。 默认值为 true。 在另一个进程内或浏览器中销毁 CosmosClient 后，当此值设置为 true 时，需要调用 client.dispose () 。
endpointRefreshRateInMs	客户端将在后台刷新终结点列表的速率（以毫秒为单位）
preferredLocations	要用作读取请求的首选位置的 Azure 区域列表。
requestTimeout	请求超时 (等待网络对等方) 响应的时间。 以毫秒为单位表示。
retryOptions	RetryOptions 对象，该对象定义重试期间使用的多个可配置属性。
useMultipleWriteLocations	在 Azure Cosmos DB 服务中异地复制的数据库帐户) 的任何位置 (区域启用写入的标志。 默认值为 false。

属性详细信息

connectionMode

确定使用哪种模式连接到 Cosmos。 (目前仅支持网关选项)

connectionMode?: Gateway

属性值

Gateway

enableBackgroundEndpointRefreshing

用于启用/禁用终结点后台刷新的标志。 默认为 false。 使用 的 enableEndpointsDiscovery 终结点发现仍适用于失败的请求。

enableBackgroundEndpointRefreshing?: boolean

属性值

boolean

enableEndpointDiscovery

用于启用/禁用基于读/写操作的请求自动重定向的标志。 默认值为 true。 在另一个进程内或浏览器中销毁 CosmosClient 后，当此值设置为 true 时，需要调用 client.dispose () 。

enableEndpointDiscovery?: boolean

属性值

boolean

endpointRefreshRateInMs

客户端将在后台刷新终结点列表的速率（以毫秒为单位）

endpointRefreshRateInMs?: number

属性值

number

preferredLocations

要用作读取请求的首选位置的 Azure 区域列表。

preferredLocations?: string[]

属性值

string[]

requestTimeout

请求超时 (等待网络对等方) 响应的时间。 以毫秒为单位表示。

requestTimeout?: number

属性值

number

retryOptions

RetryOptions 对象，该对象定义重试期间使用的多个可配置属性。

retryOptions?: RetryOptions

属性值

RetryOptions

useMultipleWriteLocations

在 Azure Cosmos DB 服务中异地复制的数据库帐户) 的任何位置 (区域启用写入的标志。 默认值为 false。

useMultipleWriteLocations?: boolean

属性值

boolean