Skip to content

Commit 6b88a6e

Browse files
authored
Merge pull request #127595 from yjin81/master
Update the quick start and tutorial of Azure SignalR Service
2 parents 2ba4ed7 + 8115513 commit 6b88a6e

8 files changed

+129
-6
lines changed

articles/azure-signalr/signalr-quickstart-azure-functions-csharp.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,22 @@ You may also run this tutorial on the command line (macOS, Windows, or Linux) us
2121

2222
[!INCLUDE [quickstarts-free-trial-note](../../includes/quickstarts-free-trial-note.md)]
2323

24+
[Having issues? Let us know.](https://aka.ms/asrs/qscsharp)
25+
2426
## Log in to Azure
2527

2628
Sign in to the Azure portal at <https://portal.azure.com/> with your Azure account.
2729

30+
[Having issues? Let us know.](https://aka.ms/asrs/qscsharp)
31+
2832
[!INCLUDE [Create instance](includes/signalr-quickstart-create-instance.md)]
2933

34+
[Having issues? Let us know.](https://aka.ms/asrs/qscsharp)
35+
3036
[!INCLUDE [Clone application](includes/signalr-quickstart-clone-application.md)]
3137

38+
[Having issues? Let us know.](https://aka.ms/asrs/qscsharp)
39+
3240
## Configure and run the Azure Function app
3341

3442
1. Start Visual Studio (or another code editor) and open the solution in the *src/chat/csharp* folder of the cloned repository.
@@ -61,14 +69,21 @@ Sign in to the Azure portal at <https://portal.azure.com/> with your Azure accou
6169
```bash
6270
func start
6371
```
72+
[Having issues? Let us know.](https://aka.ms/asrs/qscsharp)
6473

6574
[!INCLUDE [Run web application](includes/signalr-quickstart-run-web-application.md)]
6675

76+
[Having issues? Let us know.](https://aka.ms/asrs/qscsharp)
77+
6778
[!INCLUDE [Cleanup](includes/signalr-quickstart-cleanup.md)]
6879

80+
[Having issues? Let us know.](https://aka.ms/asrs/qscsharp)
81+
6982
## Next steps
7083

7184
In this quickstart, you built and ran a real-time serverless application in Visual Studio. Next, learn more about how to develop and deploy Azure Functions with Visual Studio.
7285

7386
> [!div class="nextstepaction"]
74-
> [Develop Azure Functions using Visual Studio](../azure-functions/functions-develop-vs.md)
87+
> [Develop Azure Functions using Visual Studio](../azure-functions/functions-develop-vs.md)
88+
89+
[Having issues? Let us know.](https://aka.ms/asrs/qscsharp)

articles/azure-signalr/signalr-quickstart-azure-functions-java.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,22 @@ Azure SignalR Service lets you easily add real-time functionality to your applic
3232
> [!NOTE]
3333
> This quickstart can be run on macOS, Windows, or Linux.
3434
35+
[Having issues? Let us know.](https://aka.ms/asrs/qsjava)
36+
3537
## Log in to Azure
3638

3739
Sign in to the Azure portal at <https://portal.azure.com/> with your Azure account.
3840

41+
[Having issues? Let us know.](https://aka.ms/asrs/qsjava)
42+
3943
[!INCLUDE [Create instance](includes/signalr-quickstart-create-instance.md)]
4044

45+
[Having issues? Let us know.](https://aka.ms/asrs/qsjava)
46+
4147
[!INCLUDE [Clone application](includes/signalr-quickstart-clone-application.md)]
4248

49+
[Having issues? Let us know.](https://aka.ms/asrs/qsjava)
50+
4351
## Configure and run the Azure Function app
4452

4553
1. In the browser where the Azure portal is opened, confirm the SignalR Service instance you deployed earlier was successfully created by searching for its name in the search box at the top of the portal. Select the instance to open it.
@@ -74,14 +82,21 @@ Sign in to the Azure portal at <https://portal.azure.com/> with your Azure accou
7482
```bash
7583
mvn azure-functions:run
7684
```
85+
[Having issues? Let us know.](https://aka.ms/asrs/qsjava)
7786

7887
[!INCLUDE [Run web application](includes/signalr-quickstart-run-web-application.md)]
7988

89+
[Having issues? Let us know.](https://aka.ms/asrs/qsjava)
90+
8091
[!INCLUDE [Cleanup](includes/signalr-quickstart-cleanup.md)]
8192

93+
[Having issues? Let us know.](https://aka.ms/asrs/qsjava)
94+
8295
## Next steps
8396

8497
In this quickstart, you built and ran a real-time serverless application using Maven. Next, learn about how to create Java Azure Functions from scratch.
8598

8699
> [!div class="nextstepaction"]
87-
> [Create your first function with Java and Maven](../azure-functions/functions-create-first-java-maven.md)
100+
> [Create your first function with Java and Maven](../azure-functions/functions-create-first-java-maven.md)
101+
102+
[Having issues? Let us know.](https://aka.ms/asrs/qsjava)

articles/azure-signalr/signalr-quickstart-azure-functions-javascript.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,22 @@ Azure SignalR Service lets you easily add real-time functionality to your applic
2626
> [!NOTE]
2727
> This quickstart can be run on macOS, Windows, or Linux.
2828
29+
[Having issues? Let us know.](https://aka.ms/asrs/qsjs)
30+
2931
## Log in to Azure
3032

3133
Sign in to the Azure portal at <https://portal.azure.com/> with your Azure account.
3234

35+
[Having issues? Let us know.](https://aka.ms/asrs/qsjs)
36+
3337
[!INCLUDE [Create instance](includes/signalr-quickstart-create-instance.md)]
3438

39+
[Having issues? Let us know.](https://aka.ms/asrs/qsjs)
40+
3541
[!INCLUDE [Clone application](includes/signalr-quickstart-clone-application.md)]
3642

43+
[Having issues? Let us know.](https://aka.ms/asrs/qsjs)
44+
3745
## Configure and run the Azure Function app
3846

3947
1. In the browser where the Azure portal is opened, confirm the SignalR Service instance you deployed earlier was successfully created by searching for its name in the search box at the top of the portal. Select the instance to open it.
@@ -65,13 +73,21 @@ Sign in to the Azure portal at <https://portal.azure.com/> with your Azure accou
6573

6674
![Create SignalR Service](media/signalr-quickstart-azure-functions-javascript/signalr-quickstart-run-application.png)
6775

76+
[Having issues? Let us know.](https://aka.ms/asrs/qsjs)
77+
6878
[!INCLUDE [Run web application](includes/signalr-quickstart-run-web-application.md)]
6979

80+
[Having issues? Let us know.](https://aka.ms/asrs/qsjs)
81+
7082
[!INCLUDE [Cleanup](includes/signalr-quickstart-cleanup.md)]
7183

84+
[Having issues? Let us know.](https://aka.ms/asrs/qsjs)
85+
7286
## Next steps
7387

7488
In this quickstart, you built and ran a real-time serverless application in VS Code. Next, learn more about how to deploy Azure Functions from VS Code.
7589

7690
> [!div class="nextstepaction"]
7791
> [Deploy Azure Functions with VS Code](/azure/developer/javascript/tutorial-vscode-serverless-node-01)
92+
93+
[Having issues? Let us know.](https://aka.ms/asrs/qsjs)

articles/azure-signalr/signalr-quickstart-azure-functions-python.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,22 @@ Azure Functions requires [Python 3.6 or 3.7](https://www.python.org/downloads/).
2525

2626
[!INCLUDE [quickstarts-free-trial-note](../../includes/quickstarts-free-trial-note.md)]
2727

28+
[Having issues? Let us know.](https://aka.ms/asrs/qspython)
29+
2830
## Log in to Azure
2931

3032
Sign in to the Azure portal at <https://portal.azure.com/> with your Azure account.
3133

34+
[Having issues? Let us know.](https://aka.ms/asrs/qspython)
35+
3236
[!INCLUDE [Create instance](includes/signalr-quickstart-create-instance.md)]
3337

38+
[Having issues? Let us know.](https://aka.ms/asrs/qspython)
39+
3440
[!INCLUDE [Clone application](includes/signalr-quickstart-clone-application.md)]
3541

42+
[Having issues? Let us know.](https://aka.ms/asrs/qspython)
43+
3644
## Configure and run the Azure Function app
3745

3846
1. In the browser where the Azure portal is opened, confirm the SignalR Service instance you deployed earlier was successfully created by searching for its name in the search box at the top of the portal. Select the instance to open it.
@@ -85,14 +93,22 @@ Sign in to the Azure portal at <https://portal.azure.com/> with your Azure accou
8593
```
8694

8795
![Run function app](media/signalr-quickstart-azure-functions-python/signalr-quickstart-run-application.png)
96+
97+
[Having issues? Let us know.](https://aka.ms/asrs/qspython)
8898

8999
[!INCLUDE [Run web application](includes/signalr-quickstart-run-web-application.md)]
90100

101+
[Having issues? Let us know.](https://aka.ms/asrs/qspython)
102+
91103
[!INCLUDE [Cleanup](includes/signalr-quickstart-cleanup.md)]
92104

105+
[Having issues? Let us know.](https://aka.ms/asrs/qspython)
106+
93107
## Next steps
94108

95109
In this quickstart, you built and ran a real-time serverless application in VS Code. Next, learn more about how to deploy Azure Functions from VS Code.
96110

97111
> [!div class="nextstepaction"]
98112
> [Deploy Azure Functions with VS Code](/azure/developer/javascript/tutorial-vscode-serverless-node-01)
113+
114+
[Having issues? Let us know.](https://aka.ms/asrs/qspython)

articles/azure-signalr/signalr-quickstart-dotnet-core.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,14 @@ The code for this tutorial is available for download in the [AzureSignalR-sample
2828
* Install the [.NET Core SDK](https://www.microsoft.com/net/download/windows).
2929
* Download or clone the [AzureSignalR-sample](https://github.com/aspnet/AzureSignalR-samples) GitHub repository.
3030

31+
[Having issues? Let us know.](https://aka.ms/asrs/qsnetcore)
32+
3133
## Create an Azure SignalR resource
3234

3335
[!INCLUDE [azure-signalr-create](../../includes/signalr-create.md)]
3436

37+
[Having issues? Let us know.](https://aka.ms/asrs/qsnetcore)
38+
3539
## Create an ASP.NET Core web app
3640

3741
In this section, you use the [.NET Core command-line interface (CLI)](https://docs.microsoft.com/dotnet/core/tools/) to create an ASP.NET Core MVC web app project. The advantage of using the .NET Core CLI over Visual Studio is that it's available across the Windows, macOS, and Linux platforms.
@@ -44,6 +48,7 @@ In this section, you use the [.NET Core command-line interface (CLI)](https://do
4448
dotnet new mvc
4549
```
4650
51+
[Having issues? Let us know.](https://aka.ms/asrs/qsnetcore)
4752
4853
## Add Secret Manager to the project
4954
@@ -66,6 +71,8 @@ In this section, you'll add the [Secret Manager tool](https://docs.microsoft.com
6671
</ItemGroup>
6772
</Project>
6873
```
74+
75+
[Having issues? Let us know.](https://aka.ms/asrs/qsnetcore)
6976
7077
## Add Azure SignalR to the web app
7178
@@ -220,6 +227,7 @@ In this section, you'll add a development runtime environment for ASP.NET Core.
220227
}
221228
```
222229

230+
[Having issues? Let us know.](https://aka.ms/asrs/qsnetcore)
223231

224232
## Build and run the app locally
225233

@@ -249,7 +257,7 @@ In this section, you'll add a development runtime environment for ASP.NET Core.
249257

250258
![Example of an Azure SignalR group chat](media/signalr-quickstart-dotnet-core/signalr-quickstart-complete-local.png)
251259

252-
260+
[Having issues? Let us know.](https://aka.ms/asrs/qsnetcore)
253261

254262
## Clean up resources
255263

@@ -274,7 +282,7 @@ You're asked to confirm the deletion of the resource group. Enter the name of yo
274282

275283
After a few moments, the resource group and all of its resources are deleted.
276284

277-
285+
[Having issues? Let us know.](https://aka.ms/asrs/qsnetcore)
278286

279287
## Next steps
280288

@@ -283,4 +291,5 @@ In this quickstart, you created a new Azure SignalR Service resource. You then u
283291
> [!div class="nextstepaction"]
284292
> [Azure SignalR Service authentication](./signalr-concept-authenticate-oauth.md)
285293

294+
[Having issues? Let us know.](https://aka.ms/asrs/qsnetcore)
286295

articles/azure-signalr/signalr-quickstart-dotnet.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,22 @@ In this quickstart, you will learn how to get started with the ASP.NET and Azure
2525
* [.NET 4.6.1](https://www.microsoft.com/net/download/windows)
2626
* [ASP.NET SignalR 2.4.1](https://www.nuget.org/packages/Microsoft.AspNet.SignalR/)
2727

28+
[Having issues? Let us know.](https://aka.ms/asrs/qsnet)
29+
2830
## Sign in to Azure
2931

3032
Sign in to the [Azure portal](https://portal.azure.com/) with your Azure account.
3133

34+
[Having issues? Let us know.](https://aka.ms/asrs/qsnet)
35+
3236
[!INCLUDE [Create instance](includes/signalr-quickstart-create-instance.md)]
3337

3438
*Serverless* mode is not supported for ASP.NET SignalR applications. Always use *Default* or *Classic* for the Azure SignalR Service instance.
3539

3640
You can also create Azure resources used in this quickstart with [Create a SignalR Service script](scripts/signalr-cli-create-service.md).
3741

42+
[Having issues? Let us know.](https://aka.ms/asrs/qsnet)
43+
3844
## Clone the sample application
3945

4046
While the service is deploying, let's switch to working with code. Clone the [sample app from GitHub](https://github.com/aspnet/AzureSignalR-samples/tree/master/aspnet-samples/ChatRoom), set the SignalR Service connection string, and run the application locally.
@@ -47,6 +53,8 @@ While the service is deploying, let's switch to working with code. Clone the [sa
4753
git clone https://github.com/aspnet/AzureSignalR-samples.git
4854
```
4955

56+
[Having issues? Let us know.](https://aka.ms/asrs/qsnet)
57+
5058
## Configure and run Chat Room web app
5159

5260
1. Start Visual Studio and open the solution in the *aspnet-samples/ChatRoom/* folder of the cloned repository.
@@ -91,6 +99,8 @@ While the service is deploying, let's switch to working with code. Clone the [sa
9199
92100
1. Press **F5** to run the project in debug mode. You can see the application runs locally. Instead of hosting a SignalR runtime by application itself, it now connects to the Azure SignalR Service.
93101
102+
[Having issues? Let us know.](https://aka.ms/asrs/qsnet)
103+
94104
[!INCLUDE [Cleanup](includes/signalr-quickstart-cleanup.md)]
95105
96106
@@ -109,9 +119,14 @@ In the **Filter by name...** textbox, type the name of your resource group. The
109119
110120
After a few moments, the resource group and all of its contained resources are deleted.
111121
122+
[Having issues? Let us know.](https://aka.ms/asrs/qsnet)
123+
112124
## Next steps
113125
114126
In this quickstart, you created a new Azure SignalR Service resource and used it with an ASP.NET web app. Next, learn how to develop real-time applications using Azure SignalR Service with ASP.NET Core.
115127
116128
> [!div class="nextstepaction"]
117129
> [Azure SignalR Service with ASP.NET Core](./signalr-quickstart-dotnet-core.md)
130+
131+
[Having issues? Let us know.](https://aka.ms/asrs/qsnet)
132+

articles/azure-signalr/signalr-quickstart-rest-api.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,18 @@ This quickstart can be run on macOS, Windows, or Linux.
2222

2323
[!INCLUDE [quickstarts-free-trial-note](../../includes/quickstarts-free-trial-note.md)]
2424

25+
[Having issues? Let us know.](https://aka.ms/asrs/qsapi)
26+
2527
## Sign in to Azure
2628

2729
Sign in to the Azure portal at <https://portal.azure.com/> with your Azure account.
2830

31+
[Having issues? Let us know.](https://aka.ms/asrs/qsapi)
32+
2933
[!INCLUDE [Create instance](includes/signalr-quickstart-create-instance.md)]
3034

35+
[Having issues? Let us know.](https://aka.ms/asrs/qsapi)
36+
3137
## Clone the sample application
3238

3339
While the service is deploying, let's switch to prepare the code. Clone the [sample app from GitHub](https://github.com/aspnet/AzureSignalR-samples.git), set the SignalR Service connection string, and run the application locally.
@@ -39,6 +45,7 @@ While the service is deploying, let's switch to prepare the code. Clone the [sam
3945
```bash
4046
git clone https://github.com/aspnet/AzureSignalR-samples.git
4147
```
48+
[Having issues? Let us know.](https://aka.ms/asrs/qsapi)
4249

4350
## Build and run the sample
4451

@@ -75,6 +82,8 @@ cd bin/Release/netcoreapp2.1/osx.10.13-x64/
7582
Serverless server -c "<ConnectionString>" -h <HubName>
7683
```
7784

85+
[Having issues? Let us know.](https://aka.ms/asrs/qsapi)
86+
7887
## Run the sample without publishing
7988

8089
You can also run the command below to start a server or client
@@ -91,6 +100,8 @@ dotnet run -- client <ClientName> -c "<ConnectionString>" -h <HubName>
91100

92101
You can run `dotnet user-secrets set Azure:SignalR:ConnectionString "<ConnectionString>"` in the root directory of the sample. After that, you don't need the option `-c "<ConnectionString>"` anymore.
93102
103+
[Having issues? Let us know.](https://aka.ms/asrs/qsapi)
104+
94105
## Usage
95106
96107
After the server started, use the command to send message:
@@ -105,6 +116,8 @@ broadcast
105116
106117
You can start multiple clients with different client names.
107118
119+
[Having issues? Let us know.](https://aka.ms/asrs/qsapi)
120+
108121
## <a name="usage"> </a> Integration with third-party services
109122
110123
The Azure SignalR service allows third-party services to integrate with the system.
@@ -238,11 +251,17 @@ Response Status Code | Description
238251
`200` | Service Good
239252
`5xx` | Service Error
240253
254+
[Having issues? Let us know.](https://aka.ms/asrs/qsapi)
255+
241256
[!INCLUDE [Cleanup](includes/signalr-quickstart-cleanup.md)]
242257
258+
[Having issues? Let us know.](https://aka.ms/asrs/qsapi)
259+
243260
## Next steps
244261
245262
In this quickstart, you learned how to use REST API to broadcast real-time message from SignalR Service to clients. Next, learn more about how to develop and deploy Azure Functions with SignalR Service binding, which is built on top of REST API.
246263
247264
> [!div class="nextstepaction"]
248265
> [Develop Azure Functions using Azure SignalR Service bindings](signalr-quickstart-azure-functions-csharp.md)
266+
267+
[Having issues? Let us know.](https://aka.ms/asrs/qsapi)

0 commit comments

Comments
 (0)