EventHandlerTemplate | @azure/arm-webpubsub

EventHandler template item settings.

Hierarchy

EventHandlerTemplate

Index

Properties

Optional auth

auth: UpstreamAuthSettings

Gets or sets the auth settings for an event handler. If not set, no auth is used.

Optional systemEventPattern

systemEventPattern: undefined | string

Gets ot sets the system event pattern. There are 2 kind of patterns supported: 1. The single event name, for example, "connect", it matches "connect" 2. Combine multiple events with ",", for example "connect,disconnected", it matches event "connect" and "disconnected"

urlTemplate

urlTemplate: string

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.

Optional userEventPattern

userEventPattern: undefined | string

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