Skip to content

Commit 7bdf7b0

Browse files
committed
Add information about permissions and scope
1 parent 42f9de8 commit 7bdf7b0

File tree

6 files changed

+49
-25
lines changed

6 files changed

+49
-25
lines changed

articles/managed-grafana/how-to-sync-teams-with-azure-ad-groups.md

Lines changed: 49 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,28 @@
11
---
22
title: Create Grafana teams with Microsoft Entra groups
3-
description: Learn how to set up Grafana teams using Microsoft Entra groups in Azure Managed Grafana
3+
description: Learn how to set up Grafana teams and allow access to Grafana folders and dashboards using Microsoft Entra groups in Azure Managed Grafana.
4+
#customer intent: As a Grafana administrator, I want to set up a Grafana team using Microsoft Entra groups to allow access to specific folders and dashboards.
45
ms.service: managed-grafana
56
ms.topic: how-to
67
author: maud-lv
78
ms.author: malev
89
ms.date: 06/7/2024
910
---
1011

11-
# Create Grafana teams with Microsoft Entra groups
12+
# Create and manage Grafana teams with Microsoft Entra groups
1213

13-
In this guide, you learn how to use Microsoft Entra groups with [Grafana Team Sync](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-team-sync/) (Microsoft Entra group sync) to set dashboard permissions in Azure Managed Grafana. Grafana allows you to control access to its resources at multiple levels. In Managed Grafana, you use the built-in Azure RBAC roles for Grafana to define access rights users have. These permissions are applied to all resources in your Grafana workspace by default. You can't, for example, grant someone edit permission to only one particular dashboard with RBAC. If you assign a user to the Grafana Editor role, that user can make changes to any dashboard in your Grafana workspace. Using Grafana's [granular permission model](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-team-sync/), you can elevate or demote a user's default permission level for specific dashboards (or dashboard folders).
14+
In this guide, you learn how to use Microsoft Entra groups with [Grafana Team Sync](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-team-sync/) to set dashboard permissions in Azure Managed Grafana.
1415

