Capacities - Get Workload

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

Workload APIs aren't relevant for Embedded Gen2 capacities.

Required Scope

Capacity.Read.All or Capacity.ReadWrite.All

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

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

Definitions

Workload

A capacity workload setting

WorkloadState

The capacity workload state

Workload

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

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 can't be enabled. This value can't be set by the user in a Patch Workload API call.