CosmosDBv3InputOptions interface

套件:

@azure/functions

屬性

collectionName	正在監視的集合名稱
connectionStringSetting	具有 Cosmos DB 連接字串的應用程式設定（或環境變數）
databaseName	受監視集合的 Azure Cosmos DB 資料庫名稱
id	要擷取之文件的標識碼。 這個屬性支援 系結表達式。 請勿同時設定 id 和 sqlQuery 屬性。 如果您未設定任一個集合，則會擷取整個集合。
partitionKey	指定查閱的數據分割索引鍵值。 可能包含係結參數。 數據分割集合中的查閱需要
preferredLocations	定義 Azure Cosmos DB 服務中異地復寫資料庫帳戶的慣用位置（區域）。 值應該以逗號分隔。 例如，美國東部、美國中南部、北歐
sqlQuery	用來擷取多個檔的 Azure Cosmos DB SQL 查詢。 屬性支援運行時間系結，如下列範例所示： SELECT * FROM c where c.departmentId = {departmentId} 請勿同時設定 id 和 sqlQuery 屬性。 如果您未設定任一個集合，則會擷取整個集合。

屬性詳細資料

collectionName

正在監視的集合名稱

collectionName: string

屬性值

string

connectionStringSetting

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

connectionStringSetting: string

屬性值

string

databaseName

受監視集合的 Azure Cosmos DB 資料庫名稱

databaseName: string

屬性值

string

id

要擷取之文件的標識碼。 這個屬性支援 系結表達式。 請勿同時設定 id 和 sqlQuery 屬性。 如果您未設定任一個集合，則會擷取整個集合。

id?: string

屬性值

string

partitionKey

指定查閱的數據分割索引鍵值。 可能包含係結參數。 數據分割集合中的查閱需要

partitionKey?: string

屬性值

string

preferredLocations

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

preferredLocations?: string

屬性值

string

sqlQuery

用來擷取多個檔的 Azure Cosmos DB SQL 查詢。 屬性支援運行時間系結，如下列範例所示： SELECT * FROM c where c.departmentId = {departmentId} 請勿同時設定 id 和 sqlQuery 屬性。 如果您未設定任一個集合，則會擷取整個集合。

sqlQuery?: string

屬性值

string