Datasets - Trigger Query Scale Out Sync

Service:

Power BI REST APIs

API Version:

v1.0

Triggers a query scale-out sync of read-only replicas for the specified dataset from My workspace.

Required Scope

Dataset.ReadWrite.All

POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/queryScaleOut/sync

URI Parameters

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

Responses

Name	Type	Description
200 OK	DatasetQueryScaleOutSyncStatus	OK

Examples

Trigger query scale-out sync example

Sample Request

POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/queryScaleOut/sync

Sample Response

Status code:

200

{
  "commitVersion": 133186221251720662,
  "commitTimestamp": "2023-01-19T17:15:25.1720662Z",
  "targetSyncVersion": 133184583205771509,
  "targetSyncTimestamp": "2023-01-17T19:45:20.5771509Z",
  "triggerReason": "explicit",
  "syncStartTime": "2023-01-17T20:37:49.9625479Z",
  "syncEndTime": "2023-01-17T20:37:50.6029293Z",
  "minActiveReadVersion": 133184583205771509,
  "minActiveReadTimestamp": "2023-01-17T19:45:20.5771509Z",
  "scaleOutStatus": "Enabled"
}

Definitions

Name	Description
DatasetQueryScaleOutSyncStatus	Dataset query scale-out sync status
QueryScaleOutStatus	Query scale-out status
QueryScaleOutSyncTriggerReason	Query scale-out sync trigger reason

DatasetQueryScaleOutSyncStatus

Dataset query scale-out sync status

Name	Type	Description
commitTimestamp	string	Timestamp indicating the latest commit version
commitVersion	integer	Latest commit version
minActiveReadTimestamp	string	Timestamp indicating the minimum active read version
minActiveReadVersion	integer	Minimum active read version
scaleOutStatus	QueryScaleOutStatus	Query scale-out status
syncEndTime	string	Timestamp indicating when last sync ended
syncStartTime	string	Timestamp indicating when last sync started
targetSyncTimestamp	string	Timestamp indicating the target sync version
targetSyncVersion	integer	Target sync version
triggerReason	QueryScaleOutSyncTriggerReason	Query scale-out sync trigger reason

QueryScaleOutStatus

Query scale-out status

Name	Type	Description
Enabled	string	Query scale-out is enabled
ReadOnlyReplicasDisabled	string	Query scale-out max read-only replicas is set to 0
StorageModeNotSupported	string	Query scale-out is not supported for dataset's storage mode
TenantSettingDisabled	string	Query scale-out tenant setting is disabled

QueryScaleOutSyncTriggerReason

Query scale-out sync trigger reason

Name	Type	Description
automatic	string	Sync was automatically triggered
explicit	string	Sync was explicitly triggered
system	string	Sync was triggered following a system event