Capacities - Get Workload

Service:
Power BI REST APIs
API Version:
v1.0

Returns the current state of a workload and if the workload is enabled also returns the maximum memory percentage that the workload can consume.

Required scope: Capacity.Read.All or Capacity.ReadWrite.All
To set the permissions scope, see Register an app.

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

URI Parameters

Name In Required Type Description
capacityId
 path True
  • string
uuid

The capacity Id
workloadName
 path True
  • string

The name of the workload

Responses

Name Type Description
200 OK

OK

Examples

example

Sample Request

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

Sample Response

Status code:
200 
{
  "value": {
    "state": "Enabled",
    "name": "Dataflows",
    "maxMemoryPercentageSetByUser": "66"
  }
}

Definitions

Workload

Capacity workload setting
WorkloadState

The capacity workload state

Workload

Capacity workload setting

Name Type Description
maxMemoryPercentageSetByUser
  • integer

The memory percentage maximum Limit set by the user
name
  • string

The workload name
state

The capacity workload state

WorkloadState

The capacity workload state

Name Type Description
Disabled
  • string

The workload is disabled
Enabled
  • string

The workload is enabled
Unsupported
  • string

The workload is unsupported by the current capacity SKU and cannot be enabled. This value cannot be set by the user in the Patch Workload