Datasets - Get Datasets In Group

服务:: Power BI REST APIs

API 版本:: v1.0

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

权限

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

所需范围

Dataset.ReadWrite.All 或 Dataset.Read.All

局限性

调用方必须对数据集具有写入权限才能获取完整内容。具有读取权限的调用方仅在响应中获取有限的内容。

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

URI 参数

名称	在	必需	类型	说明
groupId	path	True	string (uuid)	工作区 ID

响应

名称	类型	说明
200 OK	Datasets	还行

示例

Example

Example with Read Only Permission

Example

示例请求

GET https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/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
    }
  ]
}

Example with Read Only Permission

示例请求

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

示例响应

状态代码:: 200

{
  "value": [
    {
      "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
      "name": "SalesMarketing"
    }
  ]
}

定义

名称	说明
Dataset	Power BI 数据集。 API 返回以下数据集属性列表的子集。子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。
DatasetQueryScaleOutSettings	查询数据集的横向扩展设置
Datasets	数据集 OData 列表包装器
DatasetUser	Power BI 用户访问数据集的权限条目
DatasetUserAccessRight	用户对数据集拥有的访问权限（权限级别）
DependentDataflow	Power BI 依赖数据流
Encryption	数据集的加密信息
EncryptionStatus	数据集加密状态
PrincipalType	主体类型
ServicePrincipalProfile	Power BI 服务主体配置文件。仅适用于 Power BI Embedded 多租户解决方案。

Dataset

Object

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

DatasetQueryScaleOutSettings

Object

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

名称	类型	说明
autoSyncReadOnlyReplicas	boolean	数据集是否自动同步只读副本
maxReadOnlyReplicas	integer minimum: -1 maximum: 64	数据集的最大只读副本数（0-64，-1 自动副本数）

Datasets

Object

数据集 OData 列表包装器

名称	类型	说明
@odata.context	string	OData 上下文
value	Dataset[]	数据集

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

通过

Datasets - Get Datasets In Group

权限

所需范围

局限性

URI 参数

响应

示例

Example

示例请求

示例响应

Example with Read Only Permission

示例请求

示例响应

定义

Dataset

DatasetQueryScaleOutSettings

Datasets

DatasetUser

DatasetUserAccessRight

DependentDataflow

Encryption

EncryptionStatus

PrincipalType

ServicePrincipalProfile