Datasets - Update Datasources In Group

リファレンス

Service:: Power BI REST APIs

API Version:: v1.0

指定したワークスペースから、指定したデータセットのデータソースを更新します。

注意

この API 呼び出しでは、拡張データセットメタデータを使用することをお勧めします。

重要

元のデータソースと新しいデータソースは、まったく同じスキーマを持っている必要があります。
拡張データセットメタデータを使用している場合は、データセットを更新して新しいデータソースからデータを取得します。
拡張データセットメタデータを使用していない場合は、データソースの更新操作が完了するまで 30 分待ってから、データセットを更新します。

アクセス許可

ユーザーはデータセット所有者である必要があります。
この API 呼び出しは、サービスプリンシパルプロファイルによって呼び出すことができます。詳細については、「Power BI Embeddedのサービスプリンシパルプロファイル」を参照してください。

必要なスコープ

Dataset.ReadWrite.All

制限事項

パブリック XMLA エンドポイントを使用して作成または変更されたデータセットはサポートされていません。これらのデータソースを変更するには、管理者は表形式オブジェクトモデルのAzure Analysis Services クライアントライブラリを使用する必要があります。
サポートされているデータソースは、SQL Server、Azure SQL Server、Azure Analysis Services、Azure Synapse、OData、SharePoint、Teradata、SAP HANA のみです。他のデータソースの場合は、グループ API のパラメーターの更新呼び出しを使用します。
データソースの種類の変更はサポートされていません。
接続文字列のパラメーターを含むデータソースはサポートされていません。
マージテーブルまたは結合テーブルの一部であるデータソースの更新は、拡張データセットメタデータを使用している場合にのみサポートされます。
複数のデータソースを参照する高度なクエリの場合、最初のデータソースのみが更新されます。この制限を克服するには、データソースをパラメーターとして定義し、 Update Parameters In Group API 呼び出しを使用します。
増分更新ポリシーを使用したデータセットは完全にはサポートされていません。この API の呼び出しは期待どおりに機能しない可能性があり、部分的なデータソースの更新の結果として、これを克服するために、この API を呼び出す前にデータセットの更新を実行してみてください。

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

URI パラメーター

名前	/	必須	型	説明
datasetId	path	True	string
groupId	path	True	string uuid	ワークスペース ID

要求本文

名前	必須	型	説明
updateDetails	True	UpdateDatasourceConnectionRequest[]	データソース接続更新要求の配列

応答

名前	型	説明
200 OK		OK

例

Example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/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[]	データソース接続更新要求の配列