CosmosDBv4FunctionOptions interface

handler: CosmosDBv4Handler

屬性值

選擇性的重試原則，可重新執行失敗的執行，直到成功完成或達到重試次數上限為止。 在這裡深入了解

retry?: RetryOptions

屬性值

trigger?: CosmosDBv4Trigger

屬性值

具有 Cosmos DB 連接字串的應用程式設定（或環境變數）

connection: string

屬性值

繼承自CosmosDBv4TriggerOptions.connection

受監視之容器的名稱

containerName: string

屬性值

繼承自CosmosDBv4TriggerOptions.containerName

檢查是否存在，並自動建立租用容器。 預設為 false

createLeaseContainerIfNotExists?: boolean

屬性值

繼承自CosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

受監視容器的 Azure Cosmos DB 資料庫名稱

databaseName: string

屬性值

繼承自CosmosDBv4TriggerOptions.databaseName

在叫用期間，針對一組選擇性的次要輸入進行組態，以 context.extraInputs.get() 取得這些值

extraInputs?: FunctionInput[]

屬性值

繼承自 Partial.extraInputs

設定選擇性的次要輸出集合在調用期間，請使用 context.extraOutputs.set()

extraOutputs?: FunctionOutput[]

屬性值

繼承自 Partial.extraOutputs

在清空所有目前變更之後，輪詢數據分割以取得摘要上新變更之間的延遲時間（以毫秒為單位）。 默認值為 5,000 毫秒或 5 秒。

feedPollDelay?: number

屬性值

繼承自CosmosDBv4TriggerOptions.feedPollDelay

設定時，它會以毫秒為單位定義開始工作，以計算分割區是否平均分散在已知主機實例之間。 預設值為13000（13秒）。

leaseAcquireInterval?: number

屬性值

繼承自CosmosDBv4TriggerOptions.leaseAcquireInterval

應用程式設定的名稱，其中包含保留租用容器之服務的連接字串。 如果未設定，則會連線到由 connection 定義的服務

leaseConnection?: string

屬性值

繼承自CosmosDBv4TriggerOptions.leaseConnection

要儲存租用的容器名稱。 如果未設定，則會使用「租用」

leaseContainerName?: string

屬性值

繼承自CosmosDBv4TriggerOptions.leaseContainerName

設定時，值會新增為此函式之租用容器中建立的租用前置詞。 使用前置詞可讓兩個不同的 Azure Functions 使用不同的前置詞來共用相同的租用容器。

leaseContainerPrefix?: string

屬性值

繼承自CosmosDBv4TriggerOptions.leaseContainerPrefix

保存用來儲存租用之容器的資料庫名稱。 如果未設定，則會使用 databaseName

leaseDatabaseName?: string

屬性值

繼承自CosmosDBv4TriggerOptions.leaseDatabaseName

設定時，它會以毫秒為單位定義代表分割區之租用的租用間隔。 如果租用未在此間隔內更新，則會導致租用過期，而分割區的擁有權將會移至另一個實例。 預設值為 60000 （60 秒）。

leaseExpirationInterval?: number

屬性值

繼承自CosmosDBv4TriggerOptions.leaseExpirationInterval

設定時，它會以毫秒為單位定義實例目前所持有之分割區之所有租用的更新間隔。 默認值為17000 （17秒）。

leaseRenewInterval?: number

屬性值

繼承自CosmosDBv4TriggerOptions.leaseRenewInterval

當 createLeaseContainerIfNotExists 設定為 true時，定義指派給所建立租用容器的要求單位數量

leasesContainerThroughput?: number

屬性值

繼承自CosmosDBv4TriggerOptions.leasesContainerThroughput

設定時，這個屬性會設定每個函式呼叫收到的項目數目上限。 如果受監視容器中的作業是透過預存程式執行，則會在從變更摘要讀取專案時保留交易範圍。 因此，收到的項目數目可能高於指定的值，讓相同交易變更的項目會當做一個不可部分完成批次的一部分傳回。

maxItemsPerInvocation?: number

屬性值

繼承自CosmosDBv4TriggerOptions.maxItemsPerInvocation

定義 Azure Cosmos DB 服務中異地復寫資料庫帳戶的慣用位置（區域）。 值應該以逗號分隔。 例如，美國東部、美國中南部、北歐

preferredLocations?: string

屬性值

繼承自CosmosDBv4TriggerOptions.preferredLocations

函式選擇性主要輸出的組態 這是您應該在調用期間設定為函式處理程式的傳回值的主要輸出

return?: FunctionOutput

屬性值

繼承自 Partial.return

此選項會告知觸發程式從容器變更歷程記錄的開頭讀取變更，而不是從目前時間開始。 從開頭讀取只會在觸發程式第一次啟動時運作，就像後續執行一樣，檢查點已經儲存。 當已建立租用時，將此選項設定為 true 沒有任何作用。

startFromBeginning?: boolean

屬性值

繼承自CosmosDBv4TriggerOptions.startFromBeginning

取得或設定用來初始化變更摘要讀取作業的日期和時間。 建議的格式是 ISO 8601 與 UTC 指示項，例如 2021-02-16T14：19：29Z。 這隻會用來設定初始觸發程序狀態。 觸發程式具有租用狀態之後，變更此值並沒有任何作用。

startFromTime?: string

屬性值

繼承自CosmosDBv4TriggerOptions.startFromTime