ServiceBusQueueFunctionOptions interface

Package:
@azure/functions
Extends

ServiceBusQueueTriggerOptions,Partial<FunctionOptions>

Properties

handler

The code that will be executed when your function is triggered
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 in order to enable batching. If omitted or set to one, a single message is passed to the function.
connection

An app setting (or environment variable) with the service bus connection string
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()
isSessionsEnabled

true if connecting to a session-aware queue. Default is false
queueName

The name of the queue to monitor
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

Property Details

handler

The code that will be executed when your function is triggered

handler: ServiceBusQueueHandler

Property Value

ServiceBusQueueHandler

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?: ServiceBusQueueTrigger

Property Value

ServiceBusQueueTrigger

Inherited Property Details

cardinality

Set to many in order to enable batching. If omitted or set to one, a single message is passed to the function.

cardinality?: "many" | "one"

Property Value

"many" | "one"

Inherited From ServiceBusQueueTriggerOptions.cardinality

connection

An app setting (or environment variable) with the service bus connection string

connection: string

Property Value

string

Inherited From ServiceBusQueueTriggerOptions.connection

extraInputs

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

extraInputs?: FunctionInput[]

Property Value

FunctionInput[]

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

FunctionOutput[]

Inherited From Partial.extraOutputs

isSessionsEnabled

true if connecting to a session-aware queue. Default is false

isSessionsEnabled?: boolean

Property Value

boolean

Inherited From ServiceBusQueueTriggerOptions.isSessionsEnabled

queueName

The name of the queue to monitor

queueName: string

Property Value

string

Inherited From ServiceBusQueueTriggerOptions.queueName

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

FunctionOutput

Inherited From Partial.return