You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-functions/functions-bindings-signalr-service-input.md
+21-13Lines changed: 21 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -321,17 +321,20 @@ The following table explains the properties of the `SignalRConnectionInfo` attri
321
321
|**hubName**| Required. The hub name. |
322
322
|**ConnectionStringSetting**| The name of the app setting that contains the SignalR Service connection string, which defaults to `AzureSignalRConnectionString`. |
323
323
|**UserId**| Optional. The user identifier of a SignalR connection. You can use a [binding expression](#binding-expressions-for-http-trigger) to bind the value to a HTTP request header or query. |
324
-
|**IdToken**| Optional. A JWT token whose claims will be added to the user claims. You can use a [binding expression](#binding-expressions-for-http-trigger) to bind the value to a HTTP request header or query. For example, `{query.token}` binds the value of the parameter of `token` in the query string `https://functionhost.com/negotiate?token=xxxx` . |
324
+
|**IdToken**| Optional. A JWT token whose claims will be added to the user claims. It should be used together with **ClaimTypeList**. You can use a [binding expression](#binding-expressions-for-http-trigger) to bind the value to a HTTP request header or query. |
325
+
|**ClaimTypeList**| Optional. A list of claim types which filter the claims in **IdToken** . |
325
326
326
327
# [Isolated process](#tab/isolated-process)
327
328
328
329
The following table explains the properties of the `SignalRConnectionInfoInput` attribute:
329
330
330
331
| Attribute property |Description|
331
332
|---------|----------------------|
332
-
**HubName**| This value must be set to the name of the SignalR hub for which the connection information is generated. |
333
+
|**hubName**|Required. The hub name. |
333
334
|**ConnectionStringSetting**| The name of the app setting that contains the SignalR Service connection string, which defaults to `AzureSignalRConnectionString`. |
334
-
|**UserId**| Optional. The user identifier of a SignalR connection. You can use a [binding expression](./functions-bindings-expressions-patterns.md) to bind the value to a HTTP request header or query. |
335
+
|**UserId**| Optional. The user identifier of a SignalR connection. You can use a [binding expression](#binding-expressions-for-http-trigger) to bind the value to a HTTP request header or query. |
336
+
|**IdToken**| Optional. A JWT token whose claims will be added to the user claims. It should be used together with **ClaimTypeList**. You can use a [binding expression](#binding-expressions-for-http-trigger) to bind the value to a HTTP request header or query. |
337
+
|**ClaimTypeList**| Optional. A list of claim types which filter the claims in **IdToken** . |
335
338
336
339
# [C# Script](#tab/csharp-script)
337
340
@@ -342,9 +345,11 @@ The following table explains the binding configuration properties that you set i
342
345
|**type**| Must be set to `signalRConnectionInfo`.|
343
346
|**direction**| Must be set to `in`.|
344
347
|**name**| Variable name used in function code for connection info object. |
345
-
|**hubName**| This value must be set to the name of the SignalR hub for which the connection information is generated.|
346
-
|**userId**| Optional: The value of the user identifier claim to be set in the access key token. |
347
-
|**connectionStringSetting**| The name of the app setting that contains the SignalR Service connection string, which defaults to `AzureSignalRConnectionString`. |
348
+
|**hubName**| Required. The hub name. |
349
+
|**ConnectionStringSetting**| The name of the app setting that contains the SignalR Service connection string, which defaults to `AzureSignalRConnectionString`. |
350
+
|**UserId**| Optional. The user identifier of a SignalR connection. You can use a [binding expression](#binding-expressions-for-http-trigger) to bind the value to a HTTP request header or query. |
351
+
|**IdToken**| Optional. A JWT token whose claims will be added to the user claims. It should be used together with **ClaimTypeList**. You can use a [binding expression](#binding-expressions-for-http-trigger) to bind the value to a HTTP request header or query. |
352
+
|**ClaimTypeList**| Optional. A list of claim types which filter the claims in **IdToken** . |
348
353
349
354
---
350
355
@@ -359,9 +364,11 @@ The following table explains the supported settings for the `SignalRConnectionIn
359
364
|Setting | Description|
360
365
|---------|--------|
361
366
|**name**| Variable name used in function code for connection info object. |
362
-
|**hubName**| The hub name. Required. |
363
-
|**userId**| Optional: The value of the user identifier claim to be set in the access key token. |
364
-
|**connectionStringSetting**| The name of the app setting that contains the SignalR Service connection string, which defaults to `AzureSignalRConnectionString`. |
367
+
|**hubName**| Required. The hub name. |
368
+
|**ConnectionStringSetting**| The name of the app setting that contains the SignalR Service connection string, which defaults to `AzureSignalRConnectionString`. |
369
+
|**UserId**| Optional. The user identifier of a SignalR connection. You can use a [binding expression](#binding-expressions-for-http-trigger) to bind the value to a HTTP request header or query. |
370
+
|**IdToken**| Optional. A JWT token whose claims will be added to the user claims. It should be used together with **ClaimTypeList**. You can use a [binding expression](#binding-expressions-for-http-trigger) to bind the value to a HTTP request header or query. |
371
+
|**ClaimTypeList**| Optional. A list of claim types which filter the claims in **IdToken** . |
365
372
366
373
::: zone-end
367
374
::: zone pivot="programming-language-javascript,programming-language-powershell,programming-language-python"
@@ -373,10 +380,11 @@ The following table explains the binding configuration properties that you set i
373
380
|---------|--------|
374
381
|**type**| Must be set to `signalRConnectionInfo`.|
375
382
|**direction**| Must be set to `in`.|
376
-
|**name**| Variable name used in function code for connection info object. |
377
-
|**hubName**| This value must be set to the name of the SignalR hub for which the connection information is generated.|
378
-
|**userId**| Optional: The value of the user identifier claim to be set in the access key token. |
379
-
|**connectionStringSetting**| The name of the app setting that contains the SignalR Service connection string, which defaults to `AzureSignalRConnectionString`. |
383
+
|**hubName**| Required. The hub name. |
384
+
|**ConnectionStringSetting**| The name of the app setting that contains the SignalR Service connection string, which defaults to `AzureSignalRConnectionString`. |
385
+
|**UserId**| Optional. The user identifier of a SignalR connection. You can use a [binding expression](#binding-expressions-for-http-trigger) to bind the value to a HTTP request header or query. |
386
+
|**IdToken**| Optional. A JWT token whose claims will be added to the user claims. It should be used together with **ClaimTypeList**. You can use a [binding expression](#binding-expressions-for-http-trigger) to bind the value to a HTTP request header or query. |
387
+
|**ClaimTypeList**| Optional. A list of claim types which filter the claims in **IdToken** . |
0 commit comments