CosmosDBv3FunctionOptions interface

handler: CosmosDBv3Handler

属性值

一个可选的重试策略，用于重新运行失败的执行，直到成功完成或达到最大重试次数。 在此处了解详细信息

retry?: RetryOptions

属性值

trigger?: CosmosDBv3Trigger

属性值

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

checkpointDocumentCount?: number

属性值

继承自CosmosDBv3TriggerOptions.checkpointDocumentCount

设置时，它会定义租约检查点之间的间隔（以毫秒为单位）。 默认始终在每个函数调用之后。

checkpointInterval?: number

属性值

继承自CosmosDBv3TriggerOptions.checkpointInterval

要监视的集合的名称

collectionName: string

属性值

继承自CosmosDBv3TriggerOptions.collectionName

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

connectionStringSetting: string

属性值

继承自CosmosDBv3TriggerOptions.connectionStringSetting

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

createLeaseCollectionIfNotExists?: boolean

属性值

继承自CosmosDBv3TriggerOptions.createLeaseCollectionIfNotExists

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

databaseName: string

属性值

继承自CosmosDBv3TriggerOptions.databaseName

在调用期间为可选辅助输入集配置，请使用 context.extraInputs.get() 获取这些值

extraInputs?: FunctionInput[]

属性值

继承自 partial.extraInputs

在调用期间为可选辅助输出集配置，请使用 context.extraOutputs.set() 设置这些值

extraOutputs?: FunctionOutput[]

属性值

继承自 Partial.extraOutputs 的

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

feedPollDelay?: number

属性值

继承自 CosmosDBv3TriggerOptions.feedPollDelay

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

leaseAcquireInterval?: number

属性值

继承自 CosmosDBv3TriggerOptions.leaseAcquireInterval

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

leaseCollectionName?: string

属性值

继承自CosmosDBv3TriggerOptions.leaseCollectionName

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

leaseCollectionPrefix?: string

属性值

继承自CosmosDBv3TriggerOptions.leaseCollectionPrefix

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

leaseCollectionThroughput?: number

属性值

继承自CosmosDBv3TriggerOptions.leaseCollectionThroughput

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

leaseConnectionStringSetting?: string

属性值

继承自 CosmosDBv3TriggerOptions.leaseConnectionStringSetting

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

leaseDatabaseName?: string

属性值

继承自CosmosDBv3TriggerOptions.leaseDatabaseName

设置时，它会定义租约在表示分区的租约上所用的时间间隔（以毫秒为单位）。 如果未在此间隔内续订租约，则会导致租约过期，并且分区的所有权将移到另一个实例。 默认值为 60000 （60 秒）。

leaseExpirationInterval?: number

属性值

继承自CosmosDBv3TriggerOptions.leaseExpirationInterval

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

leaseRenewInterval?: number

属性值

继承自CosmosDBv3TriggerOptions.leaseRenewInterval

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

maxItemsPerInvocation?: number

属性值

继承自CosmosDBv3TriggerOptions.maxItemsPerInvocation

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

preferredLocations?: string

属性值

继承自CosmosDBv3TriggerOptions.preferredLocations

函数可选主输出的配置：这是在调用期间应设置为函数处理程序的返回值的主要输出

return?: FunctionOutput

属性值

继承自 partial.return

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

startFromBeginning?: boolean

属性值

继承自CosmosDBv3TriggerOptions.startFromBeginning

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

useMultipleWriteLocations?: boolean

属性值

继承自CosmosDBv3TriggerOptions.useMultipleWriteLocations