-
Notifications
You must be signed in to change notification settings - Fork 180
/
SignalRResource.yml
459 lines (439 loc) · 14 KB
/
SignalRResource.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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
### YamlMime:TSType
name: SignalRResource
uid: '@azure/arm-signalr.SignalRResource'
package: '@azure/arm-signalr'
summary: A class represent a resource.
fullName: SignalRResource
remarks: ''
isDeprecated: false
type: interface
properties:
- name: cors
uid: '@azure/arm-signalr.SignalRResource.cors'
package: '@azure/arm-signalr'
summary: Cross-Origin Resource Sharing (CORS) settings.
fullName: cors
remarks: ''
isDeprecated: false
syntax:
content: 'cors?: SignalRCorsSettings'
return:
description: ''
type: <xref uid="@azure/arm-signalr.SignalRCorsSettings" />
- name: disableAadAuth
uid: '@azure/arm-signalr.SignalRResource.disableAadAuth'
package: '@azure/arm-signalr'
summary: |-
DisableLocalAuth
Enable or disable aad auth
When set as true, connection with AuthType=aad won't work.
fullName: disableAadAuth
remarks: ''
isDeprecated: false
syntax:
content: 'disableAadAuth?: boolean'
return:
description: ''
type: boolean
- name: disableLocalAuth
uid: '@azure/arm-signalr.SignalRResource.disableLocalAuth'
package: '@azure/arm-signalr'
summary: |-
DisableLocalAuth
Enable or disable local auth with AccessKey
When set as true, connection with AccessKey=xxx won't work.
fullName: disableLocalAuth
remarks: ''
isDeprecated: false
syntax:
content: 'disableLocalAuth?: boolean'
return:
description: ''
type: boolean
- name: externalIP
uid: '@azure/arm-signalr.SignalRResource.externalIP'
package: '@azure/arm-signalr'
summary: >-
The publicly accessible IP of the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: externalIP
remarks: ''
isDeprecated: false
syntax:
content: 'externalIP?: string'
return:
description: ''
type: string
- name: features
uid: '@azure/arm-signalr.SignalRResource.features'
package: '@azure/arm-signalr'
summary: >-
List of the featureFlags.
FeatureFlags that are not included in the parameters for the update
operation will not be modified.
And the response will only include featureFlags that are explicitly set.
When a featureFlag is not explicitly set, its globally default value will
be used
But keep in mind, the default value doesn't mean "false". It varies in
terms of different FeatureFlags.
fullName: features
remarks: ''
isDeprecated: false
syntax:
content: 'features?: SignalRFeature[]'
return:
description: ''
type: <xref uid="@azure/arm-signalr.SignalRFeature" />[]
- name: hostName
uid: '@azure/arm-signalr.SignalRResource.hostName'
package: '@azure/arm-signalr'
summary: >-
FQDN of the service instance.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: hostName
remarks: ''
isDeprecated: false
syntax:
content: 'hostName?: string'
return:
description: ''
type: string
- name: hostNamePrefix
uid: '@azure/arm-signalr.SignalRResource.hostNamePrefix'
package: '@azure/arm-signalr'
summary: >-
Deprecated.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: hostNamePrefix
remarks: ''
isDeprecated: false
syntax:
content: 'hostNamePrefix?: string'
return:
description: ''
type: string
- name: identity
uid: '@azure/arm-signalr.SignalRResource.identity'
package: '@azure/arm-signalr'
summary: A class represent managed identities used for request and response
fullName: identity
remarks: ''
isDeprecated: false
syntax:
content: 'identity?: ManagedIdentity'
return:
description: ''
type: <xref uid="@azure/arm-signalr.ManagedIdentity" />
- name: kind
uid: '@azure/arm-signalr.SignalRResource.kind'
package: '@azure/arm-signalr'
summary: The kind of the service, it can be SignalR or RawWebSockets
fullName: kind
remarks: ''
isDeprecated: false
syntax:
content: 'kind?: string'
return:
description: ''
type: string
- name: liveTraceConfiguration
uid: '@azure/arm-signalr.SignalRResource.liveTraceConfiguration'
package: '@azure/arm-signalr'
summary: Live trace configuration of a Microsoft.SignalRService resource.
fullName: liveTraceConfiguration
remarks: ''
isDeprecated: false
syntax:
content: 'liveTraceConfiguration?: LiveTraceConfiguration'
return:
description: ''
type: <xref uid="@azure/arm-signalr.LiveTraceConfiguration" />
- name: networkACLs
uid: '@azure/arm-signalr.SignalRResource.networkACLs'
package: '@azure/arm-signalr'
summary: Network ACLs for the resource
fullName: networkACLs
remarks: ''
isDeprecated: false
syntax:
content: 'networkACLs?: SignalRNetworkACLs'
return:
description: ''
type: <xref uid="@azure/arm-signalr.SignalRNetworkACLs" />
- name: privateEndpointConnections
uid: '@azure/arm-signalr.SignalRResource.privateEndpointConnections'
package: '@azure/arm-signalr'
summary: >-
Private endpoint connections to the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: privateEndpointConnections
remarks: ''
isDeprecated: false
syntax:
content: 'privateEndpointConnections?: PrivateEndpointConnection[]'
return:
description: ''
type: <xref uid="@azure/arm-signalr.PrivateEndpointConnection" />[]
- name: provisioningState
uid: '@azure/arm-signalr.SignalRResource.provisioningState'
package: '@azure/arm-signalr'
summary: >-
Provisioning state of the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: provisioningState
remarks: ''
isDeprecated: false
syntax:
content: 'provisioningState?: string'
return:
description: ''
type: string
- name: publicNetworkAccess
uid: '@azure/arm-signalr.SignalRResource.publicNetworkAccess'
package: '@azure/arm-signalr'
summary: >-
Enable or disable public network access. Default to "Enabled".
When it's Enabled, network ACLs still apply.
When it's Disabled, public network access is always disabled no matter
what you set in network ACLs.
fullName: publicNetworkAccess
remarks: ''
isDeprecated: false
syntax:
content: 'publicNetworkAccess?: string'
return:
description: ''
type: string
- name: publicPort
uid: '@azure/arm-signalr.SignalRResource.publicPort'
package: '@azure/arm-signalr'
summary: >-
The publicly accessible port of the resource which is designed for
browser/client side usage.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: publicPort
remarks: ''
isDeprecated: false
syntax:
content: 'publicPort?: number'
return:
description: ''
type: number
- name: resourceLogConfiguration
uid: '@azure/arm-signalr.SignalRResource.resourceLogConfiguration'
package: '@azure/arm-signalr'
summary: Resource log configuration of a Microsoft.SignalRService resource.
fullName: resourceLogConfiguration
remarks: ''
isDeprecated: false
syntax:
content: 'resourceLogConfiguration?: ResourceLogConfiguration'
return:
description: ''
type: <xref uid="@azure/arm-signalr.ResourceLogConfiguration" />
- name: serverless
uid: '@azure/arm-signalr.SignalRResource.serverless'
package: '@azure/arm-signalr'
summary: Serverless settings.
fullName: serverless
remarks: ''
isDeprecated: false
syntax:
content: 'serverless?: ServerlessSettings'
return:
description: ''
type: <xref uid="@azure/arm-signalr.ServerlessSettings" />
- name: serverPort
uid: '@azure/arm-signalr.SignalRResource.serverPort'
package: '@azure/arm-signalr'
summary: >-
The publicly accessible port of the resource which is designed for
customer server side usage.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: serverPort
remarks: ''
isDeprecated: false
syntax:
content: 'serverPort?: number'
return:
description: ''
type: number
- name: sharedPrivateLinkResources
uid: '@azure/arm-signalr.SignalRResource.sharedPrivateLinkResources'
package: '@azure/arm-signalr'
summary: >-
The list of shared private link resources.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: sharedPrivateLinkResources
remarks: ''
isDeprecated: false
syntax:
content: 'sharedPrivateLinkResources?: SharedPrivateLinkResource[]'
return:
description: ''
type: <xref uid="@azure/arm-signalr.SharedPrivateLinkResource" />[]
- name: sku
uid: '@azure/arm-signalr.SignalRResource.sku'
package: '@azure/arm-signalr'
summary: The billing information of the resource.
fullName: sku
remarks: ''
isDeprecated: false
syntax:
content: 'sku?: ResourceSku'
return:
description: ''
type: <xref uid="@azure/arm-signalr.ResourceSku" />
- name: systemData
uid: '@azure/arm-signalr.SignalRResource.systemData'
package: '@azure/arm-signalr'
summary: >-
Metadata pertaining to creation and last modification of the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: systemData
remarks: ''
isDeprecated: false
syntax:
content: 'systemData?: SystemData'
return:
description: ''
type: <xref uid="@azure/arm-signalr.SystemData" />
- name: tls
uid: '@azure/arm-signalr.SignalRResource.tls'
package: '@azure/arm-signalr'
summary: TLS settings for the resource
fullName: tls
remarks: ''
isDeprecated: false
syntax:
content: 'tls?: SignalRTlsSettings'
return:
description: ''
type: <xref uid="@azure/arm-signalr.SignalRTlsSettings" />
- name: upstream
uid: '@azure/arm-signalr.SignalRResource.upstream'
package: '@azure/arm-signalr'
summary: The settings for the Upstream when the service is in server-less mode.
fullName: upstream
remarks: ''
isDeprecated: false
syntax:
content: 'upstream?: ServerlessUpstreamSettings'
return:
description: ''
type: <xref uid="@azure/arm-signalr.ServerlessUpstreamSettings" />
- name: version
uid: '@azure/arm-signalr.SignalRResource.version'
package: '@azure/arm-signalr'
summary: >-
Version of the resource. Probably you need the same or higher version of
client SDKs.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: version
remarks: ''
isDeprecated: false
syntax:
content: 'version?: string'
return:
description: ''
type: string
inheritedProperties:
- name: id
uid: '@azure/arm-signalr.SignalRResource.id'
package: '@azure/arm-signalr'
summary: >-
Fully qualified resource Id for the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: id
remarks: ''
isDeprecated: false
syntax:
content: 'id?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TrackedResource.id](xref:@azure/arm-signalr.TrackedResource.id)
- name: location
uid: '@azure/arm-signalr.SignalRResource.location'
package: '@azure/arm-signalr'
summary: >-
The GEO location of the resource. e.g. West US | East US | North Central
US | South Central US.
fullName: location
remarks: ''
isDeprecated: false
syntax:
content: 'location?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TrackedResource.location](xref:@azure/arm-signalr.TrackedResource.location)
- name: name
uid: '@azure/arm-signalr.SignalRResource.name'
package: '@azure/arm-signalr'
summary: >-
The name of the resource.
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: name
remarks: ''
isDeprecated: false
syntax:
content: 'name?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TrackedResource.name](xref:@azure/arm-signalr.TrackedResource.name)
- name: tags
uid: '@azure/arm-signalr.SignalRResource.tags'
package: '@azure/arm-signalr'
summary: >-
Tags of the service which is a list of key value pairs that describe the
resource.
fullName: tags
remarks: ''
isDeprecated: false
syntax:
content: 'tags?: {[propertyName: string]: string}'
return:
description: ''
type: '{[propertyName: string]: string}'
inheritanceDescription: >-
<b>Inherited From</b>
[TrackedResource.tags](xref:@azure/arm-signalr.TrackedResource.tags)
- name: type
uid: '@azure/arm-signalr.SignalRResource.type'
package: '@azure/arm-signalr'
summary: >-
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
NOTE: This property will not be serialized. It can only be populated by
the server.
fullName: type
remarks: ''
isDeprecated: false
syntax:
content: 'type?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[TrackedResource.type](xref:@azure/arm-signalr.TrackedResource.type)
extends: <xref uid="@azure/arm-signalr.TrackedResource" />