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

Shares - List Synchronizations

Service:

Data Share

API Version:

2021-08-01

列出共享中的同步
列出共享的同步

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

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizations?api-version=2021-08-01&$skipToken={$skipToken}&$filter={$filter}&$orderby={$orderby}

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	共享帐户的名称。
resourceGroupName	path	True	string	资源组名称。
shareName	path	True	string	共享的名称。
subscriptionId	path	True	string	订阅标识符
api-version	query	True	string	要使用的 API 版本。
$filter	query		string	使用 OData 语法筛选结果。
$orderby	query		string	使用 OData 语法对结果进行排序。
$skipToken	query		string	继续标记

响应

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

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

Shares_ListSynchronizations

Sample Request

HTTP

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

dotnet

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/Shares_ListSynchronizations.json
// this example is just showing the usage of "Shares_ListSynchronizations" 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 DataShareResource created on azure
// for more information of creating DataShareResource, please refer to the document of DataShareResource
string subscriptionId = "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a";
string resourceGroupName = "SampleResourceGroup";
string accountName = "Account1";
string shareName = "Share1";
ResourceIdentifier dataShareResourceId = DataShareResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, shareName);
DataShareResource dataShare = client.GetDataShareResource(dataShareResourceId);

// invoke the operation and iterate over the result
await foreach (ShareSynchronization item in dataShare.GetSynchronizationsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine($"Succeeded");

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

Response Body

{
  "value": [
    {
      "endTime": "2018-11-14T04:47:52.9614956Z",
      "startTime": "2018-11-14T04:47:52.9614956Z",
      "durationMs": 2000,
      "status": "Completed",
      "message": "nda",
      "consumerTenantName": "nda",
      "consumerName": "abc@yahoo.com",
      "synchronizationId": "runId",
      "synchronizationMode": "Incremental"
    }
  ]
}

定义

名称	说明
DataShareError	数据共享错误模型。
DataShareErrorInfo	数据共享错误主体模型。
ShareSynchronization	ShareSynchronization 数据传输对象。
ShareSynchronizationList	列出获取 ShareSynchronization 的响应。
synchronizationMode	同步模式

DataShareError

数据共享错误模型。

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

DataShareErrorInfo

数据共享错误主体模型。

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

ShareSynchronization

ShareSynchronization 数据传输对象。

名称	类型	说明
consumerEmail	string	创建同步的用户的Email
consumerName	string	创建同步的用户的名称
consumerTenantName	string	创建同步的使用者的租户名称
durationMs	integer	同步持续时间
endTime	string	同步的结束时间
message	string	同步消息
startTime	string	同步的开始时间
status	string	原始状态
synchronizationId	string	同步 ID
synchronizationMode	synchronizationMode	同步模式

ShareSynchronizationList

列出获取 ShareSynchronization 的响应。

名称	类型	说明
nextLink	string	下一个结果页的 URL。
value	ShareSynchronization[]	DataTransferObjects 类型的项的集合。

synchronizationMode

同步模式

名称	类型	说明
FullSync	string
Incremental	string