Share Subscriptions - List Synchronizations

Ссылка

Service:: Data Share

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

With optional parameters:

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

Поток OAuth2 в Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ShareSubscriptions_ListSynchronizations

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

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

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",
      "synchronizationId": "runId",
      "synchronizationMode": "Incremental"
    }
  ]
}

Определения

Имя	Описание
DataShareError	Модель ошибок общего ресурса данных.
DataShareErrorInfo	Модель тела ошибки общего ресурса данных.
ShareSubscriptionSynchronization	Объект передачи данных ShareSubscriptionSynchronization.
ShareSubscriptionSynchronizationList	Список синхронизаций подписок на стороне потребителя
synchronizationMode	Режим синхронизации

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	Идентификатор синхронизации
synchronizationMode	synchronizationMode	Режим синхронизации

ShareSubscriptionSynchronizationList

Список синхронизаций подписок на стороне потребителя

Имя	Тип	Описание
nextLink	string	URL-адрес следующей страницы результатов.
value	ShareSubscriptionSynchronization[]	Коллекция элементов типа DataTransferObjects.

synchronizationMode

Режим синхронизации

Имя	Тип	Описание
FullSync	string
Incremental	string