Datasets - Set All Dataset Connections In Group

Reference

Service:: Power BI REST APIs

API Version:: v1.0

Updates all connections for the specified dataset from the specified workspace. This API call only supports SQL DirectQuery datasets.

Important

This API call is deprecated and no longer supported. This API call isn't compatible with enhanced dataset metadata.

Instead use:

Update Parameters In Group to update connections for SQL, Azure Synapse, OData, and SharePoint data sources.
Update Datasources In Group to connections for other data sources.

Required Scope

Dataset.ReadWrite.All

Limitations

Supports SQL DirectQuery datasets.

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

URI Parameters

Name	In	Required	Type	Description
datasetId	path	True	string	The dataset ID
groupId	path	True	string uuid	The workspace ID

Request Body

Name	Required	Type	Description
connectionString	True	string	A dataset connection string

Responses

Name	Type	Description
200 OK		OK

Examples

Example

Sample request

POST https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/Default.SetAllConnections

Request Body

{
  "connectionString": "data source=MyServer.database.windows.net;initial catalog=MyDatabase;persist security info=True;encrypt=True;trustservercertificate=False"
}

Sample response

Status code:: 200

Definitions

ConnectionDetails

A connection string wrapper

Name	Type	Description
connectionString	string	A dataset connection string

Share via