Share via

EventHandler interface

  • Reference
Package:
@azure/arm-webpubsub

Properties of event handler.

Properties

auth

Upstream auth settings. If not set, no auth is used for upstream messages.
systemEvents

Gets or sets the list of system events.
urlTemplate

Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event}. The host part can't contains parameters.
userEventPattern

Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"

Property Details

auth

Upstream auth settings. If not set, no auth is used for upstream messages.

auth?: UpstreamAuthSettings

Property Value

UpstreamAuthSettings

systemEvents

Gets or sets the list of system events.

systemEvents?: string[]

Property Value

string[]

urlTemplate

Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event}. The host part can't contains parameters.

urlTemplate: string

Property Value

string

userEventPattern

Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"

userEventPattern?: string

Property Value

string