Power BI Read

Power BI Read

In this article

Overview

Use this Snap to read data resources from a specified workspace.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

None.

Known Issues

None.

Snap Input and Output

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input/Output

Type of View

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

A document containing details of the workspace/entity to read.

Output

Document

  • Min: 1

  • Max: 1

  • Mapper Snap

  • Copy Snap

A document containing details of the entities.

Snap Settings

Parameter Name

Data Type

Description

Default Value

Example 

Parameter Name

Data Type

Description

Default Value

Example 

Label

String

Power BI Read

Read Employee Record

Workspace

String

Required. Enter the workspace from which to read the resource. Alternatively, click the 

 icon to fetch a list of workspaces associated with the Power BI account and select the workspace. 

N/A

Employee Records

Entity type

String

Required. Select the entity type to read.

Available options are:

  • DashboardSingle-page canvas for visualizations based on reports. The visualization units are called tiles.

  • Dataset: Collection of tables from different data sources ready for reporting and visualizations.

  • ReportVisualized interpretations, findings, and insights of a dataset. A report can include many pages.

  • Imports: Data imported from OneDrive or local files.

  • GatewayConnections between Power BI's cloud-based analysis service and on-premise data sources. 

  • Dataflow: Collection of entities (tables) that you create and manage in workspaces.

  • Dataflow Storage Accounts: Stores data flows in the organization's Azure Data Lake Storage account and connects them to Power BI.

Dashboard

Report

Entity id

String

Enter the ID of the entity to retrieve. Alternatively, click the 

 icon to fetch the IDs of all entities of the specified entity type available in the workspace. 

Leave this field blank to retrieve all entities of the specified entity type in the workspace. 

N/A

SalesMarketingDataset (XXXXXXXXXXXXX) or XXXXXXXXXXXXX

Get object

String

Select the read operation to perform upon the specified entity/entity type. The available read operations vary based on your configuration of the Entity type field. 

This field is mandatory when configuring the Object id field.

Available options based on entity types are:

  • Dashboard:

    • Get Tile

  • Report

    • Get Page

    • Get Datasources

  • Dataset

    • Get Datasources

    • Get Parameter

    • Get Refresh History

    • Get Refresh Schedule

    • Get Gateway Datasources

    • Get Direct Query Refresh Schedule

  • Gateway

    • Get Datasources

    • Get Datasources Status

    • Get Datasources Users

  • Import

    • None

N/A

Get Datasources

Object id

String

Enter the ID of the object to retrieve. Alternatively, click the 

 icon to fetch the IDs of all entities of the specified entity type available in the workspace. 

Leave this field blank to retrieve all entities of the specified entity type in the workspace. 

N/A

Number of Projects (1a2345d6-7890-123a-b45f-678a9fe01234)

Connection details

Use this field set to configure the network connection parameters.

This field set consists of the following fields:

  • Connection timeout

  • Number of retries

  • Retry interval (seconds)

Number of retries

Integer

Required. Specify the maximum number of re-connections if the connection fails or is timed-out.

3

4

Retry interval (seconds)

Integer

Required. Specify the interval in seconds between reconnections.

10

30

Connection timeout

Integer

Required. Specify the connection timeout duration in seconds.

10

30

Snap Execution

String

Specifies the execution type:

  • Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.

  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.

  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Validate & Execute

Execute only