Capacities - Patch Workload

Service:: Power BI REST APIs

API Version:: v1.0

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 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	WorkloadState	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

Request Body

{
  "state": "Enabled",
  "maxMemoryPercentageSetByUser": "66"
}

Sample response

Status code:: 200

Definitions

Name	Description
PatchWorkloadRequest	Patch workload setting request
WorkloadState	The capacity workload state

PatchWorkloadRequest

Object

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	WorkloadState	The capacity workload state

WorkloadState

Enumeration

The capacity workload state

Value	Description
Disabled	The workload is disabled
Enabled	The workload is enabled
Unsupported	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.

Share via