Skip to content

Commit 70d5ab6

Browse files
authored
Update register-scan-power-bi-tenant-cross-tenant.md
1 parent 5752d31 commit 70d5ab6

File tree

1 file changed

+69
-8
lines changed

1 file changed

+69
-8
lines changed

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

Lines changed: 69 additions & 8 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: 04/29/2022
9+
ms.date: 09/09/2022
1010
ms.custom: template-how-to, ignite-fall-2021
1111
---
1212

@@ -27,11 +27,11 @@ For a list of metadata available for Power BI, see our [available metadata docum
2727
|**Scenario** |**Microsoft Purview public access** |**Power BI public access** | **Runtime option** | **Authentication option** | **Deployment checklist** |
2828
|---------|---------|---------|---------|---------|---------|
2929
|Public access with Azure integration runtime |Allowed |Allowed |Azure runtime |Delegated authentication | [Deployment checklist](#deployment-checklist) |
30-
|Public access with self-hosted integration runtime |Allowed |Allowed |Self-hosted runtime |Delegated authentication | [Deployment checklist](#deployment-checklist) |
30+
|Public access with self-hosted integration runtime |Allowed |Allowed |Self-hosted runtime |Delegated authentication / Service principal | [Deployment checklist](#deployment-checklist) |
3131

3232
### Known limitations
3333

34-
- For the cross-tenant scenario, delegated authentication is the only supported option for scanning.
34+
- For the cross-tenant scenario, delegated authentication and service principal are the only supported authentication options for scanning.
3535
- You can create only one scan for a Power BI data source that is registered in your Microsoft Purview account.
3636
- If the Power BI dataset schema isn't shown after the scan, it's due to one of the current limitations with the [Power BI metadata scanner](/power-bi/admin/service-admin-metadata-scanning).
3737
- Empty workspaces are skipped.
@@ -63,14 +63,14 @@ Use either of the following deployment checklists during the setup, or for troub
6363
1. From the Power BI tenant admin portal, make sure the Power BI tenant is configured to allow a public network.
6464

6565
1. Check your instance of Azure Key Vault to make sure:
66-
1. There are no typos in the password.
66+
1. There are no typos in the password or secret.
6767
2. Microsoft Purview managed identity has **get** and **list** access to secrets.
6868

6969
1. Review your credential to validate that the:
7070
1. Client ID matches the _Application (Client) ID_ of the app registration.
71-
2. Username includes the user principal name, such as `[email protected]`.
71+
2. For **delegated auth**, Username includes the user principal name, such as `[email protected]`.
7272

73-
1. In the Power BI Azure AD tenant, validate the following Power BI admin user settings:
73+
1. If delegated authentication is used, in the Power BI Azure AD tenant validate the following Power BI admin user settings:
7474
1. The user is assigned to the Power BI administrator role.
7575
2. At least one [Power BI license](/power-bi/admin/service-admin-licensing-organization#subscription-license-types) is assigned to the user.
7676
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.
@@ -87,6 +87,10 @@ Use either of the following deployment checklists during the setup, or for troub
8787
2. **Implicit grant and hybrid flows** > **ID tokens (used for implicit and hybrid flows)** is selected.
8888
3. **Allow public client flows** is enabled.
8989

90+
1. In Power BI tenant, In Azure Active Directory create a security group.
91+
1. In Power BI tenant, from Azure Active Directory tenant, make sure [Service Principal is member of the new security group](#authenticate-to-power-bi-tenant).
92+
1. On the Power BI Tenant Admin portal, validate if [Allow service principals to use read-only Power BI admin APIs](#associate-the-security-group-with-power-bi-tenant) is enabled for the new security group.
93+
9094
# [Public access with self-hosted integration runtime](#tab/Scenario2)
9195

9296
### Scan cross-tenant Power BI by using delegated authentication in a public network
@@ -109,7 +113,7 @@ Use either of the following deployment checklists during the setup, or for troub
109113
1. Client ID matches the _Application (Client) ID_ of the app registration.
110114
2. Username includes the user principal name, such as `[email protected]`.
111115

112-
1. In the Power BI Azure AD tenant, validate the following Power BI admin user settings:
116+
1. If delegated authentication is used, in the Power BI Azure AD tenant validate the following Power BI admin user settings:
113117
1. The user is assigned to the Power BI administrator role.
114118
2. At least one [Power BI license](/power-bi/admin/service-admin-licensing-organization#subscription-license-types) is assigned to the user.
115119
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.
@@ -131,7 +135,9 @@ Use either of the following deployment checklists during the setup, or for troub
131135
1. Network connectivity from the self-hosted runtime to the Power BI tenant is enabled.
132136
1. Network connectivity from the self-hosted runtime to Microsoft services is enabled.
133137
1. [JDK 8 or later](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html) is installed.
134-
138+
1. In Power BI tenant, In Azure Active Directory create a security group.
139+
1. In Power BI tenant, from Azure Active Directory tenant, make sure [Service Principal is member of the new security group](#authenticate-to-power-bi-tenant).
140+
1. On the Power BI Tenant Admin portal, validate if [Allow service principals to use read-only Power BI admin APIs](#associate-the-security-group-with-power-bi-tenant) is enabled for the new security group.
135141
---
136142

137143
## Register the Power BI tenant
@@ -157,6 +163,61 @@ Delegated authentication is the only supported option for cross-tenant scanning.
157163
> 1. Confirm you have completed the [deployment checklist for your scenario](#deployment-checklist).
158164
> 1. Review the [scan troubleshooting documentation](register-scan-power-bi-tenant-troubleshoot.md).
159165
166+
### Authenticate to Power BI tenant
167+
168+
In Azure Active Directory Tenant, where Power BI tenant is located:
169+
170+
1. In the [Azure portal](https://portal.azure.com), search for **Azure Active Directory**.
171+
172+
2. Create a new security group in your Azure Active Directory, by following [Create a basic group and add members using Azure Active Directory](../active-directory/fundamentals/active-directory-groups-create-azure-portal.md).
173+
174+
> [!Tip]
175+
> You can skip this step if you already have a security group you want to use.
176+
177+
3. Select **Security** as the **Group Type**.
178+
179+
:::image type="content" source="./media/setup-power-bi-scan-PowerShell/security-group.png" alt-text="Screenshot of security group type.":::
180+
181+
4. Add your **service princial** to this security group. Select **Members**, then select **+ Add members**.
182+
183+
5. Search for your Microsoft Purview managed identity or service principal and select it.
184+
185+
:::image type="content" source="./media/setup-power-bi-scan-PowerShell/add-catalog-to-group-by-search.png" alt-text="Screenshot showing how to add catalog by searching for its name.":::
186+
187+
You should see a success notification showing you that it was added.
188+
189+
:::image type="content" source="./media/setup-power-bi-scan-PowerShell/success-add-catalog-msi.png" alt-text="Screenshot showing successful addition of catalog managed identity.":::
190+
191+
### Associate the security group with Power BI tenant
192+
193+
1. Log into the [Power BI admin portal](https://app.powerbi.com/admin-portal/tenantSettings).
194+
195+
2. Select the **Tenant settings** page.
196+
197+
> [!Important]
198+
> You need to be a Power BI Admin to see the tenant settings page.
199+
200+
3. Select **Admin API settings** > **Allow service principals to use read-only Power BI admin APIs (Preview)**.
201+
202+
4. Select **Specific security groups**.
203+
204+
:::image type="content" source="./media/setup-power-bi-scan-PowerShell/allow-service-principals-power-bi-admin.png" alt-text="Image showing how to allow service principals to get read-only Power BI admin API permissions.":::
205+
206+
5. Select **Admin API settings** > **Enhance admin APIs responses with detailed metadata** > Enable the toggle to allow Microsoft Purview Data Map automatically discover the detailed metadata of Power BI datasets as part of its scans.
207+
208+
> [!IMPORTANT]
209+
> After you update the Admin API settings on your power bi tenant, wait around 15 minutes before registering a scan and test connection.
210+
211+
:::image type="content" source="media/setup-power-bi-scan-catalog-portal/power-bi-scan-sub-artifacts.png" alt-text="Image showing the Power BI admin portal config to enable subartifact scan.":::
212+
213+
> [!Caution]
214+
> When you allow the security group you created (that has your Microsoft Purview managed identity as a member) to use read-only Power BI admin APIs, you also allow it to access the metadata (e.g. dashboard and report names, owners, descriptions, etc.) for all of your Power BI artifacts in this tenant. Once the metadata has been pulled into the Microsoft Purview, Microsoft Purview's permissions, not Power BI permissions, determine who can see that metadata.
215+
216+
> [!Note]
217+
> You can remove the security group from your developer settings, but the metadata previously extracted won't be removed from the Microsoft Purview account. You can delete it separately, if you wish.
218+
219+
### Scan cross-tenant
220+
160221
To create and run a new scan by using the Azure runtime, perform the following steps:
161222

162223
1. Create a user account in the Azure AD tenant where the Power BI tenant is located, and assign the user to the Azure AD role, **Power BI Administrator**. Take note of the username and sign in to change the password.

0 commit comments

Comments
 (0)