Capacities - Patch Workload
Changes the state of a specific workload to Enabled or Disabled. When enabling a workload the maximum memory percentage that the workload can consume must be set.
Required scope: Capacity.ReadWrite.All
To set the permissions scope, see Register an app.
PATCH https://api.powerbi.com/v1.0/myorg/capacities/{capacityId}/Workloads/{workloadName}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
capacity
|
path | True |
|
The capacity Id |
workload
|
path | True |
|
The name of the workload |
Request Body
Name | Required | Type | Description |
---|---|---|---|
state | True |
The capacity workload state |
|
maxMemoryPercentageSetByUser |
|
The memory percentage maximum Limit 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
Patch |
Patch workload setting request |
Workload |
The capacity workload state |
PatchWorkloadRequest
Patch workload setting request
Name | Type | Description |
---|---|---|
maxMemoryPercentageSetByUser |
|
The memory percentage maximum Limit set by the user |
state |
The capacity workload state |
WorkloadState
The capacity workload state
Name | Type | Description |
---|---|---|
Disabled |
|
The workload is disabled |
Enabled |
|
The workload is enabled |
Unsupported |
|
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 |