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 參數

名稱	位於	必要	類型	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

範例要求

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

定義

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

Object

數據集數據表來源

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

Column

Object

數據集數據行

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

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

CrossFilteringBehavior

列舉型別

關聯性的篩選方向

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

Dataset

Object

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

名稱	類型	Description
ContentProviderType	string	應該忽略的已淘汰屬性。
Encryption	Encryption	數據集加密資訊。只有在指定 `$expand` 時才適用。
IsEffectiveIdentityRequired	boolean	數據集是否需要有效的身分識別，您必須在 GenerateToken API 呼叫中傳送該身分識別。
IsEffectiveIdentityRolesRequired	boolean	數據列層級安全性是否定義在Power BI .pbix檔案內。如果是，您必須指定角色。
IsInPlaceSharingEnabled	boolean	是否可以與外部使用者共享數據集，以在自己的租用戶中取用
IsOnPremGatewayRequired	boolean	數據集是否需要內部部署數據閘道
IsRefreshable	boolean	當數據集最近重新整理或設定為自動重新整理時，此欄位會傳回 `true`，且連線模式特別設定為 [匯入]。不論數據集是手動重新整理還是設定自動重新整理，值都會傳回其他連接模式的 `false`，例如 'DirectQuery' 和 'LiveConnection'。
addRowsAPIEnabled	boolean	數據集是否允許新增數據列
configuredBy	string	數據集擁有者
createReportEmbedURL	string	數據集建立報表內嵌 URL
createdDate	string (date-time)	數據集建立日期和時間
description	string	數據集描述
id	string	數據集標識碼
name	string	數據集名稱
qnaEmbedURL	string	數據集 Q&內嵌 URL
queryScaleOutSettings	DatasetQueryScaleOutSettings	查詢數據集的向外延展設定
targetStorageMode	string	數據集儲存模式
upstreamDataflows	DependentDataflow[]	此專案相依的所有資料流清單
users	DatasetUser[]	（空白值）數據集使用者存取詳細數據。這個屬性將會從即將發行的承載回應中移除。您可以使用取得數據集使用者做為 Admin API，或使用參數的 `getArtifactUsers` API 來擷取 Power BI 專案的使用者資訊（例如報表或儀錶板）。
webUrl	string	數據集的 Web URL

DatasetMode

列舉型別

數據集模式或類型

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

DatasetQueryScaleOutSettings

Object

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

名稱	類型	Description
autoSyncReadOnlyReplicas	boolean	數據集是否自動同步只讀複本
maxReadOnlyReplicas	integer minimum: -1 maximum: 64	資料集的唯讀複本數目上限（0-64，-1 自動復本數目）

DatasetUser

Object

數據集的 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	拿掉資料集中內容的許可權
Read	授與數據集中內容的讀取許可權
ReadWrite	授與數據集中內容的讀取和寫入存取權
ReadReshare	授與讀取和重新共享數據集中內容的存取權
ReadWriteReshare	授與數據集中內容的讀取、寫入和重新共用存取權
ReadExplore	授與讀取和探索數據集中內容的存取權
ReadReshareExplore	授與讀取、重新共用和探索數據集中內容的存取權
ReadWriteExplore	授與數據集中內容的讀取、寫入和探索存取權
ReadWriteReshareExplore	授與讀取、寫入、重新共用和探索數據集中內容的存取權

Datasource

Object

Power BI 數據源

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

DatasourceConnectionDetails

Object

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	沒有
basicFIFO	basicFIFO

DependentDataflow

Object

Power BI 相依數據流

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

Encryption

Object

數據集的加密資訊

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

EncryptionStatus

列舉型別

數據集加密狀態

值	Description
Unknown	由於數據集損毀，加密狀態不明
NotSupported	此數據集不支援加密
InSyncWithWorkspace	支援加密，且與加密設定同步
NotInSyncWithWorkspace	支援加密，但未與加密設定同步

Measure

Object

Power BI 量值

名稱	類型	Description
description	string	自選。量值描述。
expression	string	有效的 DAX 運算式
formatString	string	自選。字串，描述當值顯示為 FORMAT_STRING中所指定時，應該如何格式化此值。
isHidden	boolean	自選。是否隱藏量值。
name	string pattern: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]+$	量值名稱

PrincipalType

列舉型別

主體類型

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

Relationship

Object

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

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

數據集中的數據列

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

ServicePrincipalProfile

Object

Power BI 服務主體配置檔。僅與 Power BI Embedded 多租使用者解決方案相關。

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

Table

Object

數據集數據表

名稱	類型	Description
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[]	數據表來源

共用方式為

Push Datasets - Datasets PostDataset

必要範圍

局限性

URI 參數

要求本文

回應

範例

Push example

範例要求

範例回覆

定義

ASMashupExpression

Column

CreateDatasetRequest

CrossFilteringBehavior

Dataset

DatasetMode

DatasetQueryScaleOutSettings

DatasetUser

DatasetUserAccessRight

Datasource

DatasourceConnectionDetails

DefaultRetentionPolicy

DependentDataflow

Encryption

EncryptionStatus

Measure

PrincipalType

Relationship

Row

ServicePrincipalProfile

Table