Capacities - Patch Workload

Service:

Power BI REST APIs

API Version:

v1.0

将特定工作负荷的状态更改为 “已启用” 或 “已禁用”。 启用工作负荷时，请指定工作负荷可以使用的最大内存百分比。

工作负载 API 与 Gen2 容量无关。

所需范围

Capacity.ReadWrite.All

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

URI 参数

名称	在	必需	类型	说明
capacityId	path	True	string uuid	容量 ID
workloadName	path	True	string	工作负荷的名称

请求正文

名称	必需	类型	说明
state	True	WorkloadState	容量工作负荷状态
maxMemoryPercentageSetByUser		integer	工作负荷可以使用的最大内存百分比 (由用户设置)

响应

名称	类型	说明
200 OK		确定

示例

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

定义

名称	说明
PatchWorkloadRequest	修补工作负载设置请求
WorkloadState	容量工作负荷状态

PatchWorkloadRequest

修补工作负载设置请求

名称	类型	说明
maxMemoryPercentageSetByUser	integer	工作负荷可以使用的最大内存百分比 (由用户设置)
state	WorkloadState	容量工作负荷状态

WorkloadState

容量工作负荷状态

名称	类型	说明
Disabled	string	工作负荷已禁用
Enabled	string	工作负载已启用
Unsupported	string	工作负载不受当前容量 SKU 支持，无法启用。 用户在 修补工作负载 API 调用中不能设置此值。