Push Datasets - Datasets PostDataset

服务:

Power BI REST APIs

API 版本:

v1.0

在“我的工作区”创建新数据集。

所需范围

Dataset.ReadWrite.All

局限性

此 API 调用仅支持 推送数据集。 有关限制的完整列表，请参阅 推送数据集限制。

POST https://api.powerbi.com/v1.0/myorg/datasets

具有可选参数:

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy={defaultRetentionPolicy}

URI 参数

名称	在	必需	类型	说明
defaultRetentionPolicy	query		DefaultRetentionPolicy	默认保留策略

请求正文

名称	必需	类型	说明
name	True	string	数据集名称
tables	True	Table[]	数据集表
datasources		Datasource[]	与此数据集关联的数据源
defaultMode		DatasetMode	数据集模式或类型
relationships		Relationship[]	数据集关系

响应

名称	类型	说明
201 Created	Dataset	已创建
202 Accepted	Dataset	已接受

示例

Push example

示例请求

POST https://api.powerbi.com/v1.0/myorg/datasets?defaultRetentionPolicy=basicFIFO

请求正文

{
  "name": "SalesMarketing",
  "defaultMode": "Push",
  "tables": [
    {
      "name": "Product",
      "columns": [
        {
          "name": "ProductID",
          "dataType": "Int64"
        },
        {
          "name": "Name",
          "dataType": "string"
        },
        {
          "name": "Category",
          "dataType": "string"
        },
        {
          "name": "IsCompete",
          "dataType": "bool"
        },
        {
          "name": "ManufacturedOn",
          "dataType": "DateTime"
        },
        {
          "name": "Sales",
          "dataType": "Int64",
          "formatString": "Currency"
        }
      ]
    }
  ]
}

示例响应

状态代码:

201

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "defaultRetentionPolicy": "basicFIFO"
}

定义

名称	说明
ASMashupExpression	数据集表源
Column	数据集列
CreateDatasetRequest	Power BI 数据集
CrossFilteringBehavior	关系的筛选器方向
Dataset	Power BI 数据集。 API 返回以下数据集属性列表的子集。 子集取决于调用的 API、调用方权限以及 Power BI 数据库中数据的可用性。
DatasetMode	数据集模式或类型
DatasetQueryScaleOutSettings	查询数据集的横向扩展设置
DatasetUser	Power BI 用户访问数据集的权限条目
DatasetUserAccessRight	用户对数据集拥有的访问权限（权限级别）
Datasource	Power BI 数据源
DatasourceConnectionDetails	Power BI 数据源连接详细信息。 请参阅 获取数据源 或 组获取数据源的示例。
DefaultRetentionPolicy	默认保留策略
DependentDataflow	Power BI 依赖数据流
Encryption	数据集的加密信息
EncryptionStatus	数据集加密状态
Measure	Power BI 度量值
PrincipalType	主体类型
Relationship	数据集中的表之间的关系
Row	数据集中的数据行
ServicePrincipalProfile	Power BI 服务主体配置文件。 仅适用于 Power BI Embedded 多租户解决方案。
Table	数据集表

ASMashupExpression

Object

数据集表源

名称	类型	说明
expression	string	源表达式

Column

Object

数据集列

名称	类型	说明
dataCategory	string	可选。 要用于描述此列中数据的数据类别的字符串值。
dataType	string	列数据类型
formatString	string	可选。 FORMAT_STRING中指定的列的格式。
isHidden	boolean	可选。 是否隐藏列。 默认值为 false。
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	列名
sortByColumn	string	可选。 要用于对当前列进行排序的同一表中列的字符串名称。
summarizeBy	string	可选。 用于汇总此列的聚合函数。

CreateDatasetRequest

Object

Power BI 数据集

名称	类型	说明
datasources	Datasource[]	与此数据集关联的数据源
defaultMode	DatasetMode	数据集模式或类型
name	string	数据集名称
relationships	Relationship[]	数据集关系
tables	Table[]	数据集表

CrossFilteringBehavior

枚举

关系的筛选器方向

值	说明
Automatic	自动定义交叉筛选行为
BothDirections	出于筛选目的，这两个表都被视为单个表。
OneDirection	出于筛选目的，筛选器将应用于聚合值的表。

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

DatasetMode

枚举

数据集模式或类型

