Capacities - Get Workloads

Service:

Power BI REST APIs

API Version:

v1.0

指定した容量ワークロードの現在の状態を返します。 ワークロードが有効になっている場合は、ワークロードが消費できる最大メモリの割合も返されます。

ワークロード API は 、Gen2 容量には関係ありません。

必要なスコープ

Capacity.Read.All または Capacity.ReadWrite.All

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

URI パラメーター

名前	/	必須	型	説明
capacityId	path	True	string uuid	容量 ID

応答

名前	型	説明
200 OK	Workloads	OK

例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/capacities/0f084df7-c13d-451b-af5f-ed0c466403b2/Workloads

Sample Response

Status code:

200

{
  "value": [
    {
      "state": "Enabled",
      "name": "Dataflows",
      "maxMemoryPercentageSetByUser": "66"
    },
    {
      "state": "Disabled",
      "name": "PaginatedReports"
    }
  ]
}

定義

名前	説明
Workload	容量ワークロードの設定
Workloads	容量ワークロード設定リストの OData 応答ラッパー
WorkloadState	容量ワークロードの状態

Workload

容量ワークロードの設定

名前	型	説明
maxMemoryPercentageSetByUser	integer	ワークロードが消費できる最大メモリの割合 (ユーザーが設定)
name	string	ワークロード名
state	WorkloadState	容量ワークロードの状態

Workloads

容量ワークロード設定リストの OData 応答ラッパー

名前	型	説明
odata.context	string
value	Workload[]	容量ワークロード設定の一覧

WorkloadState

容量ワークロードの状態

名前	型	説明
Disabled	string	ワークロードが無効になっている
Enabled	string	ワークロードが有効になっている
Unsupported	string	ワークロードは現在の容量 SKU ではサポートされていないため、有効にできません。 この値は、 Patch Workload API 呼び出しでユーザーが設定することはできません。