Datasets - Bind To Gateway In Group

  • Référence
Service:
Power BI REST APIs
API Version:
v1.0

Lie le jeu de données spécifié de l’espace de travail spécifié à la passerelle spécifiée, éventuellement avec un ensemble donné d’ID de source de données. Si vous ne fournissez pas d’ID de source de données spécifique, le jeu de données sera lié à la première source de données correspondante dans la passerelle.

Important

Ajoutez le principal de l’appelant d’API en tant qu’utilisateur de source de données sur la passerelle.

Autorisations

Cet appel d’API peut être appelé par un profil de principal de service. Pour plus d’informations, consultez : Profils de principal de service dans Power BI Embedded.

Étendue requise

Dataset.ReadWrite.All

Limites

Prend uniquement en charge la passerelle de données locale

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

Paramètres URI

Nom Dans Obligatoire Type Description
datasetId
 path True

string

ID du jeu de données
groupId
 path True

string

uuid

L’ID de l’espace de travail

Corps de la demande

Nom Obligatoire Type Description
gatewayObjectId True

string

ID de passerelle. Lors de l’utilisation d’un cluster de passerelle, l’ID de passerelle fait référence à la passerelle primaire (première) du cluster et est similaire à l’ID de cluster de passerelle.
datasourceObjectIds

string[]

Identificateurs uniques pour les sources de données dans la passerelle

Réponses

Nom Type Description
200 OK

Ok

Exemples

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

Définitions

BindToGatewayRequest

Jeu de données de liaison à la demande de passerelle

Nom Type Description
datasourceObjectIds

string[]

Identificateurs uniques pour les sources de données dans la passerelle
gatewayObjectId

string

ID de passerelle. Lors de l’utilisation d’un cluster de passerelle, l’ID de passerelle fait référence à la passerelle primaire (première) du cluster et est similaire à l’ID de cluster de passerelle.