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

RequestOptions interface

包:

@azure/cosmos

可为向 Azure Cosmos DB 服务器发出的请求指定的选项。=

扩展

SharedOptions

属性

accessCondition	与请求关联的条件。
consistencyLevel	客户端所需的一致性级别。
disableAutomaticIdGeneration	禁用自动 ID 生成（如果 ID 不在定义中会导致创建失败）
disableRUPerMinuteUsage	DisableRUPerMinuteUsage 用于启用/禁用请求单位（RU）/分钟容量，以便在常规预配 RU/秒耗尽时为请求提供服务。
enableScriptLogging	启用或禁用 JavaScript 存储过程中的日志记录。
indexingDirective	指定索引指令（索引、不为 .. 等编制索引）。
offerThroughput	为容器预配的产品/服务吞吐量，用于度量每个单位的请求数。
offerType	创建文档容器时的产品/服务类型。 此选项仅在创建文档容器时有效。
populateQuotaInfo	启用/禁用获取文档容器读取请求的文档容器配额相关统计信息。
postTriggerInclude	指示操作后要调用的 post 触发器是什么。
preTriggerInclude	指示操作之前要调用的预触发器是什么。
resourceTokenExpirySeconds	与权限关联的资源令牌的到期时间（以秒为单位）（仅适用于权限请求）。
urlConnection	（高级用例）要连接到的 URL。

继承属性

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()
bypassIntegratedCache	设置是否应绕过或启用 Azure CosmosDB 服务中的请求的集成缓存。 默认值为 false。 默认情况下，已启用集成缓存
initialHeaders	（高级用例）将请求发送到 Cosmos 时要以初始标头开头
maxIntegratedCacheStalenessInMs	设置与 Azure CosmosDB 服务中的请求关联的过期值。 对于 <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> 或 <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>的请求，集成缓存的响应保证不会超过此 maxIntegratedCacheStaleness 指示的值。 如果未设置一致性级别，则忽略此属性。 默认值为 null 缓存过期以毫秒为单位支持粒度。 将忽略小于毫秒的任何内容。
priorityLevel	每个请求的优先级（低/高）。 在任何高优先级请求之前，低优先级请求始终受到限制。 默认值为 null。 默认情况下，所有请求都是高优先级请求
sessionToken	启用/禁用获取文档容器读取请求的文档容器配额相关统计信息。

属性详细信息

accessCondition

与请求关联的条件。

accessCondition?: { condition: string, type: string }

属性值

{ condition: string, type: string }

consistencyLevel

客户端所需的一致性级别。

consistencyLevel?: string

属性值

string

disableAutomaticIdGeneration

禁用自动 ID 生成（如果 ID 不在定义中会导致创建失败）

disableAutomaticIdGeneration?: boolean

属性值

boolean

disableRUPerMinuteUsage

DisableRUPerMinuteUsage 用于启用/禁用请求单位（RU）/分钟容量，以便在常规预配 RU/秒耗尽时为请求提供服务。

disableRUPerMinuteUsage?: boolean

属性值

boolean

enableScriptLogging

启用或禁用 JavaScript 存储过程中的日志记录。

enableScriptLogging?: boolean

属性值

boolean

indexingDirective

指定索引指令（索引、不为 .. 等编制索引）。

indexingDirective?: string

属性值

string

offerThroughput

为容器预配的产品/服务吞吐量，用于度量每个单位的请求数。

offerThroughput?: number

属性值

number

offerType

创建文档容器时的产品/服务类型。

此选项仅在创建文档容器时有效。

offerType?: string

属性值

string

populateQuotaInfo

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

populateQuotaInfo?: boolean

属性值

boolean

postTriggerInclude

指示操作后要调用的 post 触发器是什么。

postTriggerInclude?: string | string[]

属性值

string | string[]

preTriggerInclude

指示操作之前要调用的预触发器是什么。

preTriggerInclude?: string | string[]

属性值

string | string[]

resourceTokenExpirySeconds

与权限关联的资源令牌的到期时间（以秒为单位）（仅适用于权限请求）。

resourceTokenExpirySeconds?: number

属性值

number

urlConnection

（高级用例）要连接到的 URL。

urlConnection?: string

属性值

string

继承属性详细信息

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

继承自SharedOptions.abortSignal

bypassIntegratedCache

设置是否应绕过或启用 Azure CosmosDB 服务中的请求的集成缓存。

默认值为 false。 默认情况下，已启用集成缓存

bypassIntegratedCache?: boolean

属性值

boolean

继承自SharedOptions.bypassIntegratedCache

initialHeaders

（高级用例）将请求发送到 Cosmos 时要以初始标头开头

initialHeaders?: CosmosHeaders

属性值

CosmosHeaders

继承自SharedOptions.initialHeaders

maxIntegratedCacheStalenessInMs

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

默认值为 null

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

maxIntegratedCacheStalenessInMs?: number

属性值

number

继承自SharedOptions.maxIntegratedCacheStalenessInMs

priorityLevel

每个请求的优先级（低/高）。 在任何高优先级请求之前，低优先级请求始终受到限制。

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

priorityLevel?: PriorityLevel

属性值

PriorityLevel

继承自SharedOptions.priorityLevel

sessionToken

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

sessionToken?: string

属性值

string

继承自SharedOptions.sessionToken