Groups - Get Groups

  • リファレンス
Service:
Power BI REST APIs
API Version:
v1.0

ユーザーがアクセスできるワークスペースの一覧を返します。

アクセス許可

この API 呼び出しは、サービス プリンシパル プロファイルによって呼び出すことができます。 詳細については、「Power BI Embeddedのサービス プリンシパル プロファイル」を参照してください。

必要なスコープ

Workspace.Read.All または Workspace.ReadWrite.All

制限事項

  • ワークスペースに対するユーザーのアクセス許可は更新に時間がかかり、API 呼び出しを使用するときにすぐに使用できない場合があります。 ユーザーのアクセス許可を更新するには、 Refresh User Permissions API 呼び出しを使用します。 

GET https://api.powerbi.com/v1.0/myorg/groups
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/groups?$filter={$filter}&$top={$top}&$skip={$skip}

URI パラメーター

名前 / 必須 型 説明
$filter
 query

string

ブール条件に基づいて結果をフィルター処理する
$skip
 query

integer

int32

最初の n 件の結果をスキップします
$top
 query

integer

int32

最初の n 個の結果のみを返します

応答

名前 型 説明
200 OK

Groups

OK

例

Example
Get a list of workspaces using a filter example

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "sample group"
    },
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Small",
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": true,
      "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
      "defaultDatasetStorageFormat": "Large",
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}

Get a list of workspaces using a filter example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups?$filter=contains(name,'marketing')%20or%20name%20eq%20'contoso'

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "3d9b93c6-7b6d-4801-a491-1738910904fd",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "marketing group"
    },
    {
      "id": "a2f89923-421a-464e-bf4c-25eab39bb09f",
      "isReadOnly": false,
      "isOnDedicatedCapacity": false,
      "name": "contoso",
      "dataflowStorageId": "d692ae06-708c-485e-9987-06ff0fbdbb1f"
    }
  ]
}

定義

名前 説明
AzureResource

Log Analytics ワークスペースなどのユーザー所有の Azure リソースの詳細を示す応答。
DefaultDatasetStorageFormat

グループ内の既定のデータセット ストレージ形式
Group

Power BI グループ
Groups

Power BI グループの一覧の OData 応答ラッパー

AzureResource

Log Analytics ワークスペースなどのユーザー所有の Azure リソースの詳細を示す応答。

名前 型 説明
id

string

Power BI 内のリソースの識別子。
resourceGroup

string

リソースが存在するサブスクリプション内のリソース グループ。
resourceName

string

リソースの名前。
subscriptionId

string

リソースが存在する Azure サブスクリプション。

DefaultDatasetStorageFormat

グループ内の既定のデータセット ストレージ形式

名前 型 説明
Large

string

大規模なデータセットのストレージ形式
Small

string

小さなデータセットのストレージ形式

Group

Power BI グループ

名前 型 説明
capacityId

string

容量 ID
dataflowStorageId

string

Power BI データフロー ストレージ アカウント ID
defaultDatasetStorageFormat

DefaultDatasetStorageFormat

ワークスペース内の既定のデータセット ストレージ形式。 が の場合 isOnDedicatedCapacity にのみ返されます true
id

string

ワークスペース ID
isOnDedicatedCapacity

boolean

グループが専用容量に割り当てられているかどうか
isReadOnly

boolean

グループが読み取り専用かどうか
logAnalyticsWorkspace

AzureResource

グループに割り当てられた Log Analytics ワークスペース。 これは、1 つのグループを取得する場合にのみ返されます。
name

string

グループ名

Groups

Power BI グループの一覧の OData 応答ラッパー

名前 型 説明
odata.context

string

OData コンテキスト
value

Group[]

グループの一覧