Groups - Get Group

指定したワークスペースを返します。

アクセス許可

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

必要なスコープ

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

制限事項

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

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

URI パラメーター

名前 / 必須 説明
groupId
path True

string

uuid

ワークスペース ID

応答

名前 説明
200 OK

Group

OK

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48

Sample Response

{
  "id": "f089354e-8366-4e18-aea3-4cb4a3a50b48",
  "isReadOnly": false,
  "isOnDedicatedCapacity": true,
  "capacityId": "0f084df7-c13d-451b-af5f-ed0c466403b2",
  "defaultDatasetStorageFormat": "Small",
  "name": "Sample Group 1"
}

定義

名前 説明
AzureResource

Log Analytics ワークスペースなどのユーザー所有の Azure リソースを詳しく説明する応答。

DefaultDatasetStorageFormat

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

Group

Power BI グループ

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

グループ名