Groups - Get Group

返回指定的工作区。

权限

此 API 调用可由服务主体配置文件调用。 有关详细信息,请参阅:Power BI Embedded中的服务主体配置文件。

所需范围

Workspace.Read.All 或 Workspace.ReadWrite.All

局限性

  • 工作区的用户权限需要一段时间才能更新,在使用 API 调用时可能不会立即可用。 若要刷新用户权限,请使用 刷新用户权限 API 调用。

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

URI 参数

名称 必需 类型 说明
groupId
path True

string (uuid)

工作区 ID

响应

名称 类型 说明
200 OK

Group

还行

示例

Example

示例请求

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

示例响应

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

定义

名称 说明
AzureResource

详细说明用户拥有的 Azure 资源(例如 Log Analytics 工作区)的响应。

DefaultDatasetStorageFormat

组中的默认数据集存储格式

Group

Power BI 组

AzureResource

详细说明用户拥有的 Azure 资源(例如 Log Analytics 工作区)的响应。

名称 类型 说明
id

string (uuid)

Power BI 中资源的标识符。

resourceGroup

string

资源所在的订阅中的资源组。

resourceName

string

资源的名称。

subscriptionId

string (uuid)

资源所在的 Azure 订阅。

DefaultDatasetStorageFormat

组中的默认数据集存储格式

说明
Small

小型数据集存储格式

Large

大型数据集存储格式

Group

Power BI 组

名称 类型 说明
capacityId

string (uuid)

容量 ID

dataflowStorageId

string (uuid)

Power BI 数据流存储帐户 ID

defaultDatasetStorageFormat

DefaultDatasetStorageFormat

工作区中的默认数据集存储格式。 仅当 isOnDedicatedCapacitytrue 时返回

id

string (uuid)

工作区 ID

isOnDedicatedCapacity

boolean

是否将组分配到专用容量

isReadOnly

boolean

组是否为只读

logAnalyticsWorkspace

AzureResource

分配给组的 Log Analytics 工作区。 仅当检索单个组时,才会返回此值。

name

string

组名称