RequestOptions interface
可針對向 Azure Cosmos DB 伺服器發出的要求指定選項。=
- Extends
屬性
| access |
與要求相關聯的條件。 |
| consistency |
用戶端所需的一致性層級。 |
| disable |
停用自動產生識別碼（如果識別子不在定義上，會導致建立失敗） |
| disable |
DisableRUPerMinuteUsage 可用來啟用/停用要求單位（RU）/分鐘容量，以在一般布建 RU/秒用盡時提供要求。 |
| enable |
啟用或停用 JavaScript 預存程式中的記錄。 |
| indexing |
指定索引指示詞（index、請勿編製索引等）。 |
| offer |
針對容器布建的供應專案輸送量，以測量每個單位的要求數。 |
| offer |
建立檔案容器時的供應項目類型。 只有在建立文件容器時，此選項才有效。 |
| populate |
啟用/停用取得檔容器讀取要求的檔容器配額相關統計數據。 |
| post |
指出作業之後要叫用的張貼觸發程序是什麼。 |
| pre |
指出作業之前要叫用的預先觸發程序是什麼。 |
| resource |
與許可權相關聯的資源令牌到期時間（以秒為單位）（僅適用於許可權的要求）。 |
| url |
（進階使用案例）要連接的 URL。 |
繼承的屬性
| abort |
abortSignal 以傳遞至這個方法呼叫所建立的所有基礎網路要求。 請參閱 https://developer.mozilla.org/en-US/docs/Web/API/AbortController 範例 取消讀取要求 |
| bypass |
設定是否應該略過或啟用 Azure CosmosDB 服務中要求的整合式快取。 默認值為 false。 默認會啟用整合式快取 |
| initial |
（進階使用案例）將要求傳送至 Cosmos 時要以開頭的初始標頭 |
| max |
設定與 Azure CosmosDB 服務中要求相關聯的過時值。 對於 <xref:com.azure.cosmos.ConsistencyLevel><xref:com.azure.cosmos.ConsistencyLevel%23EVENTUAL> 或 <xref:com.azure.cosmos.ConsistencyLevel%23SESSION>的要求，整合式快取的回應保證不會超過這個 maxIntegratedCacheStaleness 所指示的值。 未設定一致性層級時，會忽略這個屬性。 預設值為 null 快取過時是以毫秒為單位支持的數據粒度。 任何小於毫秒的任何項目都會被忽略。 |
| priority |
每個要求的優先順序層級（低/高）。 低優先順序要求一律會在任何高優先順序要求之前進行節流處理。 預設值為 null。 根據預設，所有要求都是高優先順序 |
| session |
啟用/停用取得檔容器讀取要求的檔容器配額相關統計數據。 |
屬性詳細資料
accessCondition
與要求相關聯的條件。
accessCondition?: { condition: string, type: string }屬性值
{ condition: string, type: string }
consistencyLevel
用戶端所需的一致性層級。
consistencyLevel?: string屬性值
string
disableAutomaticIdGeneration
停用自動產生識別碼（如果識別子不在定義上，會導致建立失敗）
disableAutomaticIdGeneration?: boolean屬性值
boolean
disableRUPerMinuteUsage
DisableRUPerMinuteUsage 可用來啟用/停用要求單位（RU）/分鐘容量，以在一般布建 RU/秒用盡時提供要求。
disableRUPerMinuteUsage?: boolean屬性值
boolean
enableScriptLogging
啟用或停用 JavaScript 預存程式中的記錄。
enableScriptLogging?: boolean屬性值
boolean
indexingDirective
指定索引指示詞（index、請勿編製索引等）。
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
bypassIntegratedCache
設定是否應該略過或啟用 Azure CosmosDB 服務中要求的整合式快取。
默認值為 false。 默認會啟用整合式快取
bypassIntegratedCache?: boolean屬性值
boolean
initialHeaders
（進階使用案例）將要求傳送至 Cosmos 時要以開頭的初始標頭
initialHeaders?: CosmosHeaders屬性值
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
priorityLevel
每個要求的優先順序層級（低/高）。 低優先順序要求一律會在任何高優先順序要求之前進行節流處理。
預設值為 null。 根據預設，所有要求都是高優先順序
priorityLevel?: PriorityLevel