值	说明
AsAzure	与 Azure Analysis Services 建立实时连接的数据集
AsOnPrem	具有与本地 Azure Analysis Services 的实时连接的数据集
Push	允许以编程方式访问将数据推送到 Power BI 的数据集
PushStreaming	支持数据流式处理并允许以编程方式访问将数据推送到 Power BI 的数据集
Streaming	支持数据流式传输的数据集。 有关详细信息，请参阅 Power BI 中的实时流式处理。

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	授予对数据集中内容的读取访问权限
ReadExplore	授予对数据集中内容的读取和浏览访问权限
ReadReshare	授予对数据集中内容的读取和重新共享访问权限
ReadReshareExplore	授予对数据集中内容的读取、重新共享和浏览访问权限
ReadWrite	授予对数据集中内容的读取和写入访问权限
ReadWriteExplore	授予对数据集中内容的读取、写入和浏览访问权限
ReadWriteReshare	授予对数据集中内容的读取、写入和重新共享访问权限
ReadWriteReshareExplore	授予对数据集中内容的读取、写入、重新共享和浏览访问权限

Datasource

Object

Power BI 数据源

名称	类型	说明
connectionDetails	DatasourceConnectionDetails	数据源连接详细信息
connectionString	string	（已弃用）数据源连接字符串。 仅适用于 DirectQuery。
datasourceId	string (uuid)	绑定数据源 ID，未绑定到网关时为空
datasourceType	string	数据源类型
gatewayId	string (uuid)	绑定网关 ID，在未绑定到网关时为空。 使用网关群集时，网关 ID 引用群集中的主网关（第一个）网关，类似于网关群集 ID。
name	string	（已弃用）数据源名称。 仅适用于 DirectQuery。

DatasourceConnectionDetails

Object

Power BI 数据源连接详细信息。 请参阅 获取数据源 或 组获取数据源的示例。

名称	类型	说明
account	string	连接帐户
classInfo	string	连接类信息
database	string	连接数据库
domain	string	连接域
emailAddress	string	连接电子邮件地址
kind	string	连接类型
loginServer	string	连接登录服务器
path	string	连接路径
server	string	连接服务器
url	string	连接 URL

DefaultRetentionPolicy

枚举

默认保留策略

值	说明
None	没有
basicFIFO	basicFIFO

DependentDataflow

Object

Power BI 依赖数据流

名称	类型	说明
groupId	string	目标组 ID
targetDataflowId	string	目标数据流 ID

Encryption

Object

数据集的加密信息

名称	类型	说明
EncryptionStatus	EncryptionStatus	数据集加密状态

EncryptionStatus

枚举

数据集加密状态

值	说明
InSyncWithWorkspace	支持加密，并且与加密设置同步
NotInSyncWithWorkspace	支持加密，但不与加密设置同步
NotSupported	此数据集不支持加密
Unknown	由于数据集损坏，加密状态未知

Measure

Object

Power BI 度量值

名称	类型	说明
description	string	可选。 度量值说明。
expression	string	有效的 DAX 表达式
formatString	string	可选。 一个字符串，描述值在 FORMAT_STRING中指定的显示方式时应如何设置其格式。
isHidden	boolean	可选。 度量值是否隐藏。
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	度量值名称

PrincipalType

枚举

主体类型

值	说明
App	服务主体类型
Group	组主体类型
None	无主体类型。 用于整个组织级别的访问。
User	用户主体类型

Relationship

Object

数据集中的表之间的关系

名称	类型	默认值	说明
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	关系的筛选器方向
fromColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		外键列的名称
fromTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		外键表的名称
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		关系名称和标识符
toColumn	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$		主键列的名称
toTable	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$		主键表的名称

Row

Object

数据集中的数据行

名称	类型	说明
id	string	唯一行 ID

ServicePrincipalProfile

Object

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

名称	类型	说明
displayName	string	服务主体配置文件名称
id	string (uuid)	服务主体配置文件 ID

Table

Object

数据集表

名称	类型	说明
columns	Column[]	此表的列架构
description	string	表说明
isHidden	boolean	可选。 是否隐藏此数据集表。
measures	Measure[]	此表中的度量值
name	string pattern: ^[\x09\x0A\x0D\x20\x23\x2D\x30-\x39\x40-\x5A\x5E-\x5F\x61-\x7A\x7E-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]{1,100}$	表名称
rows	Row[]	此表中的数据行
source	ASMashupExpression[]	表源