Datasets - Get Dataset

服務:

Power BI REST APIs

API 版本:

v1.0

從 [我的工作區]傳回指定的數據集。

必要範圍

Dataset.ReadWrite.All 或 Dataset.Read.All

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

URI 參數

名稱	位於	必要	類型	Description
datasetId	path	True	string	數據集標識碼

回應

名稱	類型	Description
200 OK	Dataset	還行

範例

Example

Sample request

GET https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229

Sample response

Status code:

200

{
  "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
  "name": "SalesMarketing",
  "addRowsAPIEnabled": false,
  "configuredBy": "john@contoso.com",
  "isRefreshable": true,
  "isEffectiveIdentityRequired": true,
  "isEffectiveIdentityRolesRequired": true,
  "isOnPremGatewayRequired": false
}

定義

名稱	Description
Dataset	Power BI 數據集。 API 會傳回下列資料集屬性清單的子集。 子集取決於呼叫的 API、呼叫端許可權，以及 Power BI 資料庫中數據的可用性。
DatasetQueryScaleOutSettings	查詢數據集的向外延展設定
DatasetUser	數據集的 Power BI 使用者存取權專案
DatasetUserAccessRight	使用者對於資料集的存取權（權限等級）
DependentDataflow	Power BI 相依數據流
Encryption	數據集的加密資訊
EncryptionStatus	數據集加密狀態
PrincipalType	主體類型
ServicePrincipalProfile	Power BI 服務主體配置檔。 僅與 Power BI Embedded 多租使用者解決方案相關。

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	當數據集最近重新整理或設定為自動重新整理時，此欄位會傳回 true，且連線模式特別設定為 [匯入]。 不論數據集是手動重新整理還是設定自動重新整理，值都會傳回其他連接模式的 false，例如 'DirectQuery' 和 'LiveConnection'。
QnaEmbedURL	string	數據集 Q&內嵌 URL
addRowsAPIEnabled	boolean	數據集是否允許新增數據列
configuredBy	string	數據集擁有者
description	string	數據集描述
id	string	數據集標識碼
name	string	數據集名稱
queryScaleOutSettings	DatasetQueryScaleOutSettings	查詢數據集的向外延展設定
targetStorageMode	string	數據集儲存模式
upstreamDataflows	DependentDataflow[]	此專案相依的所有資料流清單
users	DatasetUser[]	（空白值）數據集使用者存取詳細數據。 這個屬性將會從即將發行的承載回應中移除。 您可以使用 取得數據集使用者做為 Admin API，或使用 getArtifactUsers 參數的 PostWorkspaceInfo API 來擷取 Power BI 專案的使用者資訊（例如報表或儀錶板）。
webUrl	string	數據集的 Web URL

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	授與讀取、寫入、重新共用和探索數據集中內容的存取權

DependentDataflow

Power BI 相依數據流

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

Encryption

數據集的加密資訊

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

EncryptionStatus

數據集加密狀態

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

PrincipalType

主體類型

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

ServicePrincipalProfile

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

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