Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

EventHubTriggerAttribute Class

Definition

Namespace:
Microsoft.Azure.WebJobs
Assembly:
Microsoft.Azure.WebJobs.Extensions.EventHubs.dll
Package:
Microsoft.Azure.WebJobs.Extensions.EventHubs v6.5.3
Package:
Microsoft.Azure.WebJobs.Extensions.EventHubs v6.4.0-beta.1
Source:
EventHubTriggerAttribute.cs
Source:
EventHubTriggerAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Setup an 'trigger' on a parameter to listen on events from an event hub.

[Microsoft.Azure.WebJobs.Description.Binding]
[System.AttributeUsage(System.AttributeTargets.Parameter)]
public sealed class EventHubTriggerAttribute : Attribute
[<Microsoft.Azure.WebJobs.Description.Binding>]
[<System.AttributeUsage(System.AttributeTargets.Parameter)>]
type EventHubTriggerAttribute = class
 inherit Attribute
Public NotInheritable Class EventHubTriggerAttribute
Inherits Attribute
Inheritance
EventHubTriggerAttribute
Attributes
Microsoft.Azure.WebJobs.Description.BindingAttribute AttributeUsageAttribute

Constructors

Name Description
EventHubTriggerAttribute(String)

Create an instance of this attribute.

Properties

Name Description
Connection

Gets or sets the optional app setting name that contains the Event Hub connection string. If missing, tries to use a registered event hub receiver.
ConsumerGroup

Optional Name of the consumer group. If missing, then use the default name, "$Default"
EventHubName

Name of the event hub.

Applies to

Feedback

Was this page helpful?