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	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	ユーザーアカウントの借用

例

Shares_ListSynchronizations

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

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

get ShareSynchronization の応答を一覧表示します。

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

synchronizationMode

同期化モード

名前	型	説明
FullSync	string
Incremental	string