CosmosDBv3InputOptions interface

包:

@azure/functions

属性

collectionName	要监视的集合的名称
connectionStringSetting	具有 Cosmos DB 连接字符串的应用设置（或环境变量）
databaseName	受监视的集合的 Azure Cosmos DB 数据库的名称
id	要检索的文档的 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。 此属性支持 绑定表达式。 不要同时设置 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