Admin - Datasets GetDatasetsInGroupAsAdmin

从指定工作区返回数据集的列表。

权限

  • 用户必须具有管理员权限 (,例如Office 365全局管理员或 Power BI 服务管理员) 或使用服务主体进行身份验证。
  • 支持委派权限。

在服务原始身份验证下运行时,应用不得在Azure 门户中为其设置任何管理员同意所需的 Power BI 授权。

必需范围

Tenant.Read.All 或 Tenant.ReadWrite.All

仅当通过标准委派管理员访问令牌进行身份验证时才相关。 使用通过服务主体进行身份验证时,不得存在。

限制

每小时最多 200 个请求。

GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/datasets
GET https://api.powerbi.com/v1.0/myorg/admin/groups/{groupId}/datasets?$filter={$filter}&$top={$top}&$skip={$skip}&$expand={$expand}

URI 参数

名称 必需 类型 说明
groupId
path True

string

uuid

工作区 ID

$expand
query

string

内联扩展相关实体

$filter
query

string

基于布尔条件筛选结果

$skip
query

integer

int32

跳过前 n 个结果

$top
query

integer

int32

仅返回前 n 个结果

响应

名称 类型 说明
200 OK

AdminDatasets

确定

示例

Example
Example with expand on encryption

Example

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "addRowsAPIEnabled": false,
      "configuredBy": "john@contoso.com",
      "isRefreshable": true,
      "isEffectiveIdentityRequired": false,
      "isEffectiveIdentityRolesRequired": false,
      "isOnPremGatewayRequired": false,
      "isInPlaceSharingEnabled": false
    }
  ]
}

Example with expand on encryption

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets?$expand=encryption

Sample Response

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing",
      "addRowsAPIEnabled": false,
      "configuredBy": "john@contoso.com",
      "isRefreshable": true,
      "isEffectiveIdentityRequired": false,
      "isEffectiveIdentityRolesRequired": false,
      "isOnPremGatewayRequired": false,
      "isInPlaceSharingEnabled": false,
      "encryption": {
        "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
        "encryptionStatus": "InSyncWithWorkspace"
      }
    }
  ]
}

定义

名称 说明
AdminDataset

管理员 API 返回的 Power BI 数据集。 API 返回以下数据集属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

AdminDatasets

数据集 odata 列表包装器

DatasetQueryScaleOutSettings

查询数据集的横向扩展设置

DatasetUser

数据集的 Power BI 用户访问权限条目

DatasetUserAccessRight

用户对数据集的访问权限 (权限级别)

DependentDataflow

依赖于 Power BI 的数据流

Encryption

数据集的加密信息

EncryptionStatus

数据集加密状态

PrincipalType

主体类型

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案

AdminDataset

管理员 API 返回的 Power BI 数据集。 API 返回以下数据集属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。

名称 类型 说明
ContentProviderType

string

数据集的内容提供程序类型

CreateReportEmbedURL

string

数据集创建报表嵌入 URL

CreatedDate

string

数据集创建日期和时间

Encryption

Encryption

数据集加密信息。 仅在指定 时 $expand 适用。

IsEffectiveIdentityRequired

boolean

数据集是否需要有效的标识,必须在 GenerateToken API 调用中发送该标识。

IsEffectiveIdentityRolesRequired

boolean

是否在 Power BI .pbix 文件中定义行级别安全性。 如果是这样,则必须指定角色。

IsInPlaceSharingEnabled

boolean

是否可以与外部用户共享数据集,以在其自己的租户中使用

IsOnPremGatewayRequired

boolean

数据集是否需要本地数据网关

IsRefreshable

boolean

数据集是否可刷新。 Power BI 可刷新数据集是至少刷新一次或存在有效刷新计划的数据集。

QnaEmbedURL

string

数据集 Q&A 嵌入 URL

addRowsAPIEnabled

boolean

数据集是否允许添加新行

configuredBy

string

数据集所有者

description

string

数据集说明

id

string

数据集 ID

name

string

数据集名称

queryScaleOutSettings

DatasetQueryScaleOutSettings

查询数据集的横向扩展设置

targetStorageMode

string

数据集存储模式

upstreamDataflows

DependentDataflow[]

此项目所依赖的所有数据流的列表

users

DatasetUser[]

(数据集用户访问详细信息) 空值。 在即将发布的版本中,将从有效负载响应中删除此属性。 可以使用获取数据集用户作为 管理员 API 或带 getArtifactUsers 参数的 PostWorkspaceInfo API,检索有关 Power BI 项 (的用户信息,例如报表或仪表板)

webUrl

string

数据集的 Web URL

workspaceId

string

数据集工作区 ID。 此属性仅在 GetDatasetsAsAdmin 中返回。

AdminDatasets

数据集 odata 列表包装器

名称 类型 说明
odata.context

string

OData 上下文

value

AdminDataset[]

数据集

DatasetQueryScaleOutSettings

查询数据集的横向扩展设置

名称 类型 说明
autoSyncReadOnlyReplicas

boolean

数据集是否自动同步只读副本

maxReadOnlyReplicas

integer

数据集的最大只读副本数 (0-64,自动副本数为 -1)

DatasetUser

数据集的 Power BI 用户访问权限条目

名称 类型 说明
datasetUserAccessRight

DatasetUserAccessRight

用户对数据集的访问权限 (权限级别)

displayName

string

主体的显示名称

emailAddress

string

用户的电子邮件地址

graphId

string

Microsoft Graph 中主体的标识符。 仅适用于管理员 API。

identifier

string

主体的标识符

principalType

PrincipalType

主体类型

profile

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案

userType

string

用户的类型。

DatasetUserAccessRight

用户对数据集的访问权限 (权限级别)

名称 类型 说明
None

string

删除对数据集中内容的权限

Read

string

授予对数据集中内容的读取访问权限

ReadExplore

string

授予对数据集中内容的读取和浏览访问权限

ReadReshare

string

授予对数据集中内容的读取和重新共享访问权限

ReadReshareExplore

string

授予对数据集中内容的读取、重新共享和浏览访问权限

ReadWrite

string

授予对数据集中内容的读取和写入访问权限

ReadWriteExplore

string

授予对数据集中内容的读取、写入和浏览访问权限

ReadWriteReshare

string

授予对数据集中内容的读取、写入和重新共享访问权限

ReadWriteReshareExplore

string

授予对数据集中内容的读取、写入、重新共享和浏览访问权限

DependentDataflow

依赖于 Power BI 的数据流

名称 类型 说明
groupId

string

目标组 ID

targetDataflowId

string

目标数据流 ID

Encryption

数据集的加密信息

名称 类型 说明
EncryptionStatus

EncryptionStatus

数据集加密状态

EncryptionStatus

数据集加密状态

名称 类型 说明
InSyncWithWorkspace

string

支持加密,并且与加密设置同步

NotInSyncWithWorkspace

string

支持加密,但与加密设置不同步

NotSupported

string

此数据集不支持加密

Unknown

string

由于数据集损坏,加密状态未知

PrincipalType

主体类型

名称 类型 说明
App

string

服务主体类型

Group

string

组主体类型

None

string

无主体类型。 用于整个组织级别的访问。

User

string

用户主体类型

ServicePrincipalProfile

Power BI 服务主体配置文件。 仅适用于Power BI Embedded多租户解决方案

名称 类型 说明
displayName

string

服务主体配置文件名称

id

string

服务主体配置文件 ID