Synchronization Settings - List By Share
List synchronizationSettings in a share
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings?api-version=2021-08-01&$skipToken={$skipToken}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
The name of the share account. |
resource
|
path | True |
string |
The resource group name. |
share
|
path | True |
string |
The name of the share. |
subscription
|
path | True |
string |
The subscription identifier |
api-version
|
query | True |
string |
The api version to use. |
$skip
|
query |
string |
continuation token |
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
SynchronizationSettings_ListByShare
Sample Request
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": [
{
"kind": "ScheduleBased",
"properties": {
"synchronizationTime": "2018-11-14T04:47:52.9614956Z",
"recurrenceInterval": "Day",
"userName": "John Smith"
},
"id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/synchronizationSettings/SynchronizationSetting1",
"name": "SynchronizationSetting1",
"type": "Microsoft.DataShare/accounts/shares/synchronizationSettings"
}
]
}
Definitions
Name | Description |
---|---|
created |
The type of identity that created the resource. |
Data |
The data share error model. |
Data |
The data share error body model. |
last |
The type of identity that last modified the resource. |
provisioning |
Provisioning state of the Account |
recurrence |
Recurrence Interval |
Scheduled |
A type of synchronization setting based on schedule |
Synchronization |
List response for get Synchronization settings |
System |
Metadata pertaining to creation and last modification of the resource. |
createdByType
The type of identity that created the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
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 |
lastModifiedByType
The type of identity that last modified the resource.
Name | Type | Description |
---|---|---|
Application |
string |
|
Key |
string |
|
ManagedIdentity |
string |
|
User |
string |
provisioningState
Provisioning state of the Account
Name | Type | Description |
---|---|---|
Creating |
string |
|
Deleting |
string |
|
Failed |
string |
|
Moving |
string |
|
Succeeded |
string |
recurrenceInterval
Recurrence Interval
Name | Type | Description |
---|---|---|
Day |
string |
|
Hour |
string |
ScheduledSynchronizationSetting
A type of synchronization setting based on schedule
Name | Type | Description |
---|---|---|
id |
string |
The resource id of the azure resource |
kind |
string:
Schedule |
Kind of synchronization setting. |
name |
string |
Name of the azure resource |
properties.createdAt |
string |
Time at which the synchronization setting was created. |
properties.provisioningState |
Gets or sets the provisioning state |
|
properties.recurrenceInterval |
Recurrence Interval |
|
properties.synchronizationTime |
string |
Synchronization time |
properties.userName |
string |
Name of the user who created the synchronization setting. |
systemData |
System Data of the Azure resource. |
|
type |
string |
Type of the azure resource |
SynchronizationSettingList
List response for get Synchronization settings
Name | Type | Description |
---|---|---|
nextLink |
string |
The Url of next result page. |
value | SynchronizationSetting[]: |
Collection of items of type DataTransferObjects. |
SystemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt |
string |
The timestamp of resource creation (UTC). |
createdBy |
string |
The identity that created the resource. |
createdByType |
The type of identity that created the resource. |
|
lastModifiedAt |
string |
The type of identity that last modified the resource. |
lastModifiedBy |
string |
The identity that last modified the resource. |
lastModifiedByType |
The type of identity that last modified the resource. |