CosmosDBv4FunctionOptions interface
- Extends
-
CosmosDBv4TriggerOptions,Partial<FunctionOptions>
Properties
handler | |
retry | An optional retry policy to rerun a failed execution until either successful completion occurs or the maximum number of retries is reached. Learn more here |
trigger |
Inherited Properties
connection | An app setting (or environment variable) with the Cosmos DB connection string |
container |
The name of the container being monitored |
create |
Checks for existence and automatically creates the leases container. Default is |
database |
The name of the Azure Cosmos DB database with the container being monitored |
extra |
Configuration for an optional set of secondary inputs
During invocation, get these values with |
extra |
Configuration for an optional set of secondary outputs
During invocation, set these values with |
feed |
The time (in milliseconds) for the delay between polling a partition for new changes on the feed, after all current changes are drained. Default is 5,000 milliseconds, or 5 seconds. |
lease |
When set, it defines, in milliseconds, the interval to kick off a task to compute if partitions are distributed evenly among known host instances. Default is 13000 (13 seconds). |
lease |
The name of an app setting that contains the connection string to the service which holds the lease container.
If not set it will connect to the service defined by |
lease |
The name of the container to store leases. If not set, it will use "leases" |
lease |
When set, the value is added as a prefix to the leases created in the Lease container for this function. Using a prefix allows two separate Azure Functions to share the same Lease container by using different prefixes. |
lease |
The name of the database that holds the container to store leases. If not set, it will use the value of |
lease |
When set, it defines, in milliseconds, the interval for which the lease is taken on a lease representing a partition. If the lease is not renewed within this interval, it will cause it to expire and ownership of the partition will move to another instance. Default is 60000 (60 seconds). |
lease |
When set, it defines, in milliseconds, the renew interval for all leases for partitions currently held by an instance. Default is 17000 (17 seconds). |
leases |
When |
max |
When set, this property sets the maximum number of items received per Function call. If operations in the monitored container are performed through stored procedures, transaction scope is preserved when reading items from the change feed. As a result, the number of items received could be higher than the specified value so that the items changed by the same transaction are returned as part of one atomic batch. |
preferred |
Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. Values should be comma-separated. For example, East US,South Central US,North Europe |
return | Configuration for the optional primary output of the function This is the main output that you should set as the return value of the function handler during invocation |
start |
This option tells the Trigger to read changes from the beginning of the container's change history instead of starting at the current time. Reading from the beginning only works the first time the trigger starts, as in subsequent runs, the checkpoints are already stored. Setting this option to true when there are leases already created has no effect. |
start |
Gets or sets the date and time from which to initialize the change feed read operation. The recommended format is ISO 8601 with the UTC designator, such as 2021-02-16T14:19:29Z. This is only used to set the initial trigger state. After the trigger has a lease state, changing this value has no effect. |
Property Details
handler
retry
An optional retry policy to rerun a failed execution until either successful completion occurs or the maximum number of retries is reached. Learn more here
retry?: RetryOptions
Property Value
trigger
Inherited Property Details
connection
An app setting (or environment variable) with the Cosmos DB connection string
connection: string
Property Value
string
Inherited From CosmosDBv4TriggerOptions.connection
containerName
The name of the container being monitored
containerName: string
Property Value
string
Inherited From CosmosDBv4TriggerOptions.containerName
createLeaseContainerIfNotExists
Checks for existence and automatically creates the leases container. Default is false
createLeaseContainerIfNotExists?: boolean
Property Value
boolean
Inherited From CosmosDBv4TriggerOptions.createLeaseContainerIfNotExists
databaseName
The name of the Azure Cosmos DB database with the container being monitored
databaseName: string
Property Value
string
Inherited From CosmosDBv4TriggerOptions.databaseName
extraInputs
Configuration for an optional set of secondary inputs
During invocation, get these values with context.extraInputs.get()
extraInputs?: FunctionInput[]
Property Value
Inherited From Partial.extraInputs
extraOutputs
Configuration for an optional set of secondary outputs
During invocation, set these values with context.extraOutputs.set()
extraOutputs?: FunctionOutput[]
Property Value
Inherited From Partial.extraOutputs
feedPollDelay
The time (in milliseconds) for the delay between polling a partition for new changes on the feed, after all current changes are drained. Default is 5,000 milliseconds, or 5 seconds.
feedPollDelay?: number
Property Value
number
Inherited From CosmosDBv4TriggerOptions.feedPollDelay
leaseAcquireInterval
When set, it defines, in milliseconds, the interval to kick off a task to compute if partitions are distributed evenly among known host instances. Default is 13000 (13 seconds).
leaseAcquireInterval?: number
Property Value
number
Inherited From CosmosDBv4TriggerOptions.leaseAcquireInterval
leaseConnection
The name of an app setting that contains the connection string to the service which holds the lease container.
If not set it will connect to the service defined by connection
leaseConnection?: string
Property Value
string
Inherited From CosmosDBv4TriggerOptions.leaseConnection
leaseContainerName
The name of the container to store leases. If not set, it will use "leases"
leaseContainerName?: string
Property Value
string
Inherited From CosmosDBv4TriggerOptions.leaseContainerName
leaseContainerPrefix
When set, the value is added as a prefix to the leases created in the Lease container for this function. Using a prefix allows two separate Azure Functions to share the same Lease container by using different prefixes.
leaseContainerPrefix?: string
Property Value
string
Inherited From CosmosDBv4TriggerOptions.leaseContainerPrefix
leaseDatabaseName
The name of the database that holds the container to store leases. If not set, it will use the value of databaseName
leaseDatabaseName?: string
Property Value
string
Inherited From CosmosDBv4TriggerOptions.leaseDatabaseName
leaseExpirationInterval
When set, it defines, in milliseconds, the interval for which the lease is taken on a lease representing a partition. If the lease is not renewed within this interval, it will cause it to expire and ownership of the partition will move to another instance. Default is 60000 (60 seconds).
leaseExpirationInterval?: number
Property Value
number
Inherited From CosmosDBv4TriggerOptions.leaseExpirationInterval
leaseRenewInterval
When set, it defines, in milliseconds, the renew interval for all leases for partitions currently held by an instance. Default is 17000 (17 seconds).
leaseRenewInterval?: number
Property Value
number
Inherited From CosmosDBv4TriggerOptions.leaseRenewInterval
leasesContainerThroughput
When createLeaseContainerIfNotExists
is set to true
, defines the amount of Request Units to assign to the created lease container
leasesContainerThroughput?: number
Property Value
number
Inherited From CosmosDBv4TriggerOptions.leasesContainerThroughput
maxItemsPerInvocation
When set, this property sets the maximum number of items received per Function call. If operations in the monitored container are performed through stored procedures, transaction scope is preserved when reading items from the change feed. As a result, the number of items received could be higher than the specified value so that the items changed by the same transaction are returned as part of one atomic batch.
maxItemsPerInvocation?: number
Property Value
number
Inherited From CosmosDBv4TriggerOptions.maxItemsPerInvocation
preferredLocations
Defines preferred locations (regions) for geo-replicated database accounts in the Azure Cosmos DB service. Values should be comma-separated. For example, East US,South Central US,North Europe
preferredLocations?: string
Property Value
string
Inherited From CosmosDBv4TriggerOptions.preferredLocations
return
Configuration for the optional primary output of the function This is the main output that you should set as the return value of the function handler during invocation
return?: FunctionOutput
Property Value
Inherited From Partial.return
startFromBeginning
This option tells the Trigger to read changes from the beginning of the container's change history instead of starting at the current time. Reading from the beginning only works the first time the trigger starts, as in subsequent runs, the checkpoints are already stored. Setting this option to true when there are leases already created has no effect.
startFromBeginning?: boolean
Property Value
boolean
Inherited From CosmosDBv4TriggerOptions.startFromBeginning
startFromTime
Gets or sets the date and time from which to initialize the change feed read operation. The recommended format is ISO 8601 with the UTC designator, such as 2021-02-16T14:19:29Z. This is only used to set the initial trigger state. After the trigger has a lease state, changing this value has no effect.
startFromTime?: string
Property Value
string
Inherited From CosmosDBv4TriggerOptions.startFromTime