通过

Groups - Get Groups

服务:
Power BI REST APIs
API 版本:
v1.0

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

权限

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

所需范围

Workspace.Read.All 或 Workspace.ReadWrite.All

局限性

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

GET https://api.powerbi.com/v1.0/myorg/groups
具有可选参数: 
GET https://api.powerbi.com/v1.0/myorg/groups?$filter={$filter}&$top={$top}&$skip={$skip}

URI 参数

名称 在 必需 类型 说明
$filter
 query

string

根据 Odata 筛选器查询参数条件返回结果的子集。
$skip
 query

integer (int32)

跳过前 n 个结果
$top
 query

integer (int32)

仅返回前 n 个结果

响应

名称 类型 说明
200 OK

Groups

还行

示例

Example
Get a list of workspaces using a filter example

Example

示例请求

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

示例响应

状态代码:
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

示例请求

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

示例响应

状态代码:
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

Object

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

名称 类型 说明
id

string (uuid)

Power BI 中资源的标识符。
resourceGroup

string

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

string

资源的名称。
subscriptionId

string (uuid)

资源所在的 Azure 订阅。

DefaultDatasetStorageFormat

枚举

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

值 说明
Small

小型数据集存储格式
Large

大型数据集存储格式

Group

Object

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

组名称

Groups

Object

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

名称 类型 说明
@odata.context

string

OData 上下文
value

Group[]

组列表