Share Subscriptions - List Source Share Synchronization Settings

Service:

Data Share

API Version:

2021-08-01

shareSubscription のソース共有同期設定を取得します。
共有に設定された同期設定を取得する

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	共有アカウントの名前。
resourceGroupName	path	True	string	リソース グループ名。
shareSubscriptionName	path	True	string	shareSubscription の名前。
subscriptionId	path	True	string	サブスクリプション識別子
api-version	query	True	string	使用する API バージョン。
$skipToken	query		string	継続トークン

応答

名前	型	説明
200 OK	SourceShareSynchronizationSettingList	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_ListSourceShareSynchronizationSettings

Sample Request

HTTP

POST https://management.azure.com/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shareSubscriptions/ShareSub1/listSourceShareSynchronizationSettings?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/ShareSubscriptions_ListSourceShareSynchronizationSettings.json
// this example is just showing the usage of "ShareSubscriptions_ListSourceShareSynchronizationSettings" 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 (SourceShareSynchronizationSetting item in shareSubscription.GetSourceShareSynchronizationSettingsAsync())
{
    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": [
    {
      "properties": {
        "recurrenceInterval": "Hour",
        "synchronizationTime": "2019-03-15T19:45:58Z"
      },
      "kind": "ScheduleBased"
    }
  ]
}

定義

名前	説明
DataShareError	データ共有エラー モデル。
DataShareErrorInfo	データ共有エラー本文モデル。
recurrenceInterval	繰り返し間隔
ScheduledSourceSynchronizationSetting	スケジュールに基づく同期設定の種類
SourceShareSynchronizationSettingList	ソース共有の同期設定を取得するための応答を一覧表示する

DataShareError

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

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

DataShareErrorInfo

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

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

recurrenceInterval

繰り返し間隔

名前	型	説明
Day	string
Hour	string

ScheduledSourceSynchronizationSetting

スケジュールに基づく同期設定の種類

名前	型	説明
kind	string: ScheduleBased	共有での同期設定の種類。
properties.recurrenceInterval	recurrenceInterval	繰り返し間隔
properties.synchronizationTime	string	同期時間

SourceShareSynchronizationSettingList

ソース共有の同期設定を取得するための応答を一覧表示する

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