ServiceBusTopicFunctionOptions interface

Package:

@azure/functions

Extends

ServiceBusTopicTriggerOptions,Partial<FunctionOptions>

Properties

handler
trigger

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 subscription. Default is false
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
subscriptionName	The name of the subscription to monitor
topicName	The name of the topic to monitor

Property Details

handler

handler: ServiceBusTopicHandler

Property Value

ServiceBusTopicHandler

trigger

trigger?: ServiceBusTopicTrigger

Property Value

ServiceBusTopicTrigger

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 ServiceBusTopicTriggerOptions.cardinality

connection

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

connection: string

Property Value

string

Inherited From ServiceBusTopicTriggerOptions.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 subscription. Default is false

isSessionsEnabled?: boolean

Property Value

boolean

Inherited From ServiceBusTopicTriggerOptions.isSessionsEnabled

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

subscriptionName

The name of the subscription to monitor

subscriptionName: string

Property Value

string

Inherited From ServiceBusTopicTriggerOptions.subscriptionName

topicName

The name of the topic to monitor

topicName: string

Property Value

string

Inherited From ServiceBusTopicTriggerOptions.topicName