15-
Setting up dashboard permissions for individual users in Managed Grafana is a little tricky. Managed Grafana stores the user assignments for its built-in RBAC roles in Microsoft Entra ID. For performance reasons, it doesn't automatically synchronize the user assignments to Grafana workspaces. Users in these roles don't show up in Grafana's **Configuration** UI until they've signed in once. You can only grant users extra permissions after they appear in the Grafana user list in **Configuration**. Microsoft Entra group sync gets around this issue. With this feature, you create a *Grafana team* in your Grafana workspace linked with a Microsoft Entra group. You then use that team in configuring your dashboard permissions. For example, you can grant a viewer the ability to modify a dashboard or block an editor from being able to make changes. You don't need to manage the team's member list separately since its membership is already defined in the associated Microsoft Entra group.
16+
Grafana allows you to control access to its resources at multiple levels. In Azure Managed Grafana, you use the built-in Azure role-based access control(RBAC) roles for Grafana to define access rights users have. These permissions are applied to all resources in your Grafana workspace by default. You can't, for example, grant someone edit permission to only one particular dashboard with RBAC. If you assign a user to the Grafana Editor role, that user can make changes to any dashboard in your Grafana workspace. Using Grafana's [granular permission model](https://grafana.com/docs/grafana/latest/setup-grafana/configure-security/configure-team-sync/), you can elevate or demote a user's default permission level for specific dashboards, or dashboard folders.
17+
18+
Managed Grafana stores the user assignments for its built-in RBAC roles in Microsoft Entra ID. For performance reasons, it doesn't automatically synchronize the user assignments to Grafana workspaces. Users in these roles don't show up in Grafana's **Configuration** UI until they've signed in once. You can only grant users extra permissions after they appear in the Grafana user list in **Configuration**. Microsoft Entra group sync gets around this issue. With this feature, you create a *Grafana team* in your Grafana workspace linked with a Microsoft Entra group. You then configure your dashboard permissions for that team. For example, you can grant a Grafana viewer the ability to modify a dashboard, or block a Grafana editor from being able to make changes.
19+
20+
Setting up Microsoft Entra group sync is done by following these steps in a given Azure Managed Grafana workspace:
21+
22+
1. Assign a Grafana role to a Microsoft Entra Group
23+
1. Create a Grafana team in an Azure Managed Grafana workspace
24+
1. Assign the Microsoft Entra group in the Grafana team
25+
1. In the Grafana UI, assign permissions at the folder or dashboard level
1626

1727
<a name='set-up-azure-ad-group-sync'></a>
1828

@@ -22,26 +32,25 @@ To follow the steps in this guide, you must have:
2232

2333
- An Azure account with an active subscription. [Create an account for free](https://azure.microsoft.com/free).
2434
- An Azure Managed Grafana instance. If needed, [create a new instance](quickstart-managed-grafana-portal.md).
25-
- A Microsoft Entra group. I needed, [create a basic group and add members](/entra/fundamentals/how-to-manage-groups#create-a-basic-group-and-add-members).
35+
- A Microsoft Entra group. If needed, [create a basic group and add members](/entra/fundamentals/how-to-manage-groups.md#create-a-basic-group-and-add-members).
2636

27-
## Set up Microsoft Entra group sync
37+
## Give the Microsoft Entra group the required permission on the Grafana instance
2838

29-
To use Microsoft Entra group sync, you assign a Grafana role to a Microsoft Entra Group, create a Grafana team, and link this Microsoft Entra group to this
39+
The Microsoft Entra group must have a Grafana role to access the Grafana instance.
3040

31-
group to add a team to your Grafana workspace, and link this team to an existing Microsoft Entra group through its group ID.
41+
1. In your Grafana workspace, open the **Access control (IAM)** menu select **Add** > **Add new role assignment**.
3242

33-
## Give this group the desired permission on the Grafana instance.
43+
:::image type="content" source="media/azure-ad-group-sync/add-role-assignment.png" alt-text="Screenshot of the Azure portal. Adding a new role assignment.":::
3444

35-
The Microsoft Entra group must have a Grafana role to access the Grafana instance.
45+
1. Assign a role, such as **Grafana viewer**, to the Microsoft Entra group.
3646

37-
1. In your Grafana workspace, open the **Access control (IAM)** menu select **Add** > **Add new role assignment**.
38-
1. Assign a role, such as **Grafana viewer**, to the Microsoft Entra group
47+
For more information about assigning a role, go to [Grant access](../role-based-access-control/quickstart-assign-role-user-portal.md#grant-access).
3948

4049
### Create a Grafana team
4150

42-
Follow these steps to set up a Microsoft Entra ID-backed Grafana team.
51+
Set up a Microsoft Entra ID-backed Grafana team.
4352

44-
1. In the Azure portal, open your Grafana instance and select **Configuration** under *Settings*.
53+
1. In the Azure portal, open your Grafana instance and select **Configuration** under **Settings**.
4554
1. Select the **Microsoft Entra Team Sync Settings** tab.
4655
1. Select **Create new Grafana team**.
4756

@@ -60,21 +69,36 @@ Follow these steps to set up a Microsoft Entra ID-backed Grafana team.
6069

6170
:::image type="content" source="media/azure-ad-group-sync/select-azure-ad-group.png" alt-text="Screenshot of the Azure portal. Finding and selecting a Microsoft Entra group.":::
6271

63-
1. Repeat the previous three steps to add more Microsoft Entra groups to the Grafana team as appropriate.
72+
1. Optionally repeat the previous three steps to add more Microsoft Entra groups to the Grafana team as appropriate.
73+
74+
### Assign access to a Grafana folder or dashboard
75+
76+
1. In the Grafana UI, open a folder or a dashboard.
77+
1. In the **Permissions** tab, select **Add a permission**.
78+
79+
:::image type="content" source="media/azure-ad-group-sync/add-permission.png" alt-text="Screenshot of the Azure portal, selecting Add a permission." lightbox="media/azure-ad-group-sync/add-permission.png":::
80+
81+
1. Under **Add permission for**, select **Team**, then select the team name, the **View**, **Edit** or **Admin** permission, and save. You can add permissions for a user, a team or a role.
82+
83+
:::image type="content" source="media/azure-ad-group-sync/add-permission-for-team.png" alt-text="Screenshot of the Grafana UI, adding a permission for a team in a Grafana folder.":::
84+
85+
> [!TIP]
86+
> To check existing access permissions for a dashboard, open a dashboard and go to the **Permissions** tab. This page shows all permissions assigned for this dashboard and all inherited permissions.
87+
88+
:::image type="content" source="media/azure-ad-group-sync/view-permissions.png" alt-text="Screenshot of the Grafana UI, adding a permission for a team in a Grafana folder.":::
89+
90+
91+
### Scope down access
6492

65-
### Scope down access to a specific folder
93+
You can scale down access by removing permissions to access one or more folders.
6694

67-
To scope down access to a specific folder, remove permissions to all other folders.
95+
For example, if a user, group of users has the Grafana Viewer role on a Grafana instance, disable their access to a folder by following these steps:
6896

69-
1. Decide which Microsoft Entra group will have access to the folder and give this group the desired permission on the Grafana instance.
70-
1. In your Grafana workspace, open the **Access control (IAM)** menu select **Add** > **Add new role assignment**.
71-
1. Select a role such as **Grafana Viewer**.
72-
1. Assign access to the group of your choice.
73-
1. Add group In Azure portal, use the Microsoft Entra Team Sync Settings page add an AAD group into Grafana Team. This will map users in an AAD group to a Grafana Team.
74-
- In Grafana, grant this AAD group view permission to a folder
75-
- Remove the view permission for view role on all other folders, that way having ‘Grafana Viewer’ role still doesn’t mean they get read access to all other folders.
97+
1. In the Grafana UI, go to a folder you want to hide from the user
98+
1. In the **Permissions** tab, select the **X** button to the right of the **Viewer** permission to remove this permission from this folder.
99+
1. Repeat this step for all folders you want to hide from the user.
76100

77-
You can actually map multiple AAD groups to a single Grafana team, effectively granting multiple AAD groups view permission with just one Grafana team.
101+
:::image type="content" source="media/azure-ad-group-sync/remove-permission.png" alt-text="Screenshot of the Grafana UI, removing the Viewer permission in a Grafana folder.":::
78102

79103
<a name='remove-azure-ad-group-sync'></a>
80104

60.1 KB
Loading
71.7 KB
Loading
74.4 KB
Loading
46.9 KB
Loading
51.1 KB
Loading

0 commit comments

Comments
 (0)