PowerBI

Integration model

Metadata extraction

The following APIs are used to extract metadata from an object:

• https://learn.microsoft.com/en-us/rest/api/power-bi/admin/apps-get-apps-as-admin

• https://learn.microsoft.com/en-us/rest/api/power-bi/admin/groups-get-groups-as-admin

• https://learn.microsoft.com/en-us/rest/api/power-bi/admin/datasets-get-datasets-in-group-as-admin

• https://learn.microsoft.com/en-us/rest/api/power-bi/admin/reports-get-reports-in-group-as-admin

• https://learn.microsoft.com/en-us/rest/api/power-bi/admin/dashboards-get-dashboards-in-group-as-admin

With these APIs it is possible to extract the following types of PowerBI objects:

• APP

• Workspace

• Dataset (data model)

• Report

• Dashboard

The plugin extracts the following attributes, which must be named the same in the attribute_definition table, field name, for them to appear in the template:

Additionally, the Azure API itself can return more attributes that, in the same way, must match attributes defined in the object template with the same name in order to appear in Anjana Data. When in doubt about the returned value, INPUT_TEXT will always accept any value.

App: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/apps-get-apps-as-admin#adminapp  

• The id field must be represented in Anjana as appId.

Workspace: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/groups-get-groups-as-admin#admingroup  

• The id field must be represented in Anjana as workspaceId.

• The state field must be represented in Anjana as workspaceState.

• The dataflows and workbook fields are not retrieved as they are a separate type of data that will be extracted in future versions.

• The users field is not retrieved as it has been deprecated by PowerBI.

• The information related to dashboards, datasets and reports is extracted as a list of names, with a specific field for each one.

• The logAnalyticsWorkspace field is not retrieved due to API limitations.

• The type field must be represented in Anjana as workspaceType.

Dataset (data model) : https://learn.microsoft.com/en-us/rest/api/power-bi/admin/datasets-get-datasets-in-group-as-admin  

• The id field must be represented in Anjana as semanticModelId.

• The tags field is not retrieved as it was only available in the Fabric API at the time of writing this document.

• The users field is not retrieved as it has been deprecated by PowerBI.

• The ContentProviderType field is not retrieved as it has been deprecated by PowerBI.

Report: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/reports-get-reports-in-group-as-admin

• The id field must be represented in Anjana as reportId.

• The tags field is not retrieved as it was only available in the Fabric API at the time of writing this document.

• The subscriptions and users fields are not retrieved as they have been deprecated by PowerBI.

Dashboard: https://learn.microsoft.com/en-us/rest/api/power-bi/admin/dashboards-get-dashboards-in-group-as-admin

• The id field must be represented in Anjana as dashboardId.

• The displayName field will be included in Anjana as the generic name field.

• The tags field is not retrieved as it was only available in the Fabric API at the time of writing this document.

• The subscriptions and users fields are not retrieved as they have been deprecated by PowerBI.

Tables with special characters in the name

This technology allows characters such as “/” in the name; if they are being used, the path-separator must be configured with a character other than “/”. See File extraction for more details.

Access management (On Roadmap)

Since the PowerBI API does not provide access to access management, the only way to make it possible is by delegating it through EntraID (Azure AD). To do this, two manual actions will be required for this mechanism to work:

1. Permission assignment:

   1. Create a DSA and add Power BI objects.

      1. The group name must be entered in the physical_name field.

   2. This group must be assigned to each Power BI object (see Annexes)

2. Synchronization:

   1. The synchronization process between Azure and PowerBI is neither automatic nor instantaneous.

   2. Force it if possible.

Required credentials

Metadata extraction

The following permissions are required:

• Tenant.Read.All 

These permissions must be granted to the service principal to be used for the plugin's purpose. These permissions cannot be granted as Admin consent but must be delegated permissions:

1. App Registration configuration

   1. Go to the Azure Portal.

   2. Navigate to Azure Active Directory > App registrations > + New registration.

   3. Provide a name for the application and select the account type (the most common is Accounts in this organizational directory only).

2. Configure API Permissions

   1. Within the App Registration, navigate to API permissions.

   2. Click + Add a permission.

   3. Select Microsoft Power BI.

   4. Select Delegated permissions (not Application permissions).

   5. Search for and select the permissions the application needs as mentioned above.

3. Generate a specific Azure security group to consume the PowerBI APIs

   1. Add the generated APP inside the group

   2. Add the group to the following existing option in PowerBI (see screenshot)

Access management (On Roadmap)

For access management, the user responsible for assigning a group to a PowerBI object (within the PowerBI application) must have Owner or Member permission over the Workspace where the object resides or from which an App is published.

Annexes

Group assignment to Report

Group assignment to Dashboard

Group assignment to Semantic Model

Group assignment to APP