ConnectorTriggerFunctionOptions interface

Extends

Properties

handler

The code that will be executed when your function is triggered

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

Configuration for the primary input to the function, aka the reason it will be triggered This is the only input that is passed as an argument to the function handler during invocation

Inherited 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.

extraInputs

Configuration for an optional set of secondary inputs During invocation, get these values with context.extraInputs.get()

extraOutputs

Configuration for an optional set of secondary outputs During invocation, set these values with context.extraOutputs.set()

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.

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

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

handler

The code that will be executed when your function is triggered

handler: ConnectorTriggerHandler<T>

Property Value

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

Configuration for the primary input to the function, aka the reason it will be triggered This is the only input that is passed as an argument to the function handler during invocation

trigger?: ConnectorTrigger

Property Value

Inherited 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"

Inherited From ConnectorTriggerOptions.cardinality

connection

The connector connection setting. Required when deliveryMode is Poll.

connection?: string

Property Value

string

Inherited From ConnectorTriggerOptions.connection

deliveryMode

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

deliveryMode?: "Poll" | "Webhook"

Property Value

"Poll" | "Webhook"

Inherited From ConnectorTriggerOptions.deliveryMode

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

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

Inherited From ConnectorTriggerOptions.maxBatchSize

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

Inherited From ConnectorTriggerOptions.maxConcurrentCalls

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

targetPendingEventThreshold

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

targetPendingEventThreshold?: number

Property Value

number

Inherited From ConnectorTriggerOptions.targetPendingEventThreshold

triggerConfigName

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

triggerConfigName?: string

Property Value

string

Inherited From ConnectorTriggerOptions.triggerConfigName