Share Subscriptions - List Synchronizations

サービス:

Data Share

API バージョン:

2021-08-01

共有サブスクリプションの同期を一覧表示します。
共有サブスクリプションの同期を一覧表示する

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

省略可能なパラメーターを含む:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizations?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	継続トークン

応答

名前	型	説明
200 OK	ShareSubscriptionSynchronizationList	成功
Other Status Codes	DataShareError	Microsoft.DataShare リソース プロバイダーから受信したエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

ShareSubscriptions_ListSynchronizations

要求のサンプル

HTTP

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DataShare.Models;
using Azure.ResourceManager.DataShare;

// Generated from example definition: specification/datashare/resource-manager/Microsoft.DataShare/stable/2021-08-01/examples/ShareSubscriptions_ListSynchronizations.json
// this example is just showing the usage of "ShareSubscriptions_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 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
await foreach (ShareSubscriptionSynchronization item in shareSubscription.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

応答のサンプル

状態コード:

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

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

定義

名前	説明
DataShareError	データ共有エラー モデル。
DataShareErrorInfo	データ共有エラー本文モデル。
ShareSubscriptionSynchronization	ShareSubscriptionSynchronization データ転送オブジェクト。
ShareSubscriptionSynchronizationList	共有サブスクリプション同期のコンシューマー側の一覧
synchronizationMode	同期モード

DataShareError

Object

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

名前	型	説明
error	DataShareErrorInfo	データ共有のエラー本文

DataShareErrorInfo

Object

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

名前	型	説明
code	string	エラーのコード
details	DataShareErrorInfo[]	エラー モデルの入れ子になった詳細
message	string	エラーのメッセージ
target	string	エラーのターゲット

ShareSubscriptionSynchronization

Object

ShareSubscriptionSynchronization データ転送オブジェクト。

名前	型	説明
durationMs	integer (int32)	同期期間
endTime	string (date-time)	同期の終了時刻
message	string	同期のメッセージ
startTime	string (date-time)	同期の開始時刻
status	string	生の状態
synchronizationId	string	同期 ID
synchronizationMode	synchronizationMode	同期モード

ShareSubscriptionSynchronizationList

Object

共有サブスクリプション同期のコンシューマー側の一覧

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

synchronizationMode

列挙

同期モード

値	説明
FullSync
Incremental