Groups - Get Groups

Service:

Power BI REST APIs

API Version:

v1.0

返回用户有权访问的工作区的列表。

权限

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

所需范围

Workspace.Read.All 或 Workspace.ReadWrite.All

限制

• 工作区的用户权限需要一段时间才能更新，使用 API 调用时可能无法立即可用。 若要刷新用户权限，请使用 刷新用户权限 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	详细说明用户拥有的 Azure 资源（例如 Log Analytics 工作区）的响应。
DefaultDatasetStorageFormat	组中的默认数据集存储格式
Group	Power BI 组
Groups	Power BI 组列表的 OData 响应包装器

AzureResource

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

名称	类型	说明
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 工作区。 仅当检索单个组时，才会返回此值。
name	string	组名称

Groups

Power BI 组列表的 OData 响应包装器

名称	类型	说明
odata.context	string	OData 上下文
value	Group[]	组列表