Skip to content

Commit e8c4849

Browse files
authored
Doc of all the attributes of SignalR input binding
1 parent 85bc86f commit e8c4849

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

articles/azure-functions/functions-bindings-signalr-service-input.md

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -321,17 +321,20 @@ The following table explains the properties of the `SignalRConnectionInfo` attri
321321
|**hubName**| Required. The hub name. |
322322
|**ConnectionStringSetting**| The name of the app setting that contains the SignalR Service connection string, which defaults to `AzureSignalRConnectionString`. |
323323
|**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** . |
325326

326327
# [Isolated process](#tab/isolated-process)
327328

328329
The following table explains the properties of the `SignalRConnectionInfoInput` attribute:
329330

330331
| Attribute property |Description|
331332
|---------|----------------------|
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. |
333334
|**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** . |
335338

336339
# [C# Script](#tab/csharp-script)
337340

@@ -342,9 +345,11 @@ The following table explains the binding configuration properties that you set i
342345
|**type**| Must be set to `signalRConnectionInfo`.|
343346
|**direction**| Must be set to `in`.|
344347
|**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** . |
348353

349354
---
350355

@@ -359,9 +364,11 @@ The following table explains the supported settings for the `SignalRConnectionIn
359364
|Setting | Description|
360365
|---------|--------|
361366
|**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** . |
365372

366373
::: zone-end
367374
::: 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
373380
|---------|--------|
374381
|**type**| Must be set to `signalRConnectionInfo`.|
375382
|**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** . |
380388

381389
::: zone-end
382390

0 commit comments

Comments
 (0)