Share Subscriptions - Synchronize

Reference

Service:: Data Share

API Version:: 2021-08-01

Initiate an asynchronous data share job
Initiate a copy

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/synchronize?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.
shareSubscriptionName	path	True	string	The name of share subscription
subscriptionId	path	True	string	The subscription identifier
api-version	query	True	string	The api version to use.

Request Body

Name	Type	Description
synchronizationMode	synchronizationMode	Mode of synchronization used in triggers and snapshot sync. Incremental by default

Responses

Name	Type	Description
200 OK	ShareSubscriptionSynchronization	Success
202 Accepted	ShareSubscriptionSynchronization	Accepted
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_Synchronize

POST https://management.azure.com/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSubscription1/synchronize?api-version=2021-08-01

{
  "synchronizationMode": "Incremental"
}

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/ShareSubscriptions_Synchronize.json
// this example is just showing the usage of "ShareSubscriptions_Synchronize" 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 ShareSubscriptionResource created on azure
// for more information of creating ShareSubscriptionResource, please refer to the document of ShareSubscriptionResource
string subscriptionId = "12345678-1234-1234-12345678abc";
string resourceGroupName = "SampleResourceGroup";
string accountName = "Account1";
string shareSubscriptionName = "ShareSubscription1";
ResourceIdentifier shareSubscriptionResourceId = ShareSubscriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, shareSubscriptionName);
ShareSubscriptionResource shareSubscription = client.GetShareSubscriptionResource(shareSubscriptionResourceId);

// invoke the operation
DataShareSynchronizeContent content = new DataShareSynchronizeContent()
{
    SynchronizationMode = SynchronizationMode.Incremental,
};
ArmOperation<ShareSubscriptionSynchronization> lro = await shareSubscription.SynchronizeAsync(WaitUntil.Completed, content);
ShareSubscriptionSynchronization result = lro.Value;

Console.WriteLine($"Succeeded: {result}");

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

{
  "startTime": "2019-06-30T02:37:48.4979104Z",
  "status": "Succeeded",
  "synchronizationId": "343c4772-ad68-41aa-91b9-bab1c92f9c27"
}

Status code:: 202

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
Azure-AsyncOperation: https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/consumerAccount/shareSubscriptions/shareSub1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview

Response Body

{
  "startTime": "2019-06-30T02:37:48.4979104Z",
  "status": "Accepted",
  "synchronizationId": "343c4772-ad68-41aa-91b9-bab1c92f9c27"
}

Definitions

Name	Description
DataShareError	The data share error model.
DataShareErrorInfo	The data share error body model.
ShareSubscriptionSynchronization	A ShareSubscriptionSynchronization data transfer object.
synchronizationMode	Synchronization mode
Synchronize	Payload for the synchronizing the data.

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

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	synchronizationMode	Synchronization Mode

synchronizationMode

Synchronization mode

Name	Type	Description
FullSync	string
Incremental	string

Synchronize

Payload for the synchronizing the data.

Name	Type	Description
synchronizationMode	synchronizationMode	Mode of synchronization used in triggers and snapshot sync. Incremental by default