Share via

Admin - Imports GetImportsAsAdmin

  • 參考
Service:
Power BI REST APIs
API Version:
v1.0

傳回組織的匯入清單。

權限

  • 用戶必須具有系統管理員許可權 (，例如 Office 365 全域管理員或 Power BI 服務管理員) 或使用服務主體進行驗證。
  • 支援委派的許可權。

在服務預備驗證下執行時，應用程式不得在 Azure 入口網站 中設定Power BI的任何系統管理員同意必要許可權。

必要範圍

Tenant.Read.All 或 Tenant.ReadWrite.All

只有在透過標準委派的系統管理員存取令牌進行驗證時才相關。 使用透過服務主體進行驗證時，不得存在。

限制

每小時最多 200 個要求。 

GET https://api.powerbi.com/v1.0/myorg/admin/imports
With optional parameters: 
GET https://api.powerbi.com/v1.0/myorg/admin/imports?$expand={$expand}&$filter={$filter}&$top={$top}&$skip={$skip}

URI 參數

名稱 位於 必要 類型 Description
$expand
 query

string

展開內嵌的相關實體
$filter
 query

string

根據布爾條件篩選結果
$skip
 query

integer

int32

略過前 n 個結果
$top
 query

integer

int32

只傳回前 n 個結果

回應

名稱 類型 Description
200 OK

Imports

確定

範例

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/imports

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "82d9a37a-2b45-4221-b012-cb109b8e30c7",
      "importState": "Succeeded",
      "createdDateTime": "2018-05-08T14:56:18.477Z",
      "updatedDateTime": "2018-05-08T14:56:18.477Z",
      "name": "SalesMarketing",
      "connectionType": "import",
      "source": "Upload",
      "datasets": [
        {
          "id": "cfafbeb1-8037-4d0c-896e-a46fb27ff229",
          "name": "SalesMarketing",
          "webUrl": "https://app.powerbi.com/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229"
        }
      ],
      "reports": [
        {
          "id": "5b218778-e7a5-4d73-8187-f10824047715",
          "name": "SalesMarketing",
          "webUrl": "https://app.powerbi.com/reports/5b218778-e7a5-4d73-8187-f10824047715",
          "embedUrl": "https://app.powerbi.com/reportEmbed?reportId=5b218778-e7a5-4d73-8187-f10824047715"
        }
      ]
    }
  ]
}

定義

名稱 Description
Dataset

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

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

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

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

DependentDataflow

Power BI 相依數據流
Encryption

數據集的加密資訊
EncryptionStatus

數據集加密狀態
Import

匯入物件
Imports

Power BI 匯入集合的 OData 回應包裝函式
PrincipalType

主體類型
Report

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

報表的 Power BI 使用者存取權專案
ReportUserAccessRight

用戶對於報表的存取權， (許可權等級)

ServicePrincipalProfile

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

Power BI 專案的電子郵件訂閱 (，例如報表或儀錶板)

SubscriptionUser

Power BI 電子郵件訂閱使用者

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，或使用 getArtifactUsers 參數來擷取 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

加密狀態不明，因為數據集損毀

Import

匯入物件

名稱 類型 Description
createdDateTime

string

匯入建立日期和時間
datasets

Dataset[]

與此匯入相關聯的數據集
id

string

匯入標識碼
importState enum:
  • Failed
  • Publishing
  • Succeeded

匯入上傳狀態
name

string

匯入名稱
reports

Report[]

與此匯入相關聯的報告
updatedDateTime

string

匯入上次更新日期和時間

Imports

Power BI 匯入集合的 OData 回應包裝函式

名稱 類型 Description
odata.context

string

OData 內容
value

Import[]

匯入集合

PrincipalType

主體類型

名稱 類型 Description
App

string

服務主體類型
Group

string

群組主體類型
None

string

沒有主體類型。 用於整個組織層級存取。
User

string

用戶主體類型

Report

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

名稱 類型 Description
appId

string

只有在報表屬於應用程式時，才會傳回應用程式標識碼
datasetId

string

報表的數據集標識碼
description

string

報表描述
embedUrl

string

報表的內嵌 URL
id

string

報表標識碼
isOwnedByMe

boolean

判斷報表是否由目前使用者建立。
name

string

報表的名稱
originalReportId

string

當工作區發佈為應用程式時的實際報表標識碼。
reportType enum:
  • PaginatedReport
  • PowerBIReport

報表類型
subscriptions

Subscription[]

(空白值) Power BI 專案的訂用帳戶詳細數據， (例如報表或儀錶板) 。 這個屬性將會從即將推出的承載回應中移除。 您可以使用取得報表訂閱作為 API 呼叫 管理員，來擷取 Power BI 報表的訂閱資訊。
users

ReportUser[]

(空白值) Power BI 報表的使用者存取詳細數據。 這個屬性將會從即將推出的承載回應中移除。 您可以使用取得報表用戶作為 管理員 API 呼叫，或使用 參數來擷取 Power BI 報表上的使用者資訊，或使用 參數來擷getArtifactUsers取 PostWorkspaceInfo API 呼叫。
webUrl

string

報表的Web URL

ReportUser

報表的 Power BI 使用者存取權專案

名稱 類型 Description
displayName

string

主體的顯示名稱
emailAddress

string

使用者的電子郵件地址
graphId

string

Microsoft Graph 中主體的標識碼。 僅適用於系統管理員 API。
identifier

string

主體的標識碼
principalType

PrincipalType

主體類型
profile

ServicePrincipalProfile

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

ReportUserAccessRight

用戶對於報表的存取權， (許可權等級)

userType

string

使用者的類型。

ReportUserAccessRight

用戶對於報表的存取權， (許可權等級)

名稱 類型 Description
None

string

報表中的內容沒有許可權
Owner

string

授與報表中內容的讀取、寫入和重新共用存取權
Read

string

授與報表中內容的讀取許可權
ReadCopy

string

授與報表中內容的讀取和複製存取權
ReadReshare

string

授與報表中內容的讀取和重新共用存取權
ReadWrite

string

授與報表中內容的讀取和寫入存取權

ServicePrincipalProfile

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

名稱 類型 Description
displayName

string

服務主體配置檔名稱
id

string

服務主體配置檔識別碼

Subscription

Power BI 專案的電子郵件訂閱 (，例如報表或儀錶板)

名稱 類型 Description
artifactDisplayName

string

訂閱 Power BI 專案的名稱 (，例如報表或儀錶板)

artifactId

string

訂閱 Power BI 專案的標識碼 (，例如報表或儀錶板)

artifactType

string

Power BI 專案的類型 (例如 Report、 Dashboard或 Dataset)

attachmentFormat

string

電子郵件訂閱中附加報表的格式
endDate

string

電子郵件訂閱的結束日期和時間
frequency

string

電子郵件訂閱的頻率
id

string

訂用帳戶標識碼
isEnabled

boolean

是否啟用電子郵件訂閱
linkToContent

boolean

電子郵件訂閱中是否有訂用帳戶連結
previewImage

boolean

報表的螢幕快照是否存在於電子郵件訂閱中
startDate

string

電子郵件訂閱的開始日期和時間
subArtifactDisplayName

string

如果訂閱的Power BI專案是報表，則為頁面名稱。
title

string

應用程式名稱
users

SubscriptionUser[]

每個電子郵件訂閱者的詳細數據。 使用取得使用者訂用帳戶作為 api 呼叫 管理員 時，傳回的值是空陣列， (null) 。 這個屬性將會從即將推出的承載回應中移除。 您可以使用取得報表訂閱作為 管理員 或取得儀錶板訂閱作為 管理員 API 呼叫，來擷取 Power BI 報表或儀錶板上的訂閱資訊。

SubscriptionUser

Power BI 電子郵件訂閱使用者

名稱 類型 Description
displayName

string

主體的顯示名稱
emailAddress

string

使用者的電子郵件地址
graphId

string

Microsoft Graph 中主體的標識碼。 僅適用於系統管理員 API。
identifier

string

主體的標識碼
principalType

PrincipalType

主體類型
profile

ServicePrincipalProfile

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

string

使用者的類型。