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

SharedOptions interface

参考

包:: @azure/cosmos

可以为颁发给 Azure Cosmos DB 服务器的请求指定的选项。=

属性

abortSignal	abortSignal 以传递给此方法调用创建的所有基础网络请求。请参见https://developer.mozilla.org/en-US/docs/Web/API/AbortController 示例取消读取请求 `const controller = new AbortController() const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal}); controller.abort()`
initialHeaders	向 Cosmos 发送请求时， (高级用例) 初始标头开头
maxIntegratedCacheStalenessInMs	设置与 Azure CosmosDB 服务中的请求关联的过期值。对于为 <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> 或 <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>的请求<xref:com.azure.cosmos.ConsistencyLevel>，集成缓存的响应保证不会超过此 maxIntegratedCacheStaleness 指示的值。如果未设置一致性级别，则忽略此属性。默认值为 null 支持缓存过期，粒度为毫秒。将忽略小于毫秒的任何内容。
priorityLevel	每个请求的优先级 (低/高) 。在任何高优先级请求之前，始终会限制低优先级请求。默认值为 null。默认情况下，所有请求的优先级都很高
sessionToken	启用/禁用获取文档容器读取请求的文档容器配额相关统计信息。

属性详细信息

abortSignal

abortSignal 以传递给此方法调用创建的所有基础网络请求。请参见https://developer.mozilla.org/en-US/docs/Web/API/AbortController

示例

取消读取请求

const controller = new AbortController()
const {result: item} = await items.query('SELECT * from c', { abortSignal: controller.signal});
controller.abort()

abortSignal?: AbortSignal

属性值

AbortSignal

initialHeaders

向 Cosmos 发送请求时， (高级用例) 初始标头开头

initialHeaders?: CosmosHeaders

属性值

CosmosHeaders

maxIntegratedCacheStalenessInMs

设置与 Azure CosmosDB 服务中的请求关联的过期值。对于为 <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> 或 <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>的请求<xref:com.azure.cosmos.ConsistencyLevel>，集成缓存的响应保证不会超过此 maxIntegratedCacheStaleness 指示的值。如果未设置一致性级别，则忽略此属性。

默认值为 null

支持缓存过期，粒度为毫秒。将忽略小于毫秒的任何内容。

maxIntegratedCacheStalenessInMs?: number

属性值

number

priorityLevel

每个请求的优先级 (低/高) 。在任何高优先级请求之前，始终会限制低优先级请求。

默认值为 null。默认情况下，所有请求的优先级都很高

priorityLevel?: PriorityLevel

属性值

PriorityLevel

sessionToken

启用/禁用获取文档容器读取请求的文档容器配额相关统计信息。

sessionToken?: string

属性值

string

Share via