|
Add Power BI Encryption Key
|
Adds an encryption key for Power BI workspaces assigned to a capacity.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 600 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Capacities AssignWorkspacesToCapacity
|
Assigns the provided workspaces to the specified capacity.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Capacities UnassignWorkspacesFromCapacity
|
Unassigns the provided workspaces from capacity.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Dashboards GetDashboardsAsAdmin
|
Returns a list of dashboards for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Dashboards GetDashboardsInGroupAsAdmin
|
Returns a list of dashboards from the specified workspace.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Dashboards GetTilesAsAdmin
|
Returns a list of tiles within the specified dashboard.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Dataflows ExportDataflowAsAdmin
|
Exports the specified dataflow definition to a .json file.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
To set the permissions scope, see Register an app.
|
|
Dataflows GetDataflowDatasourcesAsAdmin
|
Returns a list of datasources for the specified dataflow.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
To set the permissions scope, see Register an app.
|
|
Dataflows GetDataflowsAsAdmin
|
Returns a list of dataflows for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Dataflows GetDataflowsInGroupAsAdmin
|
Returns a list of dataflows from the specified workspace.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Dataflows GetUpstreamDataflowsInGroupAsAdmin
|
Returns a list of upstream dataflows for the specified dataflow.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Datasets GetDatasetsAsAdmin
|
Returns a list of datasets for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API processes each request for 2 seconds, in the mean time other requests will be queued.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Datasets GetDatasetsInGroupAsAdmin
|
Returns a list of datasets from the specified workspace.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Datasets GetDatasetToDataflowsLinksInGroupAsAdmin
|
Returns a list of upstream dataflows for datasets from the specified workspace.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Datasets GetDatasourcesAsAdmin
|
Returns a list of datasources for the specified dataset.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API processes each request for 0.5 seconds, in the mean time other requests will be queued.
Required scope: Tenant.Read.All
Application only and delegated permissions are supported.
To set the permissions scope, see Register an app.
|
|
Get Activity Events
|
Returns a list of audit activity events for a tenant.
Note: Activity logging isn’t supported for Microsoft Cloud Deutschland. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All.
To call this API, provide either a continuation token or both a start and end date time. StartDateTime and EndDateTime must be in the same UTC day.
|
|
Get Capacities As Admin
|
Returns a list of capacities for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Get Power BI Encryption Keys
|
Returns the encryption keys for the tenant.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Get Refreshable For Capacity
|
Returns the specified refreshable for the specified capacity the user has access to
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Get Refreshables
|
Returns a list of refreshables for the organization within a capacity
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Get Refreshables For Capacity
|
Returns a list of refreshables for the specified capacity the user has access to
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Groups AddUserAsAdmin
|
Grants user permissions to the specified workspace.
Note: This API is currently limited to updating workspaces in the new workspace experience and adding user principle only. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Groups DeleteUserAsAdmin
|
Removes user permissions to the specified workspace.
Note: This API is currently limited to updating workspaces in the new workspace experience and adding user principle only. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Groups GetGroupsAsAdmin
|
Returns a list of workspaces for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Groups RestoreDeletedGroupAsAdmin
|
Restores a deleted workspace.
Note: This API is currently limited to restoring workspaces in the new workspace experience. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Groups UpdateGroupAsAdmin
|
Updates the specified workspace properties.
Note: This API is currently limited to updating workspaces in the new workspace experience. Only name and description can be updated, and name must be unique inside an organization. The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Imports GetImportsAsAdmin
|
Returns a list of imports for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Patch Capacity As Admin
|
Changes the specific capacity information. Currently, only supports changing the capacity encryption key
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Reports GetReportsAsAdmin
|
Returns a list of reports for the organization.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Reports GetReportsInGroupAsAdmin
|
Returns a list of reports from the specified workspace.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 200 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
Rotate Power BI Encryption Key
|
Rotate the encryption key for Power BI workspaces assigned to a capacity.
Note: The user must have administrator rights (such as Office 365 Global Administrator or Power BI Service Administrator) to call this API.
This API allows 600 requests per hour at maximum.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
WorkspaceInfo GetModifiedWorkspaces
|
Gets a list of workspace IDs in the organization. When using modifiedSince, returns only the IDs of workspaces that had changed since the time specified in the modifiedSince parameter. If not provided, returns a list of all workspace IDs in the organization. modifiedSince parameter should range from 30 minutes to 30 days ago. Notice changes can take up to 30 minutes to take effect.
Note: The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows a maximum of 30 requests per hour.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
WorkspaceInfo GetScanResult
|
Gets scan result for the specified scan (should be called only after getting status Succeeded in the scan status API). Scan result will be available for up to 24 hours
Note: The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows a maximum of 500 requests per hour.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
WorkspaceInfo GetScanStatus
|
Gets scan status for the specified scan
Note: The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows a maximum of 10000 requests per hour.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|
|
WorkspaceInfo PostWorkspaceInfo
|
Initiate a call to receive metadata for the requested list of workspaces
Note: The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) to call this API or authenticate via service principal.
This API allows a maximum of 500 requests per hour.
Required scope: Tenant.Read.All or Tenant.ReadWrite.All
To set the permissions scope, see Register an app.
|