CosmosDBv3FunctionOptions interface
- Extends
-
CosmosDBv3TriggerOptions,Partial<FunctionOptions>
繼承的屬性
| checkpoint |
自訂租用檢查點之間的文件數量。 預設值是在每個函式呼叫之後。 |
| checkpoint |
設定時，它會以毫秒為單位定義租用檢查點之間的間隔。 預設一律在每個函數調用之後。 |
| collection |
正在監視的集合名稱 |
| connection |
具有 Cosmos DB 連接字串的應用程式設定（或環境變數） |
| create |
檢查是否存在，並自動建立租用集合。 預設為 |
| database |
受監視集合的 Azure Cosmos DB 資料庫名稱 |
| extra |
在叫用期間，針對一組選擇性的次要輸入進行組態，以 |
| extra |
設定選擇性的次要輸出集合在調用期間，請使用 |
| feed |
在清空所有目前變更之後，輪詢數據分割以取得摘要上新變更之間的延遲時間（以毫秒為單位）。 默認值為 5,000 毫秒或 5 秒。 |
| lease |
設定時，它會以毫秒為單位定義開始工作，以計算分割區是否平均分散在已知主機實例之間。 預設值為13000（13秒）。 |
| lease |
要儲存租用的集合名稱。 如果未設定，則會使用「租用」 |
| lease |
設定時，值會新增為此函式之 Lease 集合中建立的租用前置詞。 使用前置詞可讓兩個不同的 Azure Functions 使用不同的前置詞來共用相同的租用集合。 |
| lease |
當 |
| lease |
應用程式設定的名稱，其中包含保存租用集合之服務的連接字串。
如果未設定，則會連線到由 |
| lease |
保存要儲存租用之集合的資料庫名稱。 如果未設定，則會使用 |
| lease |
設定時，它會以毫秒為單位定義代表分割區之租用的租用間隔。 如果租用未在此間隔內更新，則會導致租用過期，而分割區的擁有權將會移至另一個實例。 預設值為 60000 （60 秒）。 |
| lease |
設定時，它會以毫秒為單位定義實例目前所持有之分割區之所有租用的更新間隔。 默認值為17000 （17秒）。 |
| max |
設定時，這個屬性會設定每個函式呼叫收到的項目數目上限。 如果受監視容器中的作業是透過預存程式執行，則會在從變更摘要讀取專案時保留交易範圍。 因此，收到的項目數目可能高於指定的值，讓相同交易變更的項目會當做一個不可部分完成批次的一部分傳回。 |
| preferred |
定義 Azure Cosmos DB 服務中異地復寫資料庫帳戶的慣用位置（區域）。 值應該以逗號分隔。 例如，美國東部、美國中南部、北歐 |
| return | 函式選擇性主要輸出的組態 這是您應該在調用期間設定為函式處理程式的傳回值的主要輸出 |
| start |
此選項會告知觸發程式從容器變更歷程記錄的開頭讀取變更，而不是從目前時間開始。 從開頭讀取只會在觸發程式第一次啟動時運作，就像後續執行一樣，檢查點已經儲存。 當已建立租用時，將此選項設定為 true 沒有任何作用。 |
| use |
啟用多區域帳戶以寫入租用集合。 |
屬性詳細資料
handler
retry
trigger
繼承的屬性詳細資料
checkpointDocumentCount
自訂租用檢查點之間的文件數量。 預設值是在每個函式呼叫之後。
checkpointDocumentCount?: number屬性值
number
checkpointInterval
設定時，它會以毫秒為單位定義租用檢查點之間的間隔。 預設一律在每個函數調用之後。
checkpointInterval?: number屬性值
number
collectionName
connectionStringSetting
具有 Cosmos DB 連接字串的應用程式設定（或環境變數）
connectionStringSetting: string屬性值
string
createLeaseCollectionIfNotExists
檢查是否存在，並自動建立租用集合。 預設為 false
createLeaseCollectionIfNotExists?: boolean屬性值
boolean
繼承自CosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists
databaseName
受監視集合的 Azure Cosmos DB 資料庫名稱
databaseName: string屬性值
string
extraInputs
在叫用期間，針對一組選擇性的次要輸入進行組態，以 context.extraInputs.get() 取得這些值
extraInputs?: FunctionInput[]屬性值
繼承自 Partial.extraInputs
extraOutputs
設定選擇性的次要輸出集合在調用期間，請使用 context.extraOutputs.set()
extraOutputs?: FunctionOutput[]屬性值
繼承自 Partial.extraOutputs
feedPollDelay
在清空所有目前變更之後，輪詢數據分割以取得摘要上新變更之間的延遲時間（以毫秒為單位）。 默認值為 5,000 毫秒或 5 秒。
feedPollDelay?: number屬性值
number
leaseAcquireInterval
設定時，它會以毫秒為單位定義開始工作，以計算分割區是否平均分散在已知主機實例之間。 預設值為13000（13秒）。
leaseAcquireInterval?: number屬性值
number
leaseCollectionName
要儲存租用的集合名稱。 如果未設定，則會使用「租用」
leaseCollectionName?: string屬性值
string
leaseCollectionPrefix
設定時，值會新增為此函式之 Lease 集合中建立的租用前置詞。 使用前置詞可讓兩個不同的 Azure Functions 使用不同的前置詞來共用相同的租用集合。
leaseCollectionPrefix?: string屬性值
string
leaseCollectionThroughput
當 createLeaseCollectionIfNotExists 設定為 true時，定義指派給所建立租用集合的要求單位數量
leaseCollectionThroughput?: number屬性值
number
leaseConnectionStringSetting
應用程式設定的名稱，其中包含保存租用集合之服務的連接字串。
如果未設定，則會連線到由 connectionStringSetting 定義的服務
leaseConnectionStringSetting?: string屬性值
string
leaseDatabaseName
保存要儲存租用之集合的資料庫名稱。 如果未設定，則會使用 databaseName
leaseDatabaseName?: string屬性值
string
leaseExpirationInterval
設定時，它會以毫秒為單位定義代表分割區之租用的租用間隔。 如果租用未在此間隔內更新，則會導致租用過期，而分割區的擁有權將會移至另一個實例。 預設值為 60000 （60 秒）。
leaseExpirationInterval?: number屬性值
number
leaseRenewInterval
設定時，它會以毫秒為單位定義實例目前所持有之分割區之所有租用的更新間隔。 默認值為17000 （17秒）。
leaseRenewInterval?: number屬性值
number
maxItemsPerInvocation
設定時，這個屬性會設定每個函式呼叫收到的項目數目上限。 如果受監視容器中的作業是透過預存程式執行，則會在從變更摘要讀取專案時保留交易範圍。 因此，收到的項目數目可能高於指定的值，讓相同交易變更的項目會當做一個不可部分完成批次的一部分傳回。
maxItemsPerInvocation?: number屬性值
number
preferredLocations
定義 Azure Cosmos DB 服務中異地復寫資料庫帳戶的慣用位置（區域）。 值應該以逗號分隔。 例如，美國東部、美國中南部、北歐
preferredLocations?: string屬性值
string
return
函式選擇性主要輸出的組態 這是您應該在調用期間設定為函式處理程式的傳回值的主要輸出
return?: FunctionOutput屬性值
繼承自 Partial.return
startFromBeginning
此選項會告知觸發程式從容器變更歷程記錄的開頭讀取變更，而不是從目前時間開始。 從開頭讀取只會在觸發程式第一次啟動時運作，就像後續執行一樣，檢查點已經儲存。 當已建立租用時，將此選項設定為 true 沒有任何作用。
startFromBeginning?: boolean屬性值
boolean
useMultipleWriteLocations
啟用多區域帳戶以寫入租用集合。
useMultipleWriteLocations?: boolean屬性值
boolean