EventHubTriggerOptions interface

Package:

@azure/functions

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.

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"

connection

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

connection: string

Property Value

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.

consumerGroup?: string

Property Value

string

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