Share via

PowerBIRestClient Class

REST client to access PowerBI REST endpoints. Authentication tokens are automatically acquired from the execution environment.

Note

This class is experimental and may be subject to change in future versions. We recommend using only the functions listed below. Use of any other functionality is discouraged and may lead to unexpected behavior.

Supported Functions

Resource

API

Example

Apps

Get Apps

GET https://api.powerbi.com/v1.0/myorg/apps

Dataflow Storage Accounts

Get Dataflow

GET https://api.powerbi.com/v1.0/myorg/dataflowStorageAccounts

Dataflows

Get Dataflow

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows/{dataflowId}

Dataflows

Get Dataflows

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/dataflows

Datasets

Get Dataset

GET https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}

Datasets

Get Dataset in Group

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/datasets/{datasetId}

Datasets

Get Datasets

GET https://api.powerbi.com/v1.0/myorg/datasets

Gateways

Get Gateways

GET https://api.powerbi.com/v1.0/myorg/gateways

Groups

Get Group

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}

Groups

Get Groups

GET https://api.powerbi.com/v1.0/myorg/groups

Reports

Get Report

GET https://api.powerbi.com/v1.0/myorg/reports/{reportId}

Reports

Get Report in Group

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports/{reportId}

Reports

Get Reports

GET https://api.powerbi.com/v1.0/myorg/reports

Reports

Get Reports in Group

GET https://api.powerbi.com/v1.0/myorg/groups/{groupId}/reports

Constructor

PowerBIRestClient(token_provider: TokenProvider | None = None, retry_config: Dict | None = None)

Parameters

Name Description
token_provider
<xref:sempy.fabric.TokenProvider>

Implementation of TokenProvider that can provide auth token for access to the PowerBI workspace. Will attempt to acquire token from its execution environment if not provided.

Default value: None
retry_config
dict

Configuration for the retry strategy. The following keys are filled with default values if not provided:

  • total: int, default=10
  • allowed_methods: list, default=["HEAD", "GET", "POST", "PUT", "PATCH", "DELETE"]
  • status_forcelist: list, default=[429, 502, 503, 504]
  • backoff_factor: int, default=1
  • raise_on_status: bool, default=False
Default value: None