Share via

Datasets - Update Dataset In Group

Service:
Power BI REST APIs
API Version:
v1.0

Updates the properties for the specified dataset from the specified workspace.

Permissions

The user must be the dataset owner.

Required Scope

Dataset.ReadWrite.All 

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

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 Type Description
queryScaleOutSettings

DatasetQueryScaleOutSettings

Query scale-out settings of a dataset
targetStorageMode

string

The dataset storage mode

Responses

Name Type Description
200 OK

OK

Examples

Example of changing the dataset storage mode to support large datasets
Example of changing the dataset storage mode to support small datasets
Example of updating scale-out settings of a dataset

Example of changing the dataset storage mode to support large datasets

Sample request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229
Request Body
{
  "targetStorageMode": "PremiumFiles"
}

Sample response

Status code:
200

Example of changing the dataset storage mode to support small datasets

Sample request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229
Request Body
{
  "targetStorageMode": "Abf"
}

Sample response

Status code:
200

Example of updating scale-out settings of a dataset

Sample request

PATCH https://api.powerbi.com/v1.0/myorg/groups/f089354e-8366-4e18-aea3-4cb4a3a50b48/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229
Request Body
{
  "queryScaleOutSettings": {
    "autoSyncReadOnlyReplicas": false,
    "maxReadOnlyReplicas": -1
  }
}

Sample response

Status code:
200

Definitions

Name Description
DatasetQueryScaleOutSettings

Query scale-out settings of a dataset
UpdateDatasetRequest

Update dataset request

DatasetQueryScaleOutSettings

Object

Query scale-out settings of a dataset

Name Type Description
autoSyncReadOnlyReplicas

boolean

Whether the dataset automatically syncs read-only replicas
maxReadOnlyReplicas

integer

minimum: -1
maximum: 64

Maximum number of read-only replicas for the dataset (0-64, -1 for automatic number of replicas)

UpdateDatasetRequest

Object

Update dataset request

Name Type Description
queryScaleOutSettings

DatasetQueryScaleOutSettings

Query scale-out settings of a dataset
targetStorageMode

string

The dataset storage mode