Share Subscriptions - List Synchronizations

Référence

Service:: Data Share

API Version:: 2021-08-01

Répertorier les synchronisations dans un abonnement de partage.
Répertorier les synchronisations d’un abonnement de partage

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}

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte de partage.
resourceGroupName	path	True	string	Nom du groupe de ressources.
shareSubscriptionName	path	True	string	Nom de l’abonnement de partage.
subscriptionId	path	True	string	Identificateur de l’abonnement
api-version	query	True	string	Version de l’API à utiliser.
$filter	query		string	Filtre les résultats à l’aide de la syntaxe OData.
$orderby	query		string	Trie les résultats à l’aide de la syntaxe OData.
$skipToken	query		string	jeton de liaison

Réponses

Nom	Type	Description
200 OK	ShareSubscriptionSynchronizationList	Succès
Other Status Codes	DataShareError	Réponse d’erreur reçue du fournisseur de ressources Microsoft.DataShare.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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"
    }
  ]
}

Définitions

Nom	Description
DataShareError	Modèle d’erreur de partage de données.
DataShareErrorInfo	Modèle de corps d’erreur de partage de données.
ShareSubscriptionSynchronization	Objet de transfert de données ShareSubscriptionSynchronization.
ShareSubscriptionSynchronizationList	Liste côté consommateur des synchronisations d’abonnement de partage
synchronizationMode	Mode de synchronisation

DataShareError

Modèle d’erreur de partage de données.

Nom	Type	Description
error	DataShareErrorInfo	Corps d’erreur du partage de données

DataShareErrorInfo

Modèle de corps d’erreur de partage de données.

Nom	Type	Description
code	string	Code de l’erreur
details	DataShareErrorInfo[]	Détails imbriqués du modèle d’erreur
message	string	Message de l’erreur
target	string	Cible de l’erreur

ShareSubscriptionSynchronization

Objet de transfert de données ShareSubscriptionSynchronization.

Nom	Type	Description
durationMs	integer	Durée de synchronisation
endTime	string	Heure de fin de la synchronisation
message	string	message de synchronisation
startTime	string	heure de début de la synchronisation
status	string	État brut
synchronizationId	string	ID de synchronisation
synchronizationMode	synchronizationMode	Mode de synchronisation

ShareSubscriptionSynchronizationList

Liste côté consommateur des synchronisations d’abonnement de partage

Nom	Type	Description
nextLink	string	Url de la page de résultats suivante.
value	ShareSubscriptionSynchronization[]	Collection d’éléments de type DataTransferObjects.

synchronizationMode

Mode de synchronisation

Nom	Type	Description
FullSync	string
Incremental	string