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 パラメーター

名前	/	必須	型	説明
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	継続トークン

要求本文

名前	必須	型	説明
synchronizationId	True	string	同期 ID

応答

名前	型	説明
200 OK	SynchronizationDetailsList	Success
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_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"
    }
  ]
}

定義

名前	説明
dataSetType	データ セットの種類
DataShareError	データ共有エラー モデル。
DataShareErrorInfo	データ共有エラー本文モデル。
ShareSubscriptionSynchronization	ShareSubscriptionSynchronization データ転送オブジェクト。
SynchronizationDetails	データ セット レベルでの同期の詳細
SynchronizationDetailsList	同期の詳細
synchronizationMode	同期化モード

dataSetType

データ セットの種類

名前	型	説明
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

データ共有エラー モデル。

名前	型	説明
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	同期モード

SynchronizationDetails

データ セット レベルでの同期の詳細

名前	型	説明
dataSetId	string	データ セットの ID
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

同期の詳細

名前	型	説明
nextLink	string	次の結果ページの URL。
value	SynchronizationDetails[]	DataTransferObjects 型の項目のコレクション。

synchronizationMode

同期化モード

名前	型	説明
FullSync	string
Incremental	string