通过

Admin - Datasets GetDatasetsAsAdmin

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

返回组织的数据集列表。

权限

  • 用户必须是 Fabric 管理员或使用服务主体进行身份验证。
  • 支持委派的权限。

在服务特权身份验证下运行时，应用 不得 在 Azure 门户中为其上设置的 Power BI 提供任何管理员许可。

所需范围

Tenant.Read.All 或 Tenant.ReadWrite.All

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

局限性

每个租户每小时最多 50 个请求或每分钟 5 个请求。 

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

URI 参数

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

string

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

integer (int32)

跳过前 n 个结果
$top
 query

integer (int32)

仅返回前 n 个结果

响应

名称 类型 说明
200 OK

AdminDatasets

还行

示例

Example

示例请求

GET https://api.powerbi.com/v1.0/myorg/admin/datasets

示例响应

状态代码:
200 
{
  "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,
      "workspaceId": "5c968528-70b6-4588-809f-ce811ffa5c23"
    }
  ]
}

定义

名称 说明
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

Object

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

名称 类型 说明
ContentProviderType

string

应忽略的已弃用属性。
Encryption

Encryption

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

boolean

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

boolean

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

boolean

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

boolean

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

boolean

当数据集最近刷新或配置为自动刷新时，此字段将返回 true，连接模式专门设置为“导入”。 无论数据集是手动刷新还是设置为自动刷新，该值都会为其他连接模式（如“DirectQuery”和“LiveConnection”）返回 false。
addRowsAPIEnabled

boolean

数据集是否允许添加新行
configuredBy

string

数据集所有者
createReportEmbedURL

string

数据集创建报表嵌入 URL
createdDate

string (date-time)

数据集创建日期和时间
description

string

数据集说明
id

string

数据集 ID
name

string

数据集名称
qnaEmbedURL

string

数据集 Q&嵌入 URL
queryScaleOutSettings

DatasetQueryScaleOutSettings

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

string

数据集存储模式
upstreamDataflows

DependentDataflow[]

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

DatasetUser[]

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

string

数据集的 Web URL
workspaceId

string (uuid)

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

AdminDatasets

Object

数据集 odata 列表包装器

名称 类型 说明
@odata.context

string

OData 上下文
value

AdminDataset[]

数据集

DatasetQueryScaleOutSettings

Object

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

名称 类型 说明
autoSyncReadOnlyReplicas

boolean

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

integer

minimum: -1
maximum: 64

数据集的最大只读副本数（0-64，-1 自动副本数）

DatasetUser

Object

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

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

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

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

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

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

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

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

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

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

DependentDataflow

Object

Power BI 依赖数据流

名称 类型 说明
groupId

string

目标组 ID
targetDataflowId

string

目标数据流 ID

Encryption

Object

数据集的加密信息

名称 类型 说明
EncryptionStatus

EncryptionStatus

数据集加密状态

EncryptionStatus

枚举

数据集加密状态

值 说明
Unknown

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

此数据集不支持加密
InSyncWithWorkspace

支持加密，并且与加密设置同步
NotInSyncWithWorkspace

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

PrincipalType

枚举

主体类型

值 说明
None

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

用户主体类型
Group

组主体类型
App

服务主体类型

ServicePrincipalProfile

Object

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

名称 类型 说明
displayName

string

服务主体配置文件名称
id

string (uuid)

服务主体配置文件 ID