EventHubFunctionOptions interface

Package:

@azure/functions

Extends

EventHubTriggerOptions,Partial<FunctionOptions>

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 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 event hub connection string
consumerGroup	An optional property that sets the consumer group used to subscribe to events in the hub. If omitted, the $Default consumer group is used.
eventHubName	The name of the event hub. When the event hub name is also present in the connection string, that value overrides this property at runtime.
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()
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: EventHubHandler

Property Value

EventHubHandler

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

RetryOptions

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

Property Value

EventHubTrigger

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

connection

An app setting (or environment variable) with the event hub connection string

connection: string

Property Value

string

Inherited From EventHubTriggerOptions.connection

consumerGroup

An optional property that sets the consumer group used to subscribe to events in the hub. If omitted, the $Default consumer group is used.

consumerGroup?: string

Property Value

string

Inherited From EventHubTriggerOptions.consumerGroup

eventHubName

The name of the event hub. When the event hub name is also present in the connection string, that value overrides this property at runtime.

eventHubName: string

Property Value

string

Inherited From EventHubTriggerOptions.eventHubName

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

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