你当前正在访问 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 后，需要调用 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 后，需要调用 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