Capacities - Patch Workload

Changes the state of a specific workload to Enabled or Disabled. When enabling a workload, specify the percentage of maximum memory that the workload can consume.

Workload APIs aren't relevant for Embedded Gen2 capacities.

Required Scope

Capacity.ReadWrite.All

PATCH 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

Request Body

Name Required Type Description
state True

The capacity workload state

maxMemoryPercentageSetByUser
  • integer

The percentage of the maximum memory that a workload can consume (set by the user)

Responses

Name Type Description
200 OK

OK

Examples

Example

Sample Request

PATCH https://api.powerbi.com/v1.0/myorg/capacities/0f084df7-c13d-451b-af5f-ed0c466403b2/Workloads/Dataflows
{
  "state": "Enabled",
  "maxMemoryPercentageSetByUser": "66"
}

Sample Response

Definitions

PatchWorkloadRequest

Patch workload setting request

WorkloadState

The capacity workload state

PatchWorkloadRequest

Patch workload setting request

Name Type Description
maxMemoryPercentageSetByUser
  • integer

The percentage of the maximum memory that a workload can consume (set by the user)

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.