Embed Power BI paginated reports

With Power BI embedded analytics, you can create Power BI content that displays paginated reports in a fully integrated and interactive application. Embed paginated reports using the solution that works best for you, embed for your customers or embed for your organization.

This article describes how to embed paginated reports using the embedding sample tutorials.

Prerequisites

To get started, you're required to have:

If you don't have an Azure subscription, create a free account before you begin.

Method

To embed a paginated report using the sample app, follow these steps:

  1. Create a workspace.

  2. Create a capacity.

  3. Assign a workspace to a capacity.

  4. Enable paginated reports workload.

  5. Create and upload your paginated report.

  6. Embed content using the sample application.

Step 1 - Create a workspace

As you're using a service principal to sign into your application, you'll need to create a new workspace.

Your service principal must also be an admin or member of the Power BI workspaces.

Step 2 - Create a capacity

Before you import or upload a paginated report to embed, the workspace containing the report must be assigned to a capacity. There are two types of capacity you can choose from:

The following table describes the resources and limits of each SKU. To determine which capacity best fits your needs, see the which SKU should I purchase for my scenario table.

Capacity Nodes Total v-cores Backend v-cores Frontend v-cores RAM (GB)
EM1/A1 with Embedded Gen2 1 0.5 0.5 2.5
EM2/A2 with Embedded Gen2 2 1 1 5
EM3/A3 with Embedded Gen2 4 2 2 10
P1/A4 8 4 4 25
P2/A5 16 8 8 50
P3/A6 32 16 16 100

Step 3 - Assign a workspace to a capacity

Once you create a capacity, you can assign your app workspace to that capacity.

To assign a capacity to a workspace using a service principal, use the Power BI REST API. When you're using the Power BI REST APIs, make sure to use the service principal object ID.

Note

You can also import paginated reports into a new workspace using the Power BI REST APIs.

Step 4 - Enable paginated reports workload

Note

This step is only necessary for Embedded Gen1. If your capacity is Gen2, continue to Step 5.

After creating a capacity and assigning your workspace to it, you need to enable the paginated report workload on your capacity.

  1. Sign into Power BI > Admin portal > Capacity settings.

  2. Select the capacity that has the workspace you want to add a paginated report to.

    Select capacity

  3. Expand Workloads.

    Expand workloads

  4. Activate the paginated reports workload.

    Paginated reports workload

Step 5 - Create and upload your paginated report

You can create your paginated report using Power BI Report Builder, and then upload the report to the service.

Note

The user uploading the paginated report needs a Power BI Pro or Premium Per User (PPU) license to publish to a workspace.

Step 6 - Embed content using the sample application

Follow the instructions in the embed content for your customers tutorial. Skip Step 4 - Create and publish a Power BI report and use the paginated report you uploaded, instead of the sample report suggested in the tutorial.

  • To use a Power BI dataset as a data source:

  • To use a Single Sign-on (SSO) enabled data source:

    SSO-enabled data sources are supported if they're either directly connected to the paginated report, or connected to a Power BI dataset which is the data source of the paginated report. When embedding a paginated report with SSO-enabled data sources, the identity blob for the data source must be provided in the DatasourceIdentity when you generate a multi-resource embed token.

Considerations and limitations

  • You must use a service principal. Master user isn't supported.
  • Premium Per User (PPU) isn't supported.
  • When embedding a paginated report with a Power BI dataset, both the paginated report and the Power BI dataset must reside in a Premium per capacity or Embedded workspace (they can reside in two different workspaces), and the user generating the embed token should have Write permissions in the workspaces of the report and the dataset.

For a full list of supported datasets and their authentication methods, see Supported data sources for Power BI paginated reports.

Next steps