你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
RequestOptions interface
可以为颁发给 Azure Cosmos DB 服务器的请求指定的选项。=
- Extends
属性
access |
与请求关联的条件。 |
consistency |
客户端所需的一致性级别。 |
disable |
禁用自动 ID 生成 (如果 id 不在定义) 上,则会导致创建失败 |
disable |
DisableRUPerMinuteUsage 用于启用/禁用请求单位 (RU) /分钟容量,以便在常规预配的 RU 数/秒耗尽时为请求提供服务。 |
enable |
启用或禁用 JavaScript 存储过程中的日志记录。 |
indexing |
指定索引指令 (索引,不要为 . 编制索引。等) 。 |
offer |
为容器预配的产品/服务吞吐量,度量单位的请求数。 |
offer |
创建文档容器时的产品/服务类型。 此选项仅在创建文档容器时有效。 |
populate |
启用/禁用获取文档容器读取请求的文档容器配额相关统计信息。 |
post |
指示操作后要调用的后触发器是什么。 |
pre |
指示在操作之前要调用的预触发器是什么。 |
resource |
与权限关联的资源令牌的过期时间 (秒) (仅适用于权限) 上的请求。 |
url |
(高级用例) 要连接到的 URL。 |
继承属性
abort |
abortSignal 将传递给此方法调用创建的所有基础网络请求。 请参见https://developer.mozilla.org/en-US/docs/Web/API/AbortController 示例 取消读取请求
|
initial |
(向 Cosmos 发送请求时,) 初始标头的高级用例 |
max |
设置与 Azure CosmosDB 服务中的请求关联的过期值。 对于 为 <xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> 或 <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>的请求<xref:com.azure.cosmos.ConsistencyLevel>,集成缓存的响应保证不会超过此 maxIntegratedCacheStaleness 指示的值。 如果未设置一致性级别,则忽略此属性。 默认值为 null 支持以毫秒粒度表示的缓存过期性。 将忽略小于毫秒的任何内容。 |
priority |
每个请求的优先级 (低/高) 。 低优先级请求始终在任何高优先级请求之前受到限制。 默认值为 null。 默认情况下,所有请求都为高优先级 |
session |
启用/禁用获取文档容器读取请求的文档容器配额相关统计信息。 |
属性详细信息
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
指示操作后要调用的后触发器是什么。
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
initialHeaders
(向 Cosmos 发送请求时,) 初始标头的高级用例
initialHeaders?: 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