CosmosDBv4LatestVersionFunctionOptions interface

Extends

Omit<CosmosDBv4TriggerOptions, "changeFeedMode">,Partial<FunctionOptions>

屬性

changeFeedMode
handler

當你的函式被觸發時,將會執行的程式碼

retry

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

trigger

函式主要輸入的組態,亦即觸發它的原因。這是在調用期間當做自變數傳遞至函式處理程式的唯一輸入

繼承的屬性

connection

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

containerName

受監視之容器的名稱

createLeaseContainerIfNotExists

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

databaseName

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

extraInputs

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

extraOutputs

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

feedPollDelay

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

leaseAcquireInterval

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

leaseConnection

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

leaseContainerName

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

leaseContainerPrefix

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

leaseDatabaseName

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

leaseExpirationInterval

設定時,它會以毫秒為單位定義代表分割區之租用的租用間隔。 未在此間隔內更新的租用將會過期,且分割區的擁有權會移轉給另一個執行個體。 預設值為 60000 (60 秒)。

leaseRenewInterval

設定時,它會以毫秒為單位定義實例目前所持有之分割區之所有租用的更新間隔。 預設值為 17000 (17 秒)。

leasesContainerThroughput

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

maxItemsPerInvocation

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

preferredLocations

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

return

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

startFromBeginning

此選項會告知觸發程式從容器變更歷程記錄的開頭讀取變更,而不是從目前時間開始。 因為在後續執行中,檢查點已儲存,所以從開頭讀取僅適用於觸發程序第一次啟動的情況下。 當已建立租用時,將此選項設定為 true 沒有任何作用。 當 為changeFeedMode時AllVersionsAndDeletes不受支援。

startFromTime

取得或設定用來初始化變更摘要讀取作業的日期和時間。 建議的格式是 ISO 8601 與 UTC 指示項,例如 2021-02-16T14:19:29Z。 此項目僅用於設定初始觸發程序狀態。 一旦觸發程序具有租用狀態之後,變更此值不會有任何作用。 當 為changeFeedMode時AllVersionsAndDeletes不受支援。

屬性詳細資料

changeFeedMode

changeFeedMode?: LatestVersion

屬性值

handler

當你的函式被觸發時,將會執行的程式碼

handler: CosmosDBv4Handler<T>

屬性值

retry

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

retry?: RetryOptions

屬性值

trigger

函式主要輸入的組態,亦即觸發它的原因。這是在調用期間當做自變數傳遞至函式處理程式的唯一輸入

trigger?: CosmosDBv4Trigger

屬性值

繼承的屬性詳細資料

connection

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

connection: string

屬性值

string

繼承自 Omit.connection

containerName

受監視之容器的名稱

containerName: string

屬性值

string

繼承自 Omit.containerName

createLeaseContainerIfNotExists

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

createLeaseContainerIfNotExists?: boolean

屬性值

boolean

繼承自 Omit.createLeaseContainerIfNotExists

databaseName

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

databaseName: string

屬性值

string

繼承自 Omit.databaseName

extraInputs

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

extraInputs?: FunctionInput[]

屬性值

繼承自 部分。額外輸入

extraOutputs

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

extraOutputs?: FunctionOutput[]

屬性值

繼承自 部分.額外輸出

feedPollDelay

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

feedPollDelay?: number

屬性值

number

繼承自 Omit.feedPollDelay

leaseAcquireInterval

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

leaseAcquireInterval?: number

屬性值

number

繼承自 Omit.leaseAcquireInterval

leaseConnection

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

leaseConnection?: string

屬性值

string

繼承自 Omit.leaseConnection

leaseContainerName

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

leaseContainerName?: string

屬性值

string

繼承自 Omit.leaseContainerName

leaseContainerPrefix

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

leaseContainerPrefix?: string

屬性值

string

繼承自 Omit.leaseContainerPrefix

leaseDatabaseName

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

leaseDatabaseName?: string

屬性值

string

繼承自 Omit.leaseDatabaseName

leaseExpirationInterval

設定時,它會以毫秒為單位定義代表分割區之租用的租用間隔。 未在此間隔內更新的租用將會過期,且分割區的擁有權會移轉給另一個執行個體。 預設值為 60000 (60 秒)。

leaseExpirationInterval?: number

屬性值

number

繼承自 Omit.leaseExpirationInterval

leaseRenewInterval

設定時,它會以毫秒為單位定義實例目前所持有之分割區之所有租用的更新間隔。 預設值為 17000 (17 秒)。

leaseRenewInterval?: number

屬性值

number

繼承自 Omit.leaseRenewInterval

leasesContainerThroughput

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

leasesContainerThroughput?: number

屬性值

number

繼承自 Omit.leasesContainerThroughput

maxItemsPerInvocation

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

maxItemsPerInvocation?: number

屬性值

number

繼承自 Omit.maxItemsPerInvocation

preferredLocations

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

preferredLocations?: string

屬性值

string

繼承自 Omit.preferredLocations

return

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

return?: FunctionOutput

屬性值

繼承自 部分回歸

startFromBeginning

此選項會告知觸發程式從容器變更歷程記錄的開頭讀取變更,而不是從目前時間開始。 因為在後續執行中,檢查點已儲存,所以從開頭讀取僅適用於觸發程序第一次啟動的情況下。 當已建立租用時,將此選項設定為 true 沒有任何作用。 當 為changeFeedMode時AllVersionsAndDeletes不受支援。

startFromBeginning?: boolean

屬性值

boolean

繼承自 省略。開始自開始

startFromTime

取得或設定用來初始化變更摘要讀取作業的日期和時間。 建議的格式是 ISO 8601 與 UTC 指示項,例如 2021-02-16T14:19:29Z。 此項目僅用於設定初始觸發程序狀態。 一旦觸發程序具有租用狀態之後,變更此值不會有任何作用。 當 為changeFeedMode時AllVersionsAndDeletes不受支援。

startFromTime?: string

屬性值

string

繼承自 Omit.startFromTime(遺漏)開始