Skip to content

Commit dcfbe2f

Browse files
Adding RBAC/IAM for Entra ID configuration doc (#32912)
* Adding RBAC/IAM for Entra ID configuration doc * correcting absolute path to relative, hopefully * Update image and structure * Acrolinx * Update indentation * Some fun * Update dates --------- Co-authored-by: Stephen Kusen <stephen.kusen@gmail.com>
1 parent 767ec83 commit dcfbe2f

File tree

5 files changed

+42
-18
lines changed

5 files changed

+42
-18
lines changed

docs/includes/entra-id-tutorial.md

Lines changed: 40 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -110,38 +110,62 @@ Select the newly created application, and on the left side menu, select **API Pe
110110

111111
:::image type="content" source="../relational-databases/security/authentication-access/media/upload-certificate-to-application.png" alt-text="Screenshot of certificate and secrets menu in the Azure portal." lightbox="../relational-databases/security/authentication-access/media/upload-certificate-to-application.png":::
112112

113-
1. In the Azure portal, navigate to the Azure Key Vault instance where the certificate is stored, and select **Access policies** from the navigation menu.
113+
1. In the Azure portal, get the object ID of the Azure Arc Machine.
114114

115-
1. Select **Create**.
116-
1. For **Secret permissions**, select **Get** and **List**.
117-
1. For **Certificate permissions**, select **Get** and **List**.
118-
1. Select **Next**.
119-
1. On the **Principal** page, search for the name of your Machine - Azure Arc instance, which is the hostname of the SQL Server host.
115+
1. Under **Azure Arc Resources**>**Machines**, select the machine.
116+
1. In **Overview**, find **JSON View**.
117+
1. Under **Identity**, copy the value for **principalId**.
120118

121-
:::image type="content" source="../relational-databases/security/authentication-access/media/machine-azure-arc-resource.png" alt-text="Screenshot of Azure Arc server resource in portal.":::
119+
:::image type="content" source="../relational-databases/security/authentication-access/media/machine-azure-arc-json-view.png" alt-text="Screenshot of portal control of JSON view of machine definition.":::
122120

123-
1. Skip the **Application (optional)** page by selecting **Next** twice, or selecting **Review + create**.
121+
1. In the portal, navigate to the Azure Key Vault instance where the certificate is stored, and grant access to the Azure Machine resource(s). In your Azure Key Vault navigation menu, navigate to **Settings**, and **Access configuration**. For detailed steps to manage role assignments, review [Assign Azure roles using the Azure portal](/azure/role-based-access-control/role-assignments-portal).
122+
123+
Your experience depends on your key vault access configuration:
124124

125-
Verify that the "Object ID" of the **Principal** matches the **Principal ID** of the managed identity assigned to the instance.
125+
To use **Azure role-based access control (recommended)**:
126126

127-
:::image type="content" source="../relational-databases/security/authentication-access/media/customer-managed-akv-review-create.png" alt-text="Screenshot of Azure portal to review and create access policy."
127+
1. Add the following roles to your Resource.
128128

129-
To confirm, go to the resource page and select **JSON View** in the top right of the Essentials box on the Overview page. Under **identity** you'll find the **principalId**
129+
- Key Vault Certificate User
130+
- Key Vault Secrets User
130131

131-
:::image type="content" source="../relational-databases/security/authentication-access/media/machine-azure-arc-json-view.png" alt-text="Screenshot of portal control of JSON view of machine definition.":::
132+
1. Verify the roles in this location:
132133

134+
:::image type="content" source="../relational-databases/security/authentication-access/media/add-rbac-roles-on-key-vault.png" alt-text="Screenshot of Azure Key Vault IAM role additions.":::
135+
136+
To use **Vault access policy**:
137+
138+
1. Select **Access policies** from the navigation menu.
133139
1. Select **Create**.
140+
1. For **Secret permissions**, select **Get**>**List**.
141+
1. For **Certificate permissions**, select **Get**>**List**.
142+
1. Select **Next**.
143+
1. For **Principal** page, search for the name of your **Machine - Azure Arc** instance, which is the hostname of the SQL Server host.
134144

135-
You must select **Create** to ensure that the permissions are applied. To ensure permissions have been stored, refresh the browser window, and check that the row for your Azure Arc instance is still present.
145+
:::image type="content" source="../relational-databases/security/authentication-access/media/machine-azure-arc-resource.png" alt-text="Screenshot of Azure Arc server resource in portal. ":::
146+
147+
1. Select **Review + create**.
148+
1. Verify that the value for **Principal**>**Object ID** matches the **Principal ID** of the managed identity assigned to the instance.
149+
150+
:::image type="content" source="../relational-databases/security/authentication-access/media/customer-managed-akv-review-create.png" alt-text="Screenshot of Azure portal to review and create access policy."
151+
152+
To confirm, go to the resource page and select **JSON View** in the top right of the Essentials box on the Overview page. Under **identity** you'll find the **principalId**
153+
154+
1. Select **Create**.
136155

137-
:::image type="content" source="../relational-databases/security/authentication-access/media/add-access-policy-on-key-vault.png" alt-text="Screenshot of adding access policy to the key vault in the Azure portal.":::
156+
You must select **Create** to ensure that the permissions are applied. To ensure permissions have been stored, refresh the browser window, and confirm that your Azure Arc instance is present.
138157

139158
<a name='configure-azure-ad-authentication-for-sql-server-through-azure-portal'></a>
140159

141160
## Configure Microsoft Entra authentication for SQL Server through Azure portal
142161

143162
> [!NOTE]
144-
> Using the [Azure CLI](../relational-databases/security/authentication-access/azure-ad-authentication-sql-server-automation-setup-tutorial.md?tabs=azure-cli#setting-up-the-azure-ad-admin-for-the-sql-server), [PowerShell](../relational-databases/security/authentication-access/azure-ad-authentication-sql-server-automation-setup-tutorial.md?tabs=azure-powershell#setting-up-the-azure-ad-admin-for-the-sql-server), or [ARM template](../relational-databases/security/authentication-access/azure-ad-authentication-sql-server-automation-setup-tutorial.md?tabs=arm-template#setting-up-the-azure-ad-admin-for-the-sql-server) to set up a Microsoft Entra admin for SQL Server is available.
163+
>
164+
> You can configure Microsoft Entra authentication with any of the following experiences:
165+
> - [Azure CLI](../relational-databases/security/authentication-access/azure-ad-authentication-sql-server-automation-setup-tutorial.md?tabs=azure-cli#setting-up-the-azure-ad-admin-for-the-sql-server)
166+
> - [PowerShell](../relational-databases/security/authentication-access/azure-ad-authentication-sql-server-automation-setup-tutorial.md?tabs=azure-powershell#setting-up-the-azure-ad-admin-for-the-sql-server)
167+
> - [ARM template](../relational-databases/security/authentication-access/azure-ad-authentication-sql-server-automation-setup-tutorial.md?tabs=arm-template#setting-up-the-azure-ad-admin-for-the-sql-server)
168+
>
145169
146170
1. Go to the [Azure portal](https://portal.azure.com), and select **SQL Server – Azure Arc**, and select the instance for your SQL Server host.
147171

@@ -280,7 +304,7 @@ To list the users created in the database, execute the following T-SQL command:
280304
SELECT * FROM sys.database_principals;
281305
```
282306

283-
A new database user is given the **Connect** permission by default. All other SQL Server permissions must be explicitly granted by authorized grantors.
307+
A new database has **Connect** permission by default. All other SQL Server permissions must be explicitly granted by authorized grantors.
284308

285309
<a name='azure-ad-guest-accounts'></a>
286310

docs/relational-databases/security/authentication-access/azure-ad-authentication-sql-server-setup-tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Tutorial on how to set up Microsoft Entra authentication for SQL Se
44
author: GithubMirek
55
ms.author: mireks
66
ms.reviewer: vanto, randolphwest
7-
ms.date: 08/09/2023
7+
ms.date: 01/29/2025
88
ms.service: sql
99
ms.subservice: security
1010
ms.topic: tutorial
212 KB
Loading

docs/sql-server/azure-arc/entra-authentication-setup-tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Tutorial on how to set up Microsoft Entra authentication for SQL Se
44
author: MikeRayMSFT
55
ms.author: mikeray
66
ms.reviewer: vanto, randolphwest
7-
ms.date: 04/11/2024
7+
ms.date: 01/29/2025
88
ms.service: sql
99
ms.subservice: security
1010
ms.topic: tutorial

0 commit comments

Comments
 (0)