Push Datasets - Datasets PostDataset

參考

Service:: Power BI REST APIs

API Version:: v1.0

在 [我的工作區] 上建立新的數據集。

必要範圍

Dataset.ReadWrite.All

限制

此 API 呼叫僅支援 推送數據集。如需完整的限制清單，請參閱推送數據集限制。

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

With optional parameters:

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

URI 參數

名稱	位於	必要	類型	Description
defaultRetentionPolicy	query		DefaultRetentionPolicy	默認保留原則

要求本文

名稱	必要	類型	Description
name	True	string	數據集名稱
tables	True	Table[]	數據集數據表
datasources		Datasource[]	與此數據集相關聯的數據源
defaultMode		DatasetMode	數據集模式或類型
relationships		Relationship[]	數據集關聯性

回應

名稱	類型	Description
201 Created	Dataset	建立時間
202 Accepted	Dataset	已接受

範例

Push example

Sample Request

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

Request Body

{
  "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"
        }
      ]
    }
  ]
}

Sample Response

Status code:: 201

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

定義

名稱	Description
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

數據集數據表來源

名稱	類型	Description
expression	string	來源表達式

Column

數據集數據行

名稱	類型	Description
dataCategory	string	選擇性。要用於描述此資料列內數據的數據類別目錄的字串值。
dataType	string	數據行數據類型
formatString	string	選擇性。 FORMAT_STRING中指定的數據行格式。
isHidden	boolean	選擇性。數據行是否隱藏。預設為 `false`。
name	string	數據行名稱
sortByColumn	string	選擇性。要用以排序目前資料行的相同資料表中，資料行的字串名稱。
summarizeBy	string	選擇性。要用於摘要此數據行的聚合函數。

CreateDatasetRequest

Power BI 數據集

名稱	類型	Description
datasources	Datasource[]	與此數據集相關聯的數據源
defaultMode	DatasetMode	數據集模式或類型
name	string	數據集名稱
relationships	Relationship[]	數據集關聯性
tables	Table[]	數據集數據表

CrossFilteringBehavior

關聯性的篩選方向

名稱	類型	Description
Automatic	string	交叉篩選行為會自動定義
BothDirections	string	為了篩選目的，這兩個數據表都會被視為單一數據表。
OneDirection	string	基於篩選目的，篩選將會套用至匯總值的數據表。

Dataset

Power BI 數據集。 API 會傳回下列資料集屬性清單的子集。子集取決於稱為的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。

名稱	類型	Description
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&內嵌 URL
addRowsAPIEnabled	boolean	數據集是否允許新增數據列
configuredBy	string	數據集擁有者
description	string	數據集描述
id	string	數據集標識碼
name	string	數據集名稱
queryScaleOutSettings	DatasetQueryScaleOutSettings	查詢數據集的向外延展設定
targetStorageMode	string	數據集儲存模式
upstreamDataflows	DependentDataflow[]	此專案所依存的所有資料流清單
users	DatasetUser[]	(空白值) 數據集使用者存取詳細數據。這個屬性將會從即將推出的承載回應中移除。您可以使用取得數據集使用者作為管理員 API，或使用參數的 PostWorkspaceInfo API`getArtifactUsers`，擷取 Power BI 專案 (例如報表或儀錶板) 的使用者資訊。
webUrl	string	數據集的 Web URL

DatasetMode

數據集模式或類型

名稱	類型	Description
AsAzure	string	具有與 Azure Analysis Services 即時連線的數據集
AsOnPrem	string	具有內部部署 Azure Analysis Services 即時連線的數據集
Push	string	允許以程式設計方式存取將數據推送至 Power BI 的數據集
PushStreaming	string	支援數據流的數據集，並允許以程序設計方式存取將數據推送至 Power BI
Streaming	string	支援數據流的數據集。如需詳細資訊，請參閱 Power BI 中的即時串流。

DatasetQueryScaleOutSettings

查詢數據集的向外延展設定

名稱	類型	Description
autoSyncReadOnlyReplicas	boolean	數據集是否自動同步只讀複本
maxReadOnlyReplicas	integer	數據集的只讀複本數目上限 (0-64，-1 則為自動複本數目)

DatasetUser

數據集的 Power BI 使用者存取權專案

名稱	類型	Description
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

