Share Subscriptions - List Synchronization Details

Service:

Data Share

API Version:

2021-08-01

列出共用訂閱同步處理的數據集層級詳細數據
列出同步處理詳細數據

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

With optional parameters:

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

URI 參數

名稱	位於	必要	類型	Description
accountName	path	True	string	共用帳戶的名稱。
resourceGroupName	path	True	string	資源群組名稱。
shareSubscriptionName	path	True	string	共用訂閱的名稱。
subscriptionId	path	True	string	訂用帳戶標識碼
api-version	query	True	string	要使用的 API 版本。
$filter	query		string	使用 OData 語法篩選結果。
$orderby	query		string	使用 OData 語法排序結果。
$skipToken	query		string	Continuation token (接續 Token)

要求本文

名稱	必要	類型	Description
synchronizationId	True	string	同步處理標識碼

回應

名稱	類型	Description
200 OK	SynchronizationDetailsList	Success
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

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ShareSubscriptions_ListSynchronizationDetails

Sample Request

HTTP

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

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

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/ShareSubscriptions_ListSynchronizationDetails.json
// this example is just showing the usage of "ShareSubscriptions_ListSynchronizationDetails" 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 = "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a";
string resourceGroupName = "SampleResourceGroup";
string accountName = "Account1";
string shareSubscriptionName = "ShareSub1";
ResourceIdentifier shareSubscriptionResourceId = ShareSubscriptionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, shareSubscriptionName);
ShareSubscriptionResource shareSubscription = client.GetShareSubscriptionResource(shareSubscriptionResourceId);

// invoke the operation and iterate over the result
ShareSubscriptionSynchronization shareSubscriptionSynchronization = new ShareSubscriptionSynchronization(Guid.Parse("7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"));
await foreach (SynchronizationDetails item in shareSubscription.GetSynchronizationDetailsAsync(shareSubscriptionSynchronization))
{
    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",
      "name": "datasetmapping1",
      "dataSetId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb",
      "dataSetType": "Blob"
    }
  ]
}

定義

名稱	Description
dataSetType	數據集的類型
DataShareError	數據共用錯誤模型。
DataShareErrorInfo	數據共用錯誤主體模型。
ShareSubscriptionSynchronization	ShareSubscriptionSynchronization 數據傳輸物件。
SynchronizationDetails	數據集層級的同步處理詳細數據
SynchronizationDetailsList	同步處理的詳細數據
synchronizationMode	同步模式

dataSetType

數據集的類型

名稱	類型	Description
AdlsGen1File	string
AdlsGen1Folder	string
AdlsGen2File	string
AdlsGen2FileSystem	string
AdlsGen2Folder	string
Blob	string
BlobFolder	string
Container	string
KustoCluster	string
KustoDatabase	string
KustoTable	string
SqlDBTable	string
SqlDWTable	string
SynapseWorkspaceSqlPoolTable	string

DataShareError

數據共用錯誤模型。

名稱	類型	Description
error	DataShareErrorInfo	數據共用錯誤本文

DataShareErrorInfo

數據共用錯誤主體模型。

名稱	類型	Description
code	string	錯誤的程序代碼
details	DataShareErrorInfo[]	錯誤模型的巢狀詳細數據
message	string	錯誤的訊息
target	string	錯誤的目標

ShareSubscriptionSynchronization

ShareSubscriptionSynchronization 數據傳輸物件。

名稱	類型	Description
durationMs	integer	同步處理持續時間
endTime	string	同步處理的結束時間
message	string	同步處理的訊息
startTime	string	同步處理的開始時間
status	string	原始狀態
synchronizationId	string	同步處理標識碼
synchronizationMode	synchronizationMode	同步處理模式

SynchronizationDetails

數據集層級的同步處理詳細數據

名稱	類型	Description
dataSetId	string	數據集的識別碼
dataSetType	dataSetType	數據集的類型
durationMs	integer	數據集層級複製的持續時間
endTime	string	數據集層級複製的結束時間
filesRead	integer	從源數據集讀取的檔案數目
filesWritten	integer	寫入接收數據集的檔案數目
message	string	如果有錯誤訊息
name	string	數據集的名稱
rowsCopied	integer	複製到接收數據集的檔案數目
rowsRead	integer	從源數據集讀取的數據列數目。
sizeRead	integer	以位元組為單位從源數據集讀取的數據大小
sizeWritten	integer	寫入接收數據集的數據大小，以位元組為單位
startTime	string	數據集層級複製的開始時間
status	string	原始狀態
vCore	integer	用於數據集同步處理的虛擬核心單位

SynchronizationDetailsList

同步處理的詳細數據

名稱	類型	Description
nextLink	string	下一個結果頁面的 URL。
value	SynchronizationDetails[]	DataTransferObjects 類型的專案集合。

synchronizationMode

同步模式

名稱	類型	Description
FullSync	string
Incremental	string