Synchronization Settings - Create

Reference

Service:: Data Share

API Version:: 2021-08-01

Adds a new synchronization setting to an existing share.
Create a synchronizationSetting

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/synchronizationSettings/{synchronizationSettingName}?api-version=2021-08-01

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.
shareName	path	True	string	The name of the share to add the synchronization setting to.
subscriptionId	path	True	string	The subscription identifier
synchronizationSettingName	path	True	string	The name of the synchronizationSetting.
api-version	query	True	string	The api version to use.

Request Body

ScheduledSynchronizationSetting

A type of synchronization setting based on schedule

Name	Required	Type	Description
kind	True	string: ScheduleBased	Kind of synchronization setting.
properties.recurrenceInterval	True	recurrenceInterval	Recurrence Interval
properties.synchronizationTime	True	string	Synchronization time

Responses

Name	Type	Description
200 OK	SynchronizationSetting: ScheduledSynchronizationSetting	Success
201 Created	SynchronizationSetting: ScheduledSynchronizationSetting	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

SynchronizationSettings_Create

PUT https://management.azure.com/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/synchronizationSettings/Dataset1?api-version=2021-08-01

{
  "kind": "ScheduleBased",
  "properties": {
    "synchronizationTime": "2018-11-14T04:47:52.9614956Z",
    "recurrenceInterval": "Day"
  }
}

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataShare;
using Azure.ResourceManager.DataShare.Models;

// Generated from example definition: specification/datashare/resource-manager/Microsoft.DataShare/stable/2021-08-01/examples/SynchronizationSettings_Create.json
// this example is just showing the usage of "SynchronizationSettings_Create" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataShareSynchronizationSettingResource created on azure
// for more information of creating DataShareSynchronizationSettingResource, please refer to the document of DataShareSynchronizationSettingResource
string subscriptionId = "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a";
string resourceGroupName = "SampleResourceGroup";
string accountName = "Account1";
string shareName = "Share1";
string synchronizationSettingName = "Dataset1";
ResourceIdentifier dataShareSynchronizationSettingResourceId = DataShareSynchronizationSettingResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, shareName, synchronizationSettingName);
DataShareSynchronizationSettingResource dataShareSynchronizationSetting = client.GetDataShareSynchronizationSettingResource(dataShareSynchronizationSettingResourceId);

// invoke the operation
DataShareSynchronizationSettingData data = new ScheduledSynchronizationSetting(DataShareSynchronizationRecurrenceInterval.Day, DateTimeOffset.Parse("2018-11-14T04:47:52.9614956Z"));
ArmOperation<DataShareSynchronizationSettingResource> lro = await dataShareSynchronizationSetting.UpdateAsync(WaitUntil.Completed, data);
DataShareSynchronizationSettingResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataShareSynchronizationSettingData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 200

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd

Response Body

{
  "kind": "ScheduleBased",
  "properties": {
    "synchronizationTime": "2018-11-14T04:47:52.9614956Z",
    "recurrenceInterval": "Day",
    "provisioningState": "Succeeded",
    "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"
}

Status code:: 201

Date: Wed, 13 Sep 2017 18:04:32 GMT
x-ms-request-id: d5496da4-9c52-402f-b067-83cc9ddea888
X-Content-Type-Options: nosniff
x-ms-ratelimit-remaining-tenant-reads: 14999
x-ms-correlation-request-id: 25c78f97-0b0a-4fe9-ad39-883a482265cd
x-ms-long-running-operation: True

Response Body

{
  "kind": "ScheduleBased",
  "properties": {
    "synchronizationTime": "2018-11-14T04:47:52.9614956Z",
    "recurrenceInterval": "Day",
    "provisioningState": "Succeeded",
    "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
createdByType	The type of identity that created the resource.
DataShareError	The data share error model.
DataShareErrorInfo	The data share error body model.
lastModifiedByType	The type of identity that last modified the resource.
provisioningState	Provisioning state of the Account
recurrenceInterval	Recurrence Interval
ScheduledSynchronizationSetting	A type of synchronization setting based on schedule
SystemData	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	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

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: ScheduleBased	Kind of synchronization setting.
name	string	Name of the azure resource
properties.createdAt	string	Time at which the synchronization setting was created.
properties.provisioningState	provisioningState	Gets or sets the provisioning state
properties.recurrenceInterval	recurrenceInterval	Recurrence Interval
properties.synchronizationTime	string	Synchronization time
properties.userName	string	Name of the user who created the synchronization setting.
systemData	SystemData	System Data of the Azure resource.
type	string	Type of the azure resource

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	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	lastModifiedByType	The type of identity that last modified the resource.

Synchronization Settings - Create

URI Parameters

Request Body

ScheduledSynchronizationSetting

Responses

Security

azure_auth

Scopes

Examples

SynchronizationSettings_Create

Sample Request

Sample Response

Definitions

createdByType

DataShareError

DataShareErrorInfo

lastModifiedByType

provisioningState

recurrenceInterval

ScheduledSynchronizationSetting

SystemData

Additional resources