用戶對於數據集的存取權 (許可權等級)

名稱	類型	Description
None	string	拿掉資料集中內容的許可權
Read	string	授與數據集中內容的讀取許可權
ReadExplore	string	授與數據集中內容的讀取和探索存取權
ReadReshare	string	授與數據集中內容的讀取和重新共用存取權
ReadReshareExplore	string	授與數據集中內容的讀取、重新共用和探索存取權
ReadWrite	string	授與數據集中內容的讀取和寫入存取權
ReadWriteExplore	string	授與數據集中內容的讀取、寫入和探索存取權
ReadWriteReshare	string	授與數據集中內容的讀取、寫入和重新共用存取權
ReadWriteReshareExplore	string	授與數據集中內容的讀取、寫入、重新共用和探索存取權

Datasource

Power BI 數據源

名稱	類型	Description
connectionDetails	DatasourceConnectionDetails	數據源聯機詳細數據
connectionString	string	(已淘汰) 數據源連接字串。僅適用於 DirectQuery。
datasourceId	string	系結數據源標識碼，未系結至閘道時是空的
datasourceType	string	數據源類型
gatewayId	string	系結閘道標識碼，未系結至閘道時是空的。使用閘道叢集時，閘道標識碼是指叢集中第一個) 閘道的主要 (，且類似於閘道叢集標識碼。
name	string	(已取代) 數據來源名稱。僅適用於 DirectQuery。

DatasourceConnectionDetails

Power BI 數據源聯機詳細數據。請參閱取得數據源或取得群組中的數據源中的範例。

名稱	類型	Description
account	string	線上帳戶
classInfo	string	連接類別資訊
database	string	連接資料庫
domain	string	線上網域
emailAddress	string	線上電子郵件位址
kind	string	連接種類
loginServer	string	線上登入伺服器
path	string	線上路徑
server	string	連接伺服器
url	string	線上 URL

DefaultRetentionPolicy

默認保留原則

名稱	類型	Description
None	string	無
basicFIFO	string	basicFIFO

DependentDataflow

Power BI 相依數據流

名稱	類型	Description
groupId	string	目標組標識碼
targetDataflowId	string	目標數據流標識碼

Encryption

數據集的加密資訊

名稱	類型	Description
EncryptionStatus	EncryptionStatus	數據集加密狀態

EncryptionStatus

數據集加密狀態

名稱	類型	Description
InSyncWithWorkspace	string	支援加密，且與加密設定同步
NotInSyncWithWorkspace	string	支援加密，但未與加密設定同步
NotSupported	string	此數據集不支援加密
Unknown	string	加密狀態不明，因為數據集損毀

Measure

Power BI 量值

名稱	類型	Description
description	string	選擇性。量值描述。
expression	string	有效的 DAX 運算式
formatString	string	選擇性。字串，描述值在顯示為如 FORMAT_STRING 中所指定時應如何格式化。
isHidden	boolean	選擇性。量值是否隱藏。
name	string	量值名稱

PrincipalType

主體類型

名稱	類型	Description
App	string	服務主體類型
Group	string	群組主體類型
None	string	沒有主體類型。用於整個組織層級存取。
User	string	用戶主體類型

Relationship

數據集中數據表之間的關聯性

名稱	類型	預設值	Description
crossFilteringBehavior	CrossFilteringBehavior	OneDirection	關聯性的篩選方向
fromColumn	string		外鍵數據行的名稱
fromTable	string		外鍵數據表的名稱
name	string		關聯性名稱和識別碼
toColumn	string		主鍵數據行的名稱
toTable	string		主鍵數據表的名稱

Row

數據集中的數據列

名稱	類型	Description
id	string	唯一的數據列標識碼

ServicePrincipalProfile

Power BI 服務主體配置檔。僅適用於 Power BI Embedded 多租用戶解決方案。

名稱	類型	Description
displayName	string	服務主體配置檔名稱
id	string	服務主體配置檔識別碼

Table

數據集數據表

名稱	類型	Description
columns	Column[]	此數據表的數據行架構
description	string	數據表描述
isHidden	boolean	選擇性。此數據集數據表是否隱藏。
measures	Measure[]	此數據表內的量值
name	string	資料表名稱
rows	Row[]	此數據表中的數據列
source	ASMashupExpression[]	數據表來源