ConnectorTriggerOptions interface

Extends

Record<string, unknown>

Properties

cardinality

Set to many to enable batching. If omitted or set to one, a single event is passed to the function. For batches, use an array as the handler's payload type, for example app.connectorTrigger<MyEvent[]>.

connection

The connector connection setting. Required when deliveryMode is Poll.

deliveryMode

The connector event delivery mode. If omitted, the Functions host defaults to Webhook.

maxBatchSize

An optional per-function override for the maximum number of events per batch. If omitted, Poll delivery uses the extension's app-wide host.json default.

maxConcurrentCalls

An optional per-function override for the maximum number of concurrent single-event invocations. If omitted, Poll delivery uses the extension's app-wide host.json default. Batched invocations are processed one at a time by the extension.

targetPendingEventThreshold

The target number of pending events per function instance used for scaling.

triggerConfigName

The connector trigger configuration name. Supports app setting expressions such as %TriggerConfigName%. Required when deliveryMode is Poll.

Property Details

cardinality

Set to many to enable batching. If omitted or set to one, a single event is passed to the function. For batches, use an array as the handler's payload type, for example app.connectorTrigger<MyEvent[]>.

cardinality?: "many" | "one"

Property Value

"many" | "one"

connection

The connector connection setting. Required when deliveryMode is Poll.

connection?: string

Property Value

string

deliveryMode

The connector event delivery mode. If omitted, the Functions host defaults to Webhook.

deliveryMode?: "Poll" | "Webhook"

Property Value

"Poll" | "Webhook"

maxBatchSize

An optional per-function override for the maximum number of events per batch. If omitted, Poll delivery uses the extension's app-wide host.json default.

maxBatchSize?: number

Property Value

number

maxConcurrentCalls

An optional per-function override for the maximum number of concurrent single-event invocations. If omitted, Poll delivery uses the extension's app-wide host.json default. Batched invocations are processed one at a time by the extension.

maxConcurrentCalls?: number

Property Value

number

targetPendingEventThreshold

The target number of pending events per function instance used for scaling.

targetPendingEventThreshold?: number

Property Value

number

triggerConfigName

The connector trigger configuration name. Supports app setting expressions such as %TriggerConfigName%. Required when deliveryMode is Poll.

triggerConfigName?: string

Property Value

string