Datasets - Update Datasources

Service:

Power BI REST APIs

API Version:

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 参数

名称	在	必需	类型	说明
datasetId	path	True	string	数据集 ID

请求正文

名称	必需	类型	说明
updateDetails	True	UpdateDatasourceConnectionRequest[]	数据源连接更新请求的数组

响应

名称	类型	说明
200 OK		确定

示例

Example

Sample Request

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

Request Body

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

Sample Response

Status code:

200

定义

名称	说明
Datasource	Power BI 数据源
DatasourceConnectionDetails	Power BI 数据源连接详细信息。 请参阅 获取数据源 或 获取组中的数据源中的示例。
UpdateDatasourceConnectionRequest	Power BI 数据集数据源连接更新请求
UpdateDatasourcesRequest	Power BI 数据集数据源更新请求

Datasource

Power BI 数据源

名称	类型	说明
connectionDetails	DatasourceConnectionDetails	数据源连接详细信息
connectionString	string	(已弃用) 数据源连接字符串。 仅适用于 DirectQuery。
datasourceId	string	绑定的数据源 ID，未绑定到网关时为空
datasourceType	string	数据源类型
gatewayId	string	绑定网关 ID，未绑定到网关时为空。 使用网关群集时，网关 ID 是指群集中第一个) 网关的主 (，类似于网关群集 ID。
name	string	(已弃用) 数据源名称。 仅适用于 DirectQuery。

DatasourceConnectionDetails

Power BI 数据源连接详细信息。 请参阅 获取数据源 或 获取组中的数据源中的示例。

名称	类型	说明
account	string	连接帐户
classInfo	string	连接类信息
database	string	连接数据库
domain	string	连接域
emailAddress	string	连接电子邮件地址
kind	string	连接类型
loginServer	string	连接登录服务器
path	string	连接路径
server	string	连接服务器
url	string	连接 URL

UpdateDatasourceConnectionRequest

Power BI 数据集数据源连接更新请求

名称	类型	说明
connectionDetails	DatasourceConnectionDetails	更新的数据源的目标连接详细信息
datasourceSelector	Datasource	需要更新的数据源的连接详细信息。 当数据集具有多个数据源时，这是必需的。

UpdateDatasourcesRequest

Power BI 数据集数据源更新请求

名称	类型	说明
updateDetails	UpdateDatasourceConnectionRequest[]	数据源连接更新请求的数组