Skip to content

Commit e21fe60

Browse files
authored
Merge pull request #212133 from zeinab-mk/patch-24
Update PBI scans with SPN
2 parents f088c38 + 0d24ead commit e21fe60

File tree

4 files changed

+52
-22
lines changed

4 files changed

+52
-22
lines changed
27.3 KB
Loading
46.8 KB
Loading

articles/purview/register-scan-power-bi-tenant-cross-tenant.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: csugunan
66
ms.service: purview
77
ms.subservice: purview-data-map
88
ms.topic: how-to
9-
ms.date: 09/21/2022
9+
ms.date: 09/22/2022
1010
ms.custom: template-how-to, ignite-fall-2021
1111
---
1212

@@ -124,7 +124,7 @@ Use either of the following deployment checklists during the setup, or for troub
124124
2. **Implicit grant and hybrid flows** > **ID tokens (used for implicit and hybrid flows)** is selected.
125125
3. **Allow public client flows** is enabled.
126126

127-
1. If delegated authentication is used, in the Power BI Azure AD tenant validate the following Power BI admin user settings:
127+
1. If delegated authentication is used, in the Power BI Azure AD tenant, validate the following Power BI admin user settings:
128128
1. The user is assigned to the Power BI administrator role.
129129
2. At least one [Power BI license](/power-bi/admin/service-admin-licensing-organization#subscription-license-types) is assigned to the user.
130130
3. If the user is recently created, sign in with the user at least once, to make sure that the password is reset successfully, and the user can successfully initiate the session.
@@ -337,9 +337,20 @@ To create and run a new scan by using the self-hosted integration runtime, perfo
337337

338338
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-key-vault.png" alt-text="Screenshot of the instance of Azure Key Vault.":::
339339

340-
1. Enter a name for the secret. For **Value**, type the newly created password for the Azure AD user. Select **Create** to complete.
340+
1. Enter a name for the secret. For **Value**, type the newly created secret for the App registration. Select **Create** to complete.
341341

342-
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-key-vault-secret.png" alt-text="Screenshot that shows how to generate a secret in Azure Key Vault.":::
342+
343+
2. Under **Certificates & secrets**, create a new secret and save it securely for next steps.
344+
345+
3. In Azure portal, navigate to your Azure key vault.
346+
347+
4. Select **Settings** > **Secrets** and select **+ Generate/Import**.
348+
349+
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-key-vault.png" alt-text="Screenshot how to navigate to Azure Key Vault.":::
350+
351+
5. Enter a name for the secret and for **Value**, type the newly created secret for the App registration. Select **Create** to complete.
352+
353+
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-key-vault-secret-spn.png" alt-text="Screenshot how to generate an Azure Key Vault secret for SPN.":::
343354

344355
1. If your key vault isn't connected to Microsoft Purview yet, you need to [create a new key vault connection](manage-credentials.md#create-azure-key-vaults-connections-in-your-microsoft-purview-account).
345356

@@ -365,6 +376,8 @@ To create and run a new scan by using the self-hosted integration runtime, perfo
365376
- **Tenant ID**: Your Power BI tenant ID
366377
- **Client ID**: Use Service Principal Client ID (App ID) you created earlier
367378

379+
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-scan-spn-authentication.png" alt-text="Screenshot of the new credential menu, showing Power BI credential for SPN with all required values supplied.":::
380+
368381
1. Select **Test connection** before continuing to the next steps.
369382

370383
If the test fails, select **View Report** to see the detailed status and troubleshoot the problem:

articles/purview/register-scan-power-bi-tenant.md

Lines changed: 35 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: csugunan
66
ms.service: purview
77
ms.subservice: purview-data-map
88
ms.topic: how-to
9-
ms.date: 09/21/2022
9+
ms.date: 09/22/2022
1010
ms.custom: template-how-to, ignite-fall-2021
1111
---
1212

@@ -222,7 +222,7 @@ In Azure Active Directory Tenant, where Power BI tenant is located:
222222

223223
:::image type="content" source="./media/setup-power-bi-scan-PowerShell/add-group-member.png" alt-text="Screenshot of how to add the catalog's managed instance to group.":::
224224

225-
- If you are using **delegated authentication** or **service principal** as authentication method, add your **service princial** to this security group. Select **Members**, then select **+ Add members**.
225+
- If you are using **delegated authentication** or **service principal** as authentication method, add your **service principal** to this security group. Select **Members**, then select **+ Add members**.
226226

227227
5. Search for your Microsoft Purview managed identity or service principal and select it.
228228

@@ -305,7 +305,7 @@ For more information about Microsoft Purview network settings, see [Use private
305305

306306
To create and run a new scan, do the following:
307307

308-
1. Create an App Registration in your Azure Active Directory tenant. Provide a web URL in the **Redirect URI**. Take note of Client ID(App ID).
308+
1. In the [Azure portal](https://portal.azure.com), select **Azure Active Directory** and create an App Registration in the tenant. Provide a web URL in the **Redirect URI**. Take note of Client ID(App ID).
309309

310310
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-create-service-principle.png" alt-text="Screenshot how to create a Service principle.":::
311311

@@ -319,44 +319,60 @@ To create and run a new scan, do the following:
319319

320320
1. Under **Advanced settings**, enable **Allow Public client flows**.
321321

322-
2. In the Microsoft Purview Studio, navigate to the **Data map** in the left menu.
322+
2. Under **Certificates & secrets**, create a new secret and save it securely for next steps.
323323

324-
1. Navigate to **Sources**.
324+
3. In Azure portal, navigate to your Azure key vault.
325325

326-
1. Select the registered Power BI source.
326+
4. Select **Settings** > **Secrets** and select **+ Generate/Import**.
327327

328-
1. Select **+ New scan**.
328+
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-key-vault.png" alt-text="Screenshot how to navigate to Azure Key Vault.":::
329329

330-
1. Give your scan a name. Then select the option to include or exclude the personal workspaces.
330+
5. Enter a name for the secret and for **Value**, type the newly created secret for the App registration. Select **Create** to complete.
331+
332+
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-key-vault-secret-spn.png" alt-text="Screenshot how to generate an Azure Key Vault secret for SPN.":::
333+
334+
6. If your key vault isn't connected to Microsoft Purview yet, you'll need to [create a new key vault connection](manage-credentials.md#create-azure-key-vaults-connections-in-your-microsoft-purview-account)
335+
336+
7. In the Microsoft Purview Studio, navigate to the **Data map** in the left menu.
337+
338+
8. Navigate to **Sources**.
339+
340+
9. Select the registered Power BI source.
341+
342+
10. Select **+ New scan**.
343+
344+
11. Give your scan a name. Then select the option to include or exclude the personal workspaces.
331345

332346
>[!Note]
333347
> Switching the configuration of a scan to include or exclude a personal workspace will trigger a full scan of Power BI source.
334348
335-
1. Select your self-hosted integration runtime from the drop-down list.
349+
12. Select your self-hosted integration runtime from the drop-down list.
336350

337351
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-scan-shir.png" alt-text="Image showing Power BI scan setup using SHIR for same tenant.":::
338352

339-
1. For the **Credential**, select **service principal** and select **+ New** to create a new credential.
353+
13. For the **Credential**, select **service principal** and select **+ New** to create a new credential.
340354

341-
1. Create a new credential and provide required parameters:
355+
14. Create a new credential and provide required parameters:
342356

343357
- **Name**: Provide a unique name for credential
344358
- **Authentication method**: Service principal
345359
- **Tenant ID**: Your Power BI tenant ID
346360
- **Client ID**: Use Service Principal Client ID (App ID) you created earlier
347-
348-
1. Select **Test Connection** before continuing to next steps. If **Test Connection** failed, select **View Report** to see the detailed status and troubleshoot the problem
361+
362+
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-scan-spn-authentication.png" alt-text="Screenshot of the new credential menu, showing Power BI credential for SPN with all required values supplied.":::
363+
364+
15. Select **Test Connection** before continuing to next steps. If **Test Connection** failed, select **View Report** to see the detailed status and troubleshoot the problem
349365
1. Access - Failed status means the user authentication failed. Scans using managed identity will always pass because no user authentication required.
350366
2. Assets (+ lineage) - Failed status means the Microsoft Purview - Power BI authorization has failed. Make sure the Microsoft Purview managed identity is added to the security group associated in Power BI admin portal.
351367
3. Detailed metadata (Enhanced) - Failed status means the Power BI admin portal is disabled for the following setting - **Enhance admin APIs responses with detailed metadata**
352368

353369
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-test-connection-status-report.png" alt-text="Screenshot of test connection status report page.":::
354370

355-
1. Set up a scan trigger. Your options are **Recurring**, and **Once**.
371+
16. Set up a scan trigger. Your options are **Recurring**, and **Once**.
356372

357373
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/scan-trigger.png" alt-text="Screenshot of the Microsoft Purview scan scheduler.":::
358374

359-
1. On **Review new scan**, select **Save and run** to launch your scan.
375+
17. On **Review new scan**, select **Save and run** to launch your scan.
360376

361377
### Create scan for same-tenant using self-hosted IR with delegated authentication
362378

@@ -424,20 +440,21 @@ To create and run a new scan, do the following:
424440
- **Client ID**: Use Service Principal Client ID (App ID) you created earlier
425441
- **User name**: Provide the username of Power BI Administrator you created earlier
426442
- **Password**: Select the appropriate Key vault connection and the **Secret name** where the Power BI account password was saved earlier.
443+
427444
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-scan-delegated-authentication.png" alt-text="Screenshot of the new credential menu, showing Power B I credential with all required values supplied.":::
428445

429-
1. Select **Test Connection** before continuing to next steps. If **Test Connection** failed, select **View Report** to see the detailed status and troubleshoot the problem
446+
2. Select **Test Connection** before continuing to next steps. If **Test Connection** failed, select **View Report** to see the detailed status and troubleshoot the problem
430447
1. Access - Failed status means the user authentication failed. Scans using managed identity will always pass because no user authentication required.
431448
2. Assets (+ lineage) - Failed status means the Microsoft Purview - Power BI authorization has failed. Make sure the Microsoft Purview managed identity is added to the security group associated in Power BI admin portal.
432449
3. Detailed metadata (Enhanced) - Failed status means the Power BI admin portal is disabled for the following setting - **Enhance admin APIs responses with detailed metadata**
433450

434451
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-test-connection-status-report.png" alt-text="Screenshot of test connection status report page.":::
435452

436-
1. Set up a scan trigger. Your options are **Recurring**, and **Once**.
453+
3. Set up a scan trigger. Your options are **Recurring**, and **Once**.
437454

438455
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/scan-trigger.png" alt-text="Screenshot of the Microsoft Purview scan scheduler.":::
439456

440-
1. On **Review new scan**, select **Save and run** to launch your scan.
457+
4. On **Review new scan**, select **Save and run** to launch your scan.
441458

442459
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/save-run-power-bi-scan.png" alt-text="Screenshot of Save and run Power BI source.":::
443460

0 commit comments

Comments
 (0)