你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

CosmosDBv3OutputOptions interface

属性

collectionName

要监视的集合的名称

collectionThroughput

当 createIfNotExists 为 true 时,它定义创建的集合 吞吐量

connectionStringSetting

具有 Cosmos DB 连接字符串的应用设置(或环境变量)

createIfNotExists

一个布尔值,指示集合在不存在时是否创建。 默认值为 false,因为新集合是使用保留吞吐量创建的,这会产生成本影响。 有关详细信息,请参阅 定价页

databaseName

受监视的集合的 Azure Cosmos DB 数据库的名称

partitionKey

createIfNotExists 为 true 时,它定义所创建的集合的分区键路径。 可能包括绑定参数。

preferredLocations

为 Azure Cosmos DB 服务中的异地复制数据库帐户定义首选位置(区域)。 值应以逗号分隔。 例如,美国东部、美国中南部、北欧

useMultipleWriteLocations

如果设置为 true 以及 preferredLocations,则支持 Azure Cosmos DB 服务中的多区域写入。

属性详细信息

collectionName

要监视的集合的名称

collectionName: string

属性值

string

collectionThroughput

当 createIfNotExists 为 true 时,它定义创建的集合 吞吐量

collectionThroughput?: number

属性值

number

connectionStringSetting

具有 Cosmos DB 连接字符串的应用设置(或环境变量)

connectionStringSetting: string

属性值

string

createIfNotExists

一个布尔值,指示集合在不存在时是否创建。 默认值为 false,因为新集合是使用保留吞吐量创建的,这会产生成本影响。 有关详细信息,请参阅 定价页

createIfNotExists?: boolean

属性值

boolean

databaseName

受监视的集合的 Azure Cosmos DB 数据库的名称

databaseName: string

属性值

string

partitionKey

createIfNotExists 为 true 时,它定义所创建的集合的分区键路径。 可能包括绑定参数。

partitionKey?: string

属性值

string

preferredLocations

为 Azure Cosmos DB 服务中的异地复制数据库帐户定义首选位置(区域)。 值应以逗号分隔。 例如,美国东部、美国中南部、北欧

preferredLocations?: string

属性值

string

useMultipleWriteLocations

如果设置为 true 以及 preferredLocations,则支持 Azure Cosmos DB 服务中的多区域写入。

useMultipleWriteLocations?: boolean

属性值

boolean