你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Share Subscriptions - Cancel Synchronization

参考

Service:: Data Share

API Version:: 2021-08-01

请求取消数据共享快照
请求取消同步。

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	共享帐户的名称。
resourceGroupName	path	True	string	资源组名称。
shareSubscriptionName	path	True	string	shareSubscription 的名称。
subscriptionId	path	True	string	订阅标识符
api-version	query	True	string	要使用的 API 版本。

请求正文

名称	必需	类型	说明
synchronizationId	True	string	同步 ID

响应

名称	类型	说明
200 OK	ShareSubscriptionSynchronization	成功
202 Accepted	ShareSubscriptionSynchronization	已接受
Other Status Codes	DataShareError	从 Microsoft.DataShare 资源提供程序收到的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

ShareSubscriptions_CancelSynchronization

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

{
  "synchronizationId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"
}

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_CancelSynchronization.json
// this example is just showing the usage of "ShareSubscriptions_CancelSynchronization" 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
ShareSubscriptionSynchronization shareSubscriptionSynchronization = new ShareSubscriptionSynchronization(Guid.Parse("7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"));
ArmOperation<ShareSubscriptionSynchronization> lro = await shareSubscription.CancelSynchronizationAsync(WaitUntil.Completed, shareSubscriptionSynchronization);
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": "Cancelled",
  "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": "Queued",
  "synchronizationId": "343c4772-ad68-41aa-91b9-bab1c92f9c27"
}

定义

名称	说明
DataShareError	数据共享错误模型。
DataShareErrorInfo	数据共享错误主体模型。
ShareSubscriptionSynchronization	ShareSubscriptionSynchronization 数据传输对象。
synchronizationMode	同步模式

DataShareError

数据共享错误模型。

名称	类型	说明
error	DataShareErrorInfo	数据共享错误正文

DataShareErrorInfo

数据共享错误主体模型。

名称	类型	说明
code	string	错误代码
details	DataShareErrorInfo[]	错误模型的嵌套详细信息
message	string	错误消息
target	string	错误的目标

ShareSubscriptionSynchronization

ShareSubscriptionSynchronization 数据传输对象。

名称	类型	说明
durationMs	integer	同步持续时间
endTime	string	同步的结束时间
message	string	同步消息
startTime	string	同步的开始时间
status	string	原始状态
synchronizationId	string	同步 ID
synchronizationMode	synchronizationMode	同步模式

synchronizationMode

同步模式

名称	类型	说明
FullSync	string
Incremental	string