Datasets - Bind To Gateway In Group

  • リファレンス
Service:
Power BI REST APIs
API Version:
v1.0

指定したデータセットを、指定したワークスペースから指定したゲートウェイにバインドします。必要に応じて、指定したデータ ソース ID のセットを使用します。 特定のデータ ソース ID を指定しない場合、データセットはゲートウェイ内の最初に一致するデータ ソースにバインドされます。

重要

API 呼び出し元プリンシパルをゲートウェイのデータ ソース ユーザーとして追加します。

アクセス許可

この API 呼び出しは、サービス プリンシパル プロファイルによって呼び出すことができます。 詳細については、「Power BI Embeddedのサービス プリンシパル プロファイル」を参照してください。

必要なスコープ

Dataset.ReadWrite.All

制限事項

オンプレミス データ ゲートウェイのみをサポートします

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

URI パラメーター

名前 / 必須 型 説明
datasetId
 path True

string

データセット ID
groupId
 path True

string

uuid

ワークスペース ID

要求本文

名前 必須 型 説明
gatewayObjectId True

string

ゲートウェイ ID。 ゲートウェイ クラスターを使用する場合、ゲートウェイ ID はクラスター内のプライマリ (最初の) ゲートウェイを参照し、ゲートウェイ クラスター ID と似ています。
datasourceObjectIds

string[]

ゲートウェイ内のデータ ソースの一意の識別子

応答

名前 型 説明
200 OK

OK

例

Example with 'datasourceObjectIds'
Example without 'datasourceObjectIds'

Example with 'datasourceObjectIds'

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.BindToGateway
Request Body
{
  "gatewayObjectId": "1f69e798-5852-4fdd-ab01-33bb14b6e934",
  "datasourceObjectIds": [
    "dc2f2dac-e5e2-4c37-af76-2a0bc10f16cb",
    "3bfe5d33-ab7d-4d24-b0b5-e2bb8eb01cf5"
  ]
}

Sample Response

Status code:
200

Example without 'datasourceObjectIds'

Sample Request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.BindToGateway
Request Body
{
  "gatewayObjectId": "1f69e798-5852-4fdd-ab01-33bb14b6e934"
}

Sample Response

Status code:
200

定義

BindToGatewayRequest

ゲートウェイ要求へのバインド データセット

名前 型 説明
datasourceObjectIds

string[]

ゲートウェイ内のデータ ソースの一意の識別子
gatewayObjectId

string

ゲートウェイ ID。 ゲートウェイ クラスターを使用する場合、ゲートウェイ ID はクラスター内のプライマリ (最初の) ゲートウェイを参照し、ゲートウェイ クラスター ID と似ています。