SignalRUpstreamTemplate Class

Definition

Namespace:

Azure.ResourceManager.SignalR.Models

Assembly:

Azure.ResourceManager.SignalR.dll

Package:

Azure.ResourceManager.SignalR v1.1.3

Source:

SignalRUpstreamTemplate.cs

Upstream template item settings. It defines the Upstream URL of the incoming requests. The template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.

public class SignalRUpstreamTemplate : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.SignalR.Models.SignalRUpstreamTemplate>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.SignalR.Models.SignalRUpstreamTemplate>

type SignalRUpstreamTemplate = class
    interface IJsonModel<SignalRUpstreamTemplate>
    interface IPersistableModel<SignalRUpstreamTemplate>

Public Class SignalRUpstreamTemplate
Implements IJsonModel(Of SignalRUpstreamTemplate), IPersistableModel(Of SignalRUpstreamTemplate)

Inheritance

Object

SignalRUpstreamTemplate

Implements

IJsonModel<SignalRUpstreamTemplate> IPersistableModel<SignalRUpstreamTemplate> IPersistableModel<T>

Constructors

SignalRUpstreamTemplate(String)

Initializes a new instance of SignalRUpstreamTemplate.

Properties

Auth	Upstream auth settings. If not set, no auth is used for upstream messages.
CategoryPattern	Gets or sets the matching pattern for category names. If not set, it matches any category. There are 3 kind of patterns supported: 1. "*", it to matches any category name. 2. Combine multiple categories with ",", for example "connections,messages", it matches category "connections" and "messages". 3. The single category name, for example, "connections", it matches the category "connections".
EventPattern	Gets or sets the matching pattern for event names. If not set, it matches any event. There are 3 kind of patterns supported: 1. "*", it to matches any event name. 2. Combine multiple events with ",", for example "connect,disconnect", it matches event "connect" and "disconnect". 3. The single event name, for example, "connect", it matches "connect".
HubPattern	Gets or sets the matching pattern for hub names. If not set, it matches any hub. There are 3 kind of patterns supported: 1. "*", it to matches any hub name. 2. Combine multiple hubs with ",", for example "hub1,hub2", it matches "hub1" and "hub2". 3. The single hub name, for example, "hub1", it matches "hub1".
UrlTemplate	Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in. For example, if the urlTemplate is http://example.com/{hub}/api/{event}, with a client request from hub chat connects, it will first POST to this URL: http://example.com/chat/api/connect.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<SignalRUpstreamTemplate>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<SignalRUpstreamTemplate>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<SignalRUpstreamTemplate>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<SignalRUpstreamTemplate>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<SignalRUpstreamTemplate>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.