Share Subscriptions - List Synchronization Details

List data set level details for a share subscription synchronization
List synchronization details

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizationDetails?api-version=2019-11-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizationDetails?api-version=2019-11-01&$skipToken={$skipToken}&$filter={$filter}&$orderby={$orderby}

URI Parameters

Name In Required Type Description
accountName
path True
  • string

The name of the share account.

resourceGroupName
path True
  • string

The resource group name.

shareSubscriptionName
path True
  • string

The name of the share subscription.

subscriptionId
path True
  • string

The subscription identifier

api-version
query True
  • string

The api version to use.

$filter
query
  • string

Filters the results using OData syntax.

$orderby
query
  • string

Sorts the results using OData syntax.

$skipToken
query
  • string

Continuation token

Request Body

Name Required Type Description
synchronizationId True
  • string

Synchronization id

Responses

Name Type Description
200 OK

Success

Other Status Codes

An error response received from the Microsoft.DataShare resource provider.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ShareSubscriptions_ListSynchronizationDetails

Sample Request

POST https://management.azure.com/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSub1/listSynchronizationDetails?api-version=2019-11-01
{
  "synchronizationId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"
}

Sample Response

Date: Wed, 13 Sep 2017 17:33:55 GMT
x-ms-request-id: 8e58266a-de42-40d5-b3c4-c6a7e159cfba
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-subscription-reads: 14993
x-ms-correlation-request-id: 5d862c55-4de9-4a46-969d-cf1ed3e235ed
{
  "value": [
    {
      "endTime": "2018-11-14T04:47:52.9614956Z",
      "startTime": "2018-11-14T04:47:52.9614956Z",
      "durationMs": 2000,
      "status": "Completed",
      "name": "datasetmapping1",
      "dataSetId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb",
      "dataSetType": "Blob"
    }
  ]
}

Definitions

dataSetType

Type of data set

DataShareError

The data share error model.

DataShareErrorInfo

The data share error body model.

ShareSubscriptionSynchronization

A ShareSubscriptionSynchronization data transfer object.

SynchronizationDetails

Synchronization details at data set level

SynchronizationDetailsList

details of synchronization

synchronizationMode

Synchronization mode

dataSetType

Type of data set

Name Type Description
AdlsGen1File
  • string
AdlsGen1Folder
  • string
AdlsGen2File
  • string
AdlsGen2FileSystem
  • string
AdlsGen2Folder
  • string
Blob
  • string
BlobFolder
  • string
Container
  • string
KustoCluster
  • string
KustoDatabase
  • string
SqlDBTable
  • string
SqlDWTable
  • string

DataShareError

The data share error model.

Name Type Description
error

The data share error body

DataShareErrorInfo

The data share error body model.

Name Type Description
code
  • string

Code of the error

details

Nested details of the error model

message
  • string

Message of the error

target
  • string

Target of the error

ShareSubscriptionSynchronization

A ShareSubscriptionSynchronization data transfer object.

Name Type Description
durationMs
  • integer

Synchronization duration

endTime
  • string

End time of synchronization

message
  • string

message of Synchronization

startTime
  • string

start time of synchronization

status
  • string

Raw Status

synchronizationId
  • string

Synchronization id

synchronizationMode

Synchronization Mode

SynchronizationDetails

Synchronization details at data set level

Name Type Description
dataSetId
  • string

Id of data set

dataSetType

Type of the data set

durationMs
  • integer

Duration of data set level copy

endTime
  • string

End time of data set level copy

filesRead
  • integer

The number of files read from the source data set

filesWritten
  • integer

The number of files written into the sink data set

message
  • string

Error message if any

name
  • string

Name of the data set

rowsCopied
  • integer

The number of files copied into the sink data set

rowsRead
  • integer

The number of rows read from the source data set.

sizeRead
  • integer

The size of the data read from the source data set in bytes

sizeWritten
  • integer

The size of the data written into the sink data set in bytes

startTime
  • string

Start time of data set level copy

status
  • string

Raw Status

vCore
  • integer

The vCore units consumed for the data set synchronization

SynchronizationDetailsList

details of synchronization

Name Type Description
nextLink
  • string

The Url of next result page.

value

Collection of items of type DataTransferObjects.

synchronizationMode

Synchronization mode

Name Type Description
FullSync
  • string
Incremental
  • string