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

CosmosDBv4FunctionOptions interface

包:: @azure/functions

扩展: CosmosDBv4TriggerOptions,Partial<FunctionOptions>

属性

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

继承属性

connection	具有 Cosmos DB 连接字符串的应用设置（或环境变量）
containerName	要监视的容器的名称
createLeaseContainerIfNotExists	检查是否存在并自动创建租约容器。默认值为 `false`
databaseName	受监视的容器的 Azure Cosmos DB 数据库的名称
extraInputs	在调用期间为可选辅助输入集配置，请使用 `context.extraInputs.get()` 获取这些值
extraOutputs	在调用期间为可选辅助输出集配置，请使用 `context.extraOutputs.set()` 设置这些值
feedPollDelay	在清空所有当前更改后，轮询分区以获取源上新更改之间的延迟时间（以毫秒为单位）。默认值为 5,000 毫秒，即 5 秒。
leaseAcquireInterval	设置后，它会定义在已知主机实例之间均匀分布分区时启动任务计算的间隔（以毫秒为单位）。默认值为 13000 （13 秒）。
leaseConnection	包含保留租约容器的服务的连接字符串的应用设置的名称。如果未设置，它将连接到由 `connection` 定义的服务
leaseContainerName	要存储租约的容器的名称。如果未设置，它将使用“租约”
leaseContainerPrefix	设置后，该值将作为前缀添加到此函数的 Lease 容器中创建的租约。使用前缀允许两个单独的 Azure Functions 使用不同的前缀共享同一租约容器。
leaseDatabaseName	保存用于存储租约的容器的数据库的名称。如果未设置，它将使用 `databaseName` 的值
leaseExpirationInterval	设置时，它会定义租约在表示分区的租约上所用的时间间隔（以毫秒为单位）。如果未在此间隔内续订租约，则会导致租约过期，并且分区的所有权将移到另一个实例。默认值为 60000 （60 秒）。
leaseRenewInterval	设置后，它会定义实例当前持有的分区的所有租约的续订间隔（以毫秒为单位）。默认值为 17000 （17 秒）。
leasesContainerThroughput	`createLeaseContainerIfNotExists` 设置为 `true`时，定义要分配给创建的租约容器的请求单位数
maxItemsPerInvocation	设置时，此属性设置每个函数调用接收的最大项数。如果通过存储过程执行受监视容器中的作，则从更改源读取项时会保留事务范围。因此，收到的项数可能高于指定值，以便将同一事务更改的项作为一个原子批处理的一部分返回。
preferredLocations	为 Azure Cosmos DB 服务中的异地复制数据库帐户定义首选位置（区域）。值应以逗号分隔。例如，美国东部、美国中南部、北欧
return	函数可选主输出的配置：这是在调用期间应设置为函数处理程序的返回值的主要输出
startFromBeginning	此选项告知触发器从容器更改历史记录的开头读取更改，而不是从当前时间开始。从头读取仅在触发器首次启动时有效，就像在后续运行中一样，检查点已存储。当已创建租约时，将此选项设置为 true 无效。
startFromTime	获取或设置初始化更改源读取作的日期和时间。建议的格式是带有 UTC 设计符的 ISO 8601，例如 2021-02-16T14：19：29Z。这仅用于设置初始触发器状态。触发器具有租约状态后，更改此值不起作用。

属性详细信息

handler

handler: CosmosDBv4Handler

属性值

CosmosDBv4Handler

retry

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

retry?: RetryOptions

属性值

RetryOptions

trigger

trigger?: CosmosDBv4Trigger

属性值

CosmosDBv4Trigger

继承属性详细信息

connection

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

connection: string

属性值

string

继承自CosmosDBv4TriggerOptions.connection

containerName

要监视的容器的名称

containerName: string

属性值

string

继承自CosmosDBv4TriggerOptions.containerName

createLeaseContainerIfNotExists

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

createLeaseContainerIfNotExists?: boolean

属性值

boolean

继承自CosmosDBv4TriggerOptions.createLeaseContainerIfNotExists

databaseName

受监视的容器的 Azure Cosmos DB 数据库的名称

databaseName: string

属性值

string

继承自CosmosDBv4TriggerOptions.databaseName

extraInputs

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

extraInputs?: FunctionInput[]

属性值

FunctionInput[]

继承自 partial.extraInputs

extraOutputs

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

extraOutputs?: FunctionOutput[]

属性值

FunctionOutput[]

继承自 Partial.extraOutputs 的

feedPollDelay

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

feedPollDelay?: number

属性值

number

继承自 CosmosDBv4TriggerOptions.feedPollDelay

leaseAcquireInterval

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

leaseAcquireInterval?: number

属性值

number

继承自CosmosDBv4TriggerOptions.leaseAcquireInterval

leaseConnection

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

leaseConnection?: string

属性值

string

继承自 CosmosDBv4TriggerOptions.leaseConnection

leaseContainerName

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

leaseContainerName?: string

属性值

string

继承自CosmosDBv4TriggerOptions.leaseContainerName

leaseContainerPrefix

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

leaseContainerPrefix?: string

属性值

string

继承自CosmosDBv4TriggerOptions.leaseContainerPrefix

leaseDatabaseName

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

leaseDatabaseName?: string

属性值

string

继承自CosmosDBv4TriggerOptions.leaseDatabaseName

leaseExpirationInterval

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

leaseExpirationInterval?: number

属性值

number

继承自CosmosDBv4TriggerOptions.leaseExpirationInterval

leaseRenewInterval

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

leaseRenewInterval?: number

属性值

number

继承自CosmosDBv4TriggerOptions.leaseRenewInterval

leasesContainerThroughput

createLeaseContainerIfNotExists 设置为 true时，定义要分配给创建的租约容器的请求单位数

leasesContainerThroughput?: number

属性值

number

继承自CosmosDBv4TriggerOptions.leasesContainerThroughput

maxItemsPerInvocation

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

maxItemsPerInvocation?: number

属性值

number

继承自CosmosDBv4TriggerOptions.maxItemsPerInvocation

preferredLocations

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

preferredLocations?: string

属性值

string

继承自 CosmosDBv4TriggerOptions.preferredLocations

return

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

return?: FunctionOutput

属性值

FunctionOutput

继承自 partial.return

startFromBeginning

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

startFromBeginning?: boolean

属性值

boolean

继承自CosmosDBv4TriggerOptions.startFromBeginning

startFromTime

获取或设置初始化更改源读取作的日期和时间。建议的格式是带有 UTC 设计符的 ISO 8601，例如 2021-02-16T14：19：29Z。这仅用于设置初始触发器状态。触发器具有租约状态后，更改此值不起作用。

startFromTime?: string

属性值

string

继承自CosmosDBv4TriggerOptions.startFromTime