-
Notifications
You must be signed in to change notification settings - Fork 180
/
UpstreamTemplate.yml
103 lines (98 loc) · 3.65 KB
/
UpstreamTemplate.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
### YamlMime:TSType
name: UpstreamTemplate
uid: '@azure/arm-signalr.UpstreamTemplate'
package: '@azure/arm-signalr'
summary: >-
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.
fullName: UpstreamTemplate
remarks: ''
isDeprecated: false
type: interface
properties:
- name: auth
uid: '@azure/arm-signalr.UpstreamTemplate.auth'
package: '@azure/arm-signalr'
summary: Upstream auth settings. If not set, no auth is used for upstream messages.
fullName: auth
remarks: ''
isDeprecated: false
syntax:
content: 'auth?: UpstreamAuthSettings'
return:
description: ''
type: <xref uid="@azure/arm-signalr.UpstreamAuthSettings" />
- name: categoryPattern
uid: '@azure/arm-signalr.UpstreamTemplate.categoryPattern'
package: '@azure/arm-signalr'
summary: >-
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".
fullName: categoryPattern
remarks: ''
isDeprecated: false
syntax:
content: 'categoryPattern?: string'
return:
description: ''
type: string
- name: eventPattern
uid: '@azure/arm-signalr.UpstreamTemplate.eventPattern'
package: '@azure/arm-signalr'
summary: >-
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".
fullName: eventPattern
remarks: ''
isDeprecated: false
syntax:
content: 'eventPattern?: string'
return:
description: ''
type: string
- name: hubPattern
uid: '@azure/arm-signalr.UpstreamTemplate.hubPattern'
package: '@azure/arm-signalr'
summary: >-
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".
fullName: hubPattern
remarks: ''
isDeprecated: false
syntax:
content: 'hubPattern?: string'
return:
description: ''
type: string
- name: urlTemplate
uid: '@azure/arm-signalr.UpstreamTemplate.urlTemplate'
package: '@azure/arm-signalr'
summary: >-
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`.
fullName: urlTemplate
remarks: ''
isDeprecated: false
syntax:
content: 'urlTemplate: string'
return:
description: ''
type: string