Capacities - Get Workloads

Service:: Power BI REST APIs

API Version:: v1.0

Returns the current state of the specified capacity workloads. If a workload is enabled, the percentage of maximum memory that the workload can consume is also returned.

Workload APIs aren't relevant for Gen2 capacities.

Required Scope

Capacity.Read.All or Capacity.ReadWrite.All

GET https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/Workloads

URI Parameters

Name	In	Required	Type	Description
capacityId	path	True	string (uuid)	The capacity ID

Responses

Name	Type	Description
200 OK	Workloads	OK

Examples

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/capacities/0f084df7-c13d-451b-af5f-ed0c466403b2/Workloads

Sample response

Status code:: 200

{
  "value": [
    {
      "state": "Enabled",
      "name": "Dataflows",
      "maxMemoryPercentageSetByUser": "66"
    },
    {
      "state": "Disabled",
      "name": "PaginatedReports"
    }
  ]
}

Definitions

Name	Description
Workload	A capacity workload setting
Workloads	OData response wrapper for capacity workload settings list
WorkloadState	The capacity workload state

Workload

Object

A capacity workload setting

Name	Type	Description
maxMemoryPercentageSetByUser	integer	The percentage of the maximum memory that a workload can consume (set by the user)
name	string	The workload name
state	WorkloadState	The capacity workload state

Workloads