Skip to content

Commit 5e2a1f7

Browse files
committed
Fix issues
1 parent f95845d commit 5e2a1f7

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

articles/azure-signalr/signalr-howto-use.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ ms.author: lianwei
1010

1111
# Use Azure SignalR Service
1212

13-
## Provision an Azure SignalR Service instance
13+
## Create an Azure SignalR Service instance
1414

15-
Follow [Quickstart: Use an ARM template to deploy Azure SignalR](./signalr-quickstart-azure-signalr-service-arm-template.md) to provision a SignalR service instance.
15+
Follow [Quickstart: Use an ARM template to deploy Azure SignalR](./signalr-quickstart-azure-signalr-service-arm-template.md) to create a SignalR service instance.
1616

1717
## For ASP.NET Core SignalR
1818

1919
### 1. Install the SDK
2020

21-
Run below command to install SignalR Service SDK to your ASP.NET Core project.
21+
Run the command to install SignalR Service SDK to your ASP.NET Core project.
2222

2323
```bash
2424
dotnet add package Microsoft.Azure.SignalR
@@ -48,7 +48,7 @@ There are two approaches to configure SignalR Service's connection string in you
4848

4949
- Set an environment variable with name `Azure:SignalR:ConnectionString` or `Azure__SignalR__ConnectionString`.
5050
- In Azure App Service, put it in application settings.
51-
- Pass the connection string as a parameter of `AddAzureSignalR()` as below sample codes.
51+
- Pass the connection string as a parameter of `AddAzureSignalR()`.
5252

5353
```csharp
5454
services.AddSignalR()
@@ -69,17 +69,17 @@ There are a few [options](https://github.com/Azure/azure-signalr/blob/dev/src/Mi
6969
#### `ConnectionString`
7070

7171
- Default value is the `Azure:SignalR:ConnectionString` `connectionString` or `appSetting` in `web.config` file.
72-
- It can be reconfigured, but please make sure the value is **NOT** hard coded.
72+
- It can be reconfigured, but make sure the value is **NOT** hard coded.
7373

7474
#### `InitialHubServerConnectionCount`
7575

7676
- Default value is `5`.
77-
- This option controls the initial count of connections per hub between application server and Azure SignalR Service. Usually keep it as the default value is enough. During runtime, the SDK might start new server connections for performance tuning or load balancing. When you have big number of clients, you can give it a larger number for better throughput. For example, if you have 100,000 clients in total, the connection count can be increased to `10` or `15`.
77+
- This option controls the initial count of connections per hub between application server and Azure SignalR Service. Usually keep it as the default value is enough. During runtime, the SDK might start new server connections for performance tuning or load balancing. When you have large number of clients, you can give it a larger number for better throughput. For example, if you have 100,000 clients in total, the connection count can be increased to `10` or `15`.
7878

7979
#### `MaxHubServerConnectionCount`
8080

8181
- Default value is `null`.
82-
- This option controls the max count of connections allowed per hub between application server and Azure SignalR Service. During runtime, the SDK might start new server connections for performance tuning or load balancing. By default a new server connection starts whenever needed. When the max allowed server connection count is configured, the SDK does not start new connections when server connection count reaches the limit.
82+
- This option controls the max count of connections allowed per hub between application server and Azure SignalR Service. During runtime, the SDK might start new server connections for performance tuning or load balancing. By default a new server connection starts whenever needed. When the max allowed server connection count is configured, the SDK doesn't start new connections when server connection count reaches the limit.
8383

8484
#### `ApplicationName`
8585

@@ -90,23 +90,23 @@ There are a few [options](https://github.com/Azure/azure-signalr/blob/dev/src/Mi
9090

9191
- Default value is `null`.
9292
- This option controls what claims you want to associate with the client connection.
93-
It will be used when Service SDK generates access token for client in client's negotiate request.
94-
By default, all claims from `HttpContext.User` of the negotiate request will be reserved.
93+
It is used when Service SDK generates access token for client in client's negotiate request.
94+
By default, all claims from `HttpContext.User` of the negotiated request are reserved.
9595
They can be accessed at [`Hub.Context.User`](/dotnet/api/microsoft.aspnetcore.signalr.hubcallercontext.user).
96-
- Normally you should leave this option as is. Make sure you understand what will happen before customizing it.
96+
- Normally you should leave this option as is. Make sure you understand what happens before customizing it.
9797

9898
#### `AccessTokenLifetime`
9999

100100
- Default value is `1 hour`.
101-
- This option controls the valid lifetime of the access token, which is generated by Service SDK for each client.
101+
- This option controls the valid lifetime of the access token, that Service SDK generates for each client.
102102
The access token is returned in the response to client's negotiate request.
103-
- When `ServerSentEvent` or `LongPolling` is used as transport, client connection will be closed due to authentication failure after the expire time.
103+
- When `ServerSentEvent` or `LongPolling` is used as transport, client connection will be closed due to authentication failure after the expired time.
104104
You can increase this value to avoid client disconnect.
105105

106106
#### `AccessTokenAlgorithm`
107107

108108
- Default value is `HS256`
109-
- This option provides choice of [`SecurityAlgorithms`](https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/blob/dev/src/Microsoft.IdentityModel.Tokens/SecurityAlgorithms.cs) when generate access token. Now supported optional values are `HS256` and `HS512`. Please note `HS512` is more secure but the generated token will be comparatively longer than that using `HS256`.
109+
- This option provides choice of [`SecurityAlgorithms`](https://github.com/AzureAD/azure-activedirectory-identitymodel-extensions-for-dotnet/blob/dev/src/Microsoft.IdentityModel.Tokens/SecurityAlgorithms.cs) when generate access token. Now supported optional values are `HS256` and `HS512`. Note `HS512` is more secure but the generated token is comparatively longer than that using `HS256`.
110110
111111
#### `ServerStickyMode`
112112

0 commit comments

Comments
 (0)