Share Subscriptions - List Source Share Synchronization Settings

Get source share synchronization settings for a shareSubscription.
Get synchronization settings set on a share

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSourceShareSynchronizationSettings?api-version=2021-08-01
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSourceShareSynchronizationSettings?api-version=2021-08-01&$skipToken={$skipToken}

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 shareSubscription.

subscriptionId
path True

string

The subscription identifier

api-version
query True

string

The api version to use.

$skipToken
query

string

Continuation token

Responses

Name Type Description
200 OK

SourceShareSynchronizationSettingList

Success

Other Status Codes

DataShareError

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_ListSourceShareSynchronizationSettings

Sample request

POST https://management.azure.com/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSub1/listSourceShareSynchronizationSettings?api-version=2021-08-01

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": [
    {
      "properties": {
        "recurrenceInterval": "Hour",
        "synchronizationTime": "2019-03-15T19:45:58Z"
      },
      "kind": "ScheduleBased"
    }
  ]
}

Definitions

Name Description
DataShareError

The data share error model.

DataShareErrorInfo

The data share error body model.

recurrenceInterval

Recurrence Interval

ScheduledSourceSynchronizationSetting

A type of synchronization setting based on schedule

SourceShareSynchronizationSettingList

List response for get source share Synchronization settings

DataShareError

The data share error model.

Name Type Description
error

DataShareErrorInfo

The data share error body

DataShareErrorInfo

The data share error body model.

Name Type Description
code

string

Code of the error

details

DataShareErrorInfo[]

Nested details of the error model

message

string

Message of the error

target

string

Target of the error

recurrenceInterval

Recurrence Interval

Name Type Description
Day

string

Hour

string

ScheduledSourceSynchronizationSetting

A type of synchronization setting based on schedule

Name Type Description
kind string:

ScheduleBased

Kind of synchronization setting on share.

properties.recurrenceInterval

recurrenceInterval

Recurrence Interval

properties.synchronizationTime

string

Synchronization time

SourceShareSynchronizationSettingList

List response for get source share Synchronization settings

Name Type Description
nextLink

string

The Url of next result page.

value SourceShareSynchronizationSetting[]:

ScheduledSourceSynchronizationSetting[]

Collection of items of type DataTransferObjects.