Datasets - Update Datasources

服務:

Power BI REST APIs

API 版本:

v1.0

從 [我的工作區]更新指定數據集的數據源。

注意

建議您使用此 API 呼叫 增強數據集元數據。

重要

• 原始數據源和新數據源必須具有相同的架構。
• 如果您使用 增強數據集元數據，請重新整理資料集以從新的數據源取得數據。
• 如果您未使用 增強數據集元數據，請等候 30 分鐘，更新數據源作業完成，然後重新整理數據集。

權限

用戶必須是數據集擁有者。

局限性

• 不支援使用公用 XMLA 端點建立或修改的數據集。 若要變更這些數據源，系統管理員必須使用適用於表格式物件模型的 Azure Analysis Services 用戶端連結庫。
• 僅支持這些數據源：SQL Server、Azure SQL Server、Azure Analysis Services、Azure Synapse、OData、SharePoint、Teradata 和 SAP HANA。 對於其他數據源，請使用 更新參數 API 呼叫。
• 不支援變更數據源類型。
• 不支援在連接字串中包含參數的數據源。
• 只有在您使用 增強數據集元數據時，才支援更新合併或聯結數據表的數據源。
• 對於參考多個數據源的進階查詢，只會更新第一個數據源。 若要克服這項限制，請將數據源定義為參數，並使用 更新參數 API 呼叫。
• 不支援具有累加式重新整理原則的數據集，呼叫此 API 可能無法如預期般運作，而且部分數據源更新的結果，若要克服此情況，您可以先嘗試執行數據集重新整理，再呼叫此 API。

必要範圍

Dataset.ReadWrite.All

POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/Default.UpdateDatasources

URI 參數

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

要求本文

名稱	必要	類型	Description
updateDetails	True	UpdateDatasourceConnectionRequest[]	數據源聯機更新要求的陣列

回應

名稱	類型	Description
200 OK		還行

範例

Example

範例要求

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

要求本文

{
  "updateDetails": [
    {
      "datasourceSelector": {
        "datasourceType": "Sql",
        "connectionDetails": {
          "server": "My-Sql-Server",
          "database": "My-Sql-Database"
        }
      },
      "connectionDetails": {
        "server": "New-Sql-Server",
        "database": "New-Sql-Database"
      }
    },
    {
      "datasourceSelector": {
        "datasourceType": "OData",
        "connectionDetails": {
          "url": "http://services.odata.org/V4/Northwind/Northwind.svc"
        }
      },
      "connectionDetails": {
        "url": "http://services.odata.org/V4/Odata/Northwind.svc"
      }
    }
  ]
}

範例回覆

狀態碼:

200

定義

名稱	Description
Datasource	Power BI 數據源
DatasourceConnectionDetails	Power BI 數據源聯機詳細數據。 請參閱 取得數據源 或 在群組中取得數據源中的範例。
UpdateDatasourceConnectionRequest	Power BI 數據集數據源連線更新要求
UpdateDatasourcesRequest	Power BI 數據集數據源更新要求

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

UpdateDatasourceConnectionRequest

Object

Power BI 數據集數據源連線更新要求

名稱	類型	Description
connectionDetails	DatasourceConnectionDetails	已更新數據源的目標連線詳細數據
datasourceSelector	Datasource	需要更新之數據源的連接詳細數據。 當數據集有一個以上的數據源時，這是必要的。

UpdateDatasourcesRequest

Object

Power BI 數據集數據源更新要求

名稱	類型	Description
updateDetails	UpdateDatasourceConnectionRequest[]	數據源聯機更新要求的陣列