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

CosmosDBv3TriggerOptions interface

属性

checkpointDocumentCount

自定义租约检查点之间的文档量。 默认值在每次函数调用后。

checkpointInterval

设置时,它会定义租约检查点之间的间隔(以毫秒为单位)。 默认为始终在进行每个 Function 调用之后进行检查。

collectionName

要监视的集合的名称

connectionStringSetting

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

createLeaseCollectionIfNotExists

检查是否存在并自动创建租约集合。 默认为 false

databaseName

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

feedPollDelay

在清空所有当前更改后,轮询分区以获取源上新更改之间的延迟时间(以毫秒为单位)。 默认值为 5,000 毫秒(5 秒)。

leaseAcquireInterval

设置后,它会定义在已知主机实例之间均匀分布分区时启动任务计算的间隔(以毫秒为单位)。 默认为 13000(13 秒)。

leaseCollectionName

要存储租约的集合的名称。 如果未设置,它将使用“租约”

leaseCollectionPrefix

设置后,该值将作为前缀添加到此函数的 Lease 集合中创建的租约。 使用前缀允许两个单独的 Azure Functions 使用不同的前缀共享同一租约集合。

leaseCollectionThroughput

createLeaseCollectionIfNotExists 设置为 true时,定义要分配给创建的租约集合的请求单位数

leaseConnectionStringSetting

包含保留租约集合的服务的连接字符串的应用设置的名称。 如果未设置,它将连接到由 connectionStringSetting 定义的服务

leaseDatabaseName

保存要存储租约的集合的数据库的名称。 如果未设置,它将使用 databaseName 的值

leaseExpirationInterval

设置时,它会定义租约在表示分区的租约上所用的时间间隔(以毫秒为单位)。 如果在此时间间隔内不续订租用,则该租用会过期,分区的所有权会转移到另一个实例。 默认为 60000(60 秒)。

leaseRenewInterval

设置后,它会定义实例当前持有的分区的所有租约的续订间隔(以毫秒为单位)。 默认为 17000(17 秒)。

maxItemsPerInvocation

设置时,此属性设置每个函数调用接收的最大项数。 如果通过存储过程执行受监视容器中的作,则从更改源读取项时会保留事务范围。 因此,收到的项数可能高于指定的值,通过同一事务更改的项会通过某个原子批处理操作返回。

preferredLocations

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

startFromBeginning

此选项告知触发器从容器更改历史记录的开头读取更改,而不是从当前时间开始。 从开头位置读取仅在触发器首次启动时起作用,因为在后续运行中,已存储检查点。 当已创建租约时,将此选项设置为 true 无效。

useMultipleWriteLocations

启用多区域帐户以写入租约集合。

属性详细信息

checkpointDocumentCount

自定义租约检查点之间的文档量。 默认值在每次函数调用后。

checkpointDocumentCount?: number

属性值

number

checkpointInterval

设置时,它会定义租约检查点之间的间隔(以毫秒为单位)。 默认为始终在进行每个 Function 调用之后进行检查。

checkpointInterval?: number

属性值

number

collectionName

要监视的集合的名称

collectionName: string

属性值

string

connectionStringSetting

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

connectionStringSetting: string

属性值

string

createLeaseCollectionIfNotExists

检查是否存在并自动创建租约集合。 默认为 false

createLeaseCollectionIfNotExists?: boolean

属性值

boolean

databaseName

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

databaseName: string

属性值

string

feedPollDelay

在清空所有当前更改后,轮询分区以获取源上新更改之间的延迟时间(以毫秒为单位)。 默认值为 5,000 毫秒(5 秒)。

feedPollDelay?: number

属性值

number

leaseAcquireInterval

设置后,它会定义在已知主机实例之间均匀分布分区时启动任务计算的间隔(以毫秒为单位)。 默认为 13000(13 秒)。

leaseAcquireInterval?: number

属性值

number

leaseCollectionName

要存储租约的集合的名称。 如果未设置,它将使用“租约”

leaseCollectionName?: string

属性值

string

leaseCollectionPrefix

设置后,该值将作为前缀添加到此函数的 Lease 集合中创建的租约。 使用前缀允许两个单独的 Azure Functions 使用不同的前缀共享同一租约集合。

leaseCollectionPrefix?: string

属性值

string

leaseCollectionThroughput

createLeaseCollectionIfNotExists 设置为 true时,定义要分配给创建的租约集合的请求单位数

leaseCollectionThroughput?: number

属性值

number

leaseConnectionStringSetting

包含保留租约集合的服务的连接字符串的应用设置的名称。 如果未设置,它将连接到由 connectionStringSetting 定义的服务

leaseConnectionStringSetting?: string

属性值

string

leaseDatabaseName

保存要存储租约的集合的数据库的名称。 如果未设置,它将使用 databaseName 的值

leaseDatabaseName?: string

属性值

string

leaseExpirationInterval

设置时,它会定义租约在表示分区的租约上所用的时间间隔(以毫秒为单位)。 如果在此时间间隔内不续订租用,则该租用会过期,分区的所有权会转移到另一个实例。 默认为 60000(60 秒)。

leaseExpirationInterval?: number

属性值

number

leaseRenewInterval

设置后,它会定义实例当前持有的分区的所有租约的续订间隔(以毫秒为单位)。 默认为 17000(17 秒)。

leaseRenewInterval?: number

属性值

number

maxItemsPerInvocation

设置时,此属性设置每个函数调用接收的最大项数。 如果通过存储过程执行受监视容器中的作,则从更改源读取项时会保留事务范围。 因此,收到的项数可能高于指定的值,通过同一事务更改的项会通过某个原子批处理操作返回。

maxItemsPerInvocation?: number

属性值

number

preferredLocations

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

preferredLocations?: string

属性值

string

startFromBeginning

此选项告知触发器从容器更改历史记录的开头读取更改,而不是从当前时间开始。 从开头位置读取仅在触发器首次启动时起作用,因为在后续运行中,已存储检查点。 当已创建租约时,将此选项设置为 true 无效。

startFromBeginning?: boolean

属性值

boolean

useMultipleWriteLocations

启用多区域帐户以写入租约集合。

useMultipleWriteLocations?: boolean

属性值

boolean