Skip to content

Commit 44431d6

Browse files
authored
update signalr msi docs
1 parent 210f021 commit 44431d6

File tree

4 files changed

+80
-120
lines changed

4 files changed

+80
-120
lines changed
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: include file
3+
description: include file
4+
author: terencefan
5+
ms.service: azure-signalr-service
6+
ms.topic: include
7+
ms.date: 03/12/2025
8+
ms.author: tefa
9+
ms.custom: include file
10+
---
11+
12+
The following steps describe how to assign a SignalR App Server role to a service principal (application) over an Azure SignalR Service resource. For detailed steps, see [Assign Azure roles using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
13+
14+
> [!NOTE]
15+
> A role can be assigned to any scope, including management group, subscription, resource group, or single resource. To learn more about scope, see [Understand scope for Azure RBAC](../role-based-access-control/scope-overview.md).
16+
17+
1. In the [Azure portal](https://portal.azure.com/), go to your Azure SignalR Service resource.
18+
19+
1. Select **Access control (IAM)**.
20+
21+
1. Select **Add** > **Add role assignment**.
22+
23+
:::image type="content" source="~/reusable-content/ce-skilling/azure/media/role-based-access-control/add-role-assignment-menu-generic.png" alt-text="Screenshot that shows the page for access control and selections for adding a role assignment.":::
24+
25+
1. On the **Role** tab, select **SignalR App Server** or other SignalR built-in roles depends on your scenario.
26+
27+
| Role | Description | Use case |
28+
| ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
29+
| [SignalR App Server](../role-based-access-control/built-in-roles.md#signalr-app-server) | Access to the server connection creation and key generation APIs. | Most commonly used for app server with Azure SignalR resource run in **Default** mode. |
30+
| [SignalR Service Owner](../role-based-access-control/built-in-roles.md#signalr-service-owner) | Full access to all data-plane APIs, including REST APIs, the server connection creation, and key/token generation APIs. | For negotiation server with Azure SignalR resource run in **Serverless** mode, as it requires both REST API permissions and authentication API permissions. |
31+
| [SignalR REST API Owner](../role-based-access-control/built-in-roles.md#signalr-rest-api-owner) | Full access to data-plane REST APIs. | For using [Azure SignalR Management SDK](/azure/azure-signalr/signalr-howto-use-management-sdk) to manage connections and groups, but does **NOT** make server connections or handle negotiation requests. |
32+
| [SignalR REST API Reader](../role-based-access-control/built-in-roles.md#signalr-rest-api-reader) | Read-only access to data-plane REST APIs. | Use it when write a monitoring tool that calls readonly REST APIs. |
33+
34+
35+
1. On the **Members** tab, select **User, group, or service principal**, and then choose **Select members**.
36+
37+
1. Search for and select the application to which you want to assign the role.
38+
39+
1. On the **Review + assign** tab, select **Review + assign** to assign the role.
40+
41+
> [!IMPORTANT]
42+
> Azure role assignments might take up to 30 minutes to propagate.
43+
44+
To learn more about how to assign and manage Azure roles, see these articles:
45+
46+
- [Assign Azure roles using the Azure portal](../role-based-access-control/role-assignments-portal.yml)
47+
- [Assign Azure roles using the REST API](../role-based-access-control/role-assignments-rest.md)
48+
- [Assign Azure roles using Azure PowerShell](../role-based-access-control/role-assignments-powershell.md)
49+
- [Assign Azure roles using the Azure CLI](../role-based-access-control/role-assignments-cli.md)
50+
- [Assign Azure roles using Azure Resource Manager templates](../role-based-access-control/role-assignments-template.md)

articles/azure-signalr/signalr-concept-authorize-azure-active-directory.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Microsoft Entra ID authorizes access rights to secured resources through [Azure
5050

5151
### Resource scope
5252

53-
You might have to determine the scope of access that the security principal should have before you assign any Azure RBAC role to a security principal. We recommend that you grant only the narrowest possible scope. Azure RBAC roles defined at a broader scope are inherited by the resources beneath them.
53+
Before assigning Azure RBAC roles to a security principal, it’s essential to define the appropriate scope of access they should have. We advise granting the most limited scope necessary to minimize unnecessary permissions. Keep in mind that Azure RBAC roles assigned at a higher or broader scope are automatically inherited by the resources nested within that scope.
5454

5555
You can scope access to Azure SignalR Service resources at the following levels, beginning with the narrowest scope.
5656

@@ -65,10 +65,10 @@ You can scope access to Azure SignalR Service resources at the following levels,
6565

6666
| Role | Description | Use case |
6767
| ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
68-
| [SignalR App Server](../role-based-access-control/built-in-roles.md#signalr-app-server) | Access to the WebSocket connection creation API and authentication APIs. | Most commonly used for an app server. |
69-
| [SignalR Service Owner](../role-based-access-control/built-in-roles.md#signalr-service-owner) | Full access to all data-plane APIs, including REST APIs, the WebSocket connection creation API, and authentication APIs. | Use for *serverless mode* for authorization with Microsoft Entra ID, because it requires both REST API permissions and authentication API permissions. |
70-
| [SignalR REST API Owner](../role-based-access-control/built-in-roles.md#signalr-rest-api-owner) | Full access to data-plane REST APIs. | Often used to write a tool that manages connections and groups, but does *not* make connections or call authentication APIs. |
71-
| [SignalR REST API Reader](../role-based-access-control/built-in-roles.md#signalr-rest-api-reader) | Read-only access to data-plane REST APIs. | Commonly used to write a monitoring tool that calls *only* Azure SignalR Service data-plane read-only REST APIs. |
68+
| [SignalR App Server](../role-based-access-control/built-in-roles.md#signalr-app-server) | Access to the server connection creation and key generation APIs. | Most commonly used for app server with Azure SignalR resource run in **Default** mode. |
69+
| [SignalR Service Owner](../role-based-access-control/built-in-roles.md#signalr-service-owner) | Full access to all data-plane APIs, including REST APIs, the server connection creation, and key/token generation APIs. | For negotiation server with Azure SignalR resource run in **Serverless** mode, as it requires both REST API permissions and authentication API permissions. |
70+
| [SignalR REST API Owner](../role-based-access-control/built-in-roles.md#signalr-rest-api-owner) | Full access to data-plane REST APIs. | For using [Azure SignalR Management SDK](/azure/azure-signalr/signalr-howto-use-management-sdk) to manage connections and groups, but does **NOT** make server connections or handle negotiation requests. |
71+
| [SignalR REST API Reader](../role-based-access-control/built-in-roles.md#signalr-rest-api-reader) | Read-only access to data-plane REST APIs. | Use it when write a monitoring tool that calls readonly REST APIs.
7272

7373
## Next steps
7474

articles/azure-signalr/signalr-howto-authorize-application.md

Lines changed: 6 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.custom: subject-rbac-steps
1212

1313
# Authorize requests to Azure SignalR Service resources with Microsoft Entra applications
1414

15-
Azure SignalR Service supports Microsoft Entra ID for authorizing requests from [Microsoft Entra applications](/entra/identity-platform/app-objects-and-service-principals).
15+
Azure SignalR Service supports Microsoft Entra ID for authorizing requests with [Microsoft Entra applications](/entra/identity-platform/app-objects-and-service-principals).
1616

1717
This article shows how to configure your Azure SignalR Service resource and codes to authorize requests to the resource from a Microsoft Entra application.
1818

@@ -35,42 +35,15 @@ After registering an app, you can add **certificates, client secrets (a string),
3535

3636
## Add role assignments in the Azure portal
3737

38-
The following steps describe how to assign a SignalR App Server role to a service principal (application) over an Azure SignalR Service resource. For detailed steps, see [Assign Azure roles using the Azure portal](../role-based-access-control/role-assignments-portal.yml).
38+
[!INCLUDE [add role assignments](includes/signalr-add-role-assignments.md)]
3939

40-
> [!NOTE]
41-
> A role can be assigned to any scope, including management group, subscription, resource group, or single resource. To learn more about scope, see [Understand scope for Azure RBAC](../role-based-access-control/scope-overview.md).
42-
43-
1. In the [Azure portal](https://portal.azure.com/), go to your Azure SignalR Service resource.
44-
45-
1. Select **Access control (IAM)**.
46-
47-
1. Select **Add** > **Add role assignment**.
48-
49-
:::image type="content" source="~/reusable-content/ce-skilling/azure/media/role-based-access-control/add-role-assignment-menu-generic.png" alt-text="Screenshot that shows the page for access control and selections for adding a role assignment.":::
50-
51-
1. On the **Role** tab, select **SignalR App Server**.
52-
53-
1. On the **Members** tab, select **User, group, or service principal**, and then choose **Select members**.
54-
55-
1. Search for and select the application to which you want to assign the role.
56-
57-
1. On the **Review + assign** tab, select **Review + assign** to assign the role.
58-
59-
> [!IMPORTANT]
60-
> Azure role assignments might take up to 30 minutes to propagate.
61-
62-
To learn more about how to assign and manage Azure roles, see these articles:
63-
64-
- [Assign Azure roles using the Azure portal](../role-based-access-control/role-assignments-portal.yml)
65-
- [Assign Azure roles using the REST API](../role-based-access-control/role-assignments-rest.md)
66-
- [Assign Azure roles using Azure PowerShell](../role-based-access-control/role-assignments-powershell.md)
67-
- [Assign Azure roles using the Azure CLI](../role-based-access-control/role-assignments-cli.md)
68-
- [Assign Azure roles using Azure Resource Manager templates](../role-based-access-control/role-assignments-template.md)
69-
70-
## Microsoft.Azure.SignalR app server SDK for C#
40+
## Configure Microsoft.Azure.SignalR app server SDK for C#
7141

7242
[Azure SignalR server SDK for C#](https://github.com/Azure/azure-signalr)
7343

44+
The Azure SignalR server SDK leverages the [Azure.Identity library](/dotnet/api/overview/azure/identity-readme) to generate tokens for connecting to resources.
45+
Click to explore detailed usages.
46+
7447
### Use Microsoft Entra application with certificate
7548
```csharp
7649
services.AddSignalR().AddAzureSignalR(option =>

0 commit comments

Comments
 (0)