Merge pull request #256718 from wchigit/how-to-signalr

Sample code for integration with SignalR

Author: v-dirichards

articles/service-connector/how-to-integrate-signalr.md

@@ -5,7 +5,7 @@ author: maud-lv
 ms.author: malev
 ms.service: service-connector
 ms.topic: how-to
-ms.date: 08/11/2022
+ms.date: 10/31/2023
 ms.custom:
 - ignite-fall-2021
 - kr2b-contr-experiment
@@ -14,7 +14,7 @@ ms.custom:
 
 # Integrate Azure SignalR Service with Service Connector
 
-This article shows the supported authentication types and client types of Azure SignalR Service using Service Connector. This article also shows default environment variable name and value or Spring Boot configuration that you get when you create the service connection. For more information, see [Service Connector environment variable naming convention](concept-service-connector-internals.md).
+This article supported authentication methods and clients, and shows sample code you can use to connect Azure SignalR Service to other cloud services using Service Connector. This article also shows default environment variable name and value or Spring Boot configuration that you get when you create the service connection. For more information about naming conventions, check the [Service Connector internals](concept-service-connector-internals.md#configuration-naming-convention) article.
 
 ## Supported compute service
 
@@ -25,15 +25,6 @@ This article shows the supported authentication types and client types of Azure
 
 Supported authentication and clients for App Service and Container Apps:
 
-### [Azure App Service](#tab/app-service)
-
-| Client type | System-assigned managed identity     | User-assigned managed identity       | Secret / connection string           | Service principal                    |
-|-------------|--------------------------------------|--------------------------------------|--------------------------------------|--------------------------------------|
-| .NET        | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) |
-| None        | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) |
-
-### [Azure Container Apps](#tab/container-apps)
-
 | Client type | System-assigned managed identity     | User-assigned managed identity       | Secret / connection string           | Service principal                    |
 |-------------|--------------------------------------|--------------------------------------|--------------------------------------|--------------------------------------|
 | .NET        | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) | ![yes icon](./media/green-check.png) |
@@ -43,35 +34,50 @@ Supported authentication and clients for App Service and Container Apps:
 
 ## Default environment variable names or application properties
 
-Use the connection details below to connect compute services to SignalR. For each example below, replace the placeholder texts
+Use environment variable names listed below to connect compute services to Azure SignalR Service. For each example below, replace the placeholder texts
 `<SignalR-name>`, `<access-key>`, `<client-ID>`, `<tenant-ID>`, and `<client-secret>` with your own SignalR name, access key, client ID, tenant ID and client secret.
 
-### .NET
-
-#### Secret / Connection string
+### System-assigned Managed Identity
 
   | Default environment variable name | Description | Example value |
   | --- | --- | --- |
-  | AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string | `Endpoint=https://<SignalR-name>.service.signalr.net;AccessKey=<access-key>;Version=1.0;` |
+  | AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string with Managed Identity | `Endpoint=https://<SignalR-name>.service.signalr.net;AuthType=aad;<client-ID>;Version=1.0;` |
 
-#### System-assigned Managed Identity
+#### Sample code
+Refer to the steps and code below to connect to Azure SignalR Service using a system-assigned managed identity.
+[!INCLUDE [code for signalR](./includes/code-signalr.md)]
+
+### User-assigned Managed Identity
 
   | Default environment variable name | Description | Example value |
   | --- | --- | --- |
-  | AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string with Managed Identity | `Endpoint=https://<SignalR-name>.service.signalr.net;AuthType=aad;<client-ID>;Version=1.0;` |
+  | AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string with Managed Identity | `Endpoint=https://<SignalR-name>.service.signalr.net;AuthType=aad;client-id=<client-id>;Version=1.0;` |
+
+#### Sample code
+Refer to the steps and code below to connect to Azure SignalR Service using a user-assigned managed identity.
+[!INCLUDE [code for signalR](./includes/code-signalr.md)]
+
 
-#### User-assigned Managed Identity
+### Connection string
 
   | Default environment variable name | Description | Example value |
   | --- | --- | --- |
-  | AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string with Managed Identity | `Endpoint=https://<SignalR-name>.service.signalr.net;AuthType=aad;client-id=<client-id>;Version=1.0;` |
+  | AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string | `Endpoint=https://<SignalR-name>.service.signalr.net;AccessKey=<access-key>;Version=1.0;` |
 
-#### Service Principal
+#### Sample code
+Refer to the steps and code below to connect to Azure SignalR Service using a connection string.
+[!INCLUDE [code for signalR](./includes/code-signalr.md)]
+
+### Service Principal
 
   | Default environment variable name | Description | Example value |
   | --- | --- | --- |
   | AZURE_SIGNALR_CONNECTIONSTRING | SignalR Service connection string with Service Principal | `Endpoint=https://<SignalR-name>.service.signalr.net;AuthType=aad;ClientId=<client-ID>;ClientSecret=<client-secret>;TenantId=<tenant-ID>;Version=1.0;` |
 
+#### Sample code
+Refer to the steps and code below to connect to Azure SignalR Service using a service principal.
+[!INCLUDE [code for signalR](./includes/code-signalr.md)]
+
 ## Next steps
 
 > [!div class="nextstepaction"]

articles/service-connector/includes/code-signalr.md

@@ -0,0 +1,27 @@
+---
+author: wchigit
+ms.service: service-connector
+ms.topic: include
+ms.date: 10/31/2023
+ms.author: wchi
+---
+
+### [.NET](#tab/dotnet)
+
+1. Install dependencies.
+    ```bash
+    dotnet add package Microsoft.Azure.SignalR
+    ```
+1. Get the connection string from the environment variables added by Service Connector.
+    
+    ```csharp
+    var builder = WebApplication.CreateBuilder(args);
+
+    var connectionString = Environment.GetEnvironmentVariable("AZURE_SIGNALR_CONNECTIONSTRING");
+    builder.Services.AddSignalR().AddAzureSignalR(connectionString);
+
+    var app = builder.Build();
+    ```
+
+### [Other](#tab/other)
+For other languages, you can use the connection string that Service Connector sets to the environment variables to connect Azure SignalR Service. For environment variable details, see [Integrate Azure SignalR Service with Service Connector](../how-to-integrate-signalr.md).