ChangeFeedIteratorOptions interface

套件:

@azure/cosmos

指定變更摘要的選項

如果未設定這些選項，則會從現在開始讀取整個容器的變更。

屬性

changeFeedMode	發出變更摘要需要啟動的模式訊號。
changeFeedStartFrom	發出變更摘要中要從何處開始的訊號。
excludedLocations	排除作業的一或多個 Azure 區域。 只有在 enableEndPointDiscovery 設定為 true 時，才會套用此選項。
maxItemCount	每個頁面要傳回的項目數量上限
priorityLevel	每個要求的優先順序層級（低/高）。 低優先順序要求一律會在任何高優先順序要求之前進行節流處理。 預設值為 null。 根據預設，所有要求都是高優先順序
sessionToken	要使用的會話令牌。 如果未指定，則會使用最新的擷取會話令牌開頭。
throughputBucket	輸送量 請求 Bucket 的儲存段。 預設值為 null。 在這種情況下，請求可以使用 100% 的分區輸送量。 有關詳細資訊，請訪問 [Cosmos DB 輸送量分桶]（https://aka.ms/cosmsodb-bucketing).

屬性詳細資料

changeFeedMode

發出變更摘要需要啟動的模式訊號。

changeFeedMode?: ChangeFeedMode

屬性值

ChangeFeedMode

changeFeedStartFrom

發出變更摘要中要從何處開始的訊號。

changeFeedStartFrom?: ChangeFeedStartFrom

屬性值

ChangeFeedStartFrom

excludedLocations

排除作業的一或多個 Azure 區域。

只有在 enableEndPointDiscovery 設定為 true 時，才會套用此選項。

excludedLocations?: string[]

屬性值

string[]

maxItemCount

每個頁面要傳回的項目數量上限

maxItemCount?: number

屬性值

number

priorityLevel

每個要求的優先順序層級（低/高）。 低優先順序要求一律會在任何高優先順序要求之前進行節流處理。

預設值為 null。 根據預設，所有要求都是高優先順序

priorityLevel?: PriorityLevel

屬性值

PriorityLevel

sessionToken

要使用的會話令牌。 如果未指定，則會使用最新的擷取會話令牌開頭。

sessionToken?: string

屬性值

string

throughputBucket

輸送量 請求 Bucket 的儲存段。

預設值為 null。 在這種情況下，請求可以使用 100% 的分區輸送量。

有關詳細資訊，請訪問 [Cosmos DB 輸送量分桶]（https://aka.ms/cosmsodb-bucketing).

throughputBucket?: number

屬性值

number