Share Subscriptions - List Synchronization Details

Référence

Service:: Data Share

Version d'API:: 2021-08-01

Répertorier les détails du niveau du jeu de données pour une synchronisation d’abonnement de partage
Répertorier les détails de synchronisation

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

Avec des paramètres facultatifs:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shareSubscriptions/{shareSubscriptionName}/listSynchronizationDetails?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 d’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

Corps de la demande

Nom	Obligatoire	Type	Description
synchronizationId	True	string	ID de synchronisation

Réponses

Nom	Type	Description
200 OK	SynchronizationDetailsList	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
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

ShareSubscriptions_ListSynchronizationDetails

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

{
  "synchronizationId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"
}

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_ListSynchronizationDetails.json
// this example is just showing the usage of "ShareSubscriptions_ListSynchronizationDetails" 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
ShareSubscriptionSynchronization shareSubscriptionSynchronization = new ShareSubscriptionSynchronization(Guid.Parse("7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"));
await foreach (SynchronizationDetails item in shareSubscription.GetSynchronizationDetailsAsync(shareSubscriptionSynchronization))
{
    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

Exemple de réponse

Code d’état:: 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",
      "name": "datasetmapping1",
      "dataSetId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb",
      "dataSetType": "Blob"
    }
  ]
}

Définitions

Nom	Description
dataSetType	Type de jeu de données
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.
SynchronizationDetails	Détails de synchronisation au niveau du jeu de données
SynchronizationDetailsList	détails de la synchronisation
synchronizationMode	Mode de synchronisation

dataSetType

Type de jeu de données

Nom	Type	Description
AdlsGen1File	string
AdlsGen1Folder	string
AdlsGen2File	string
AdlsGen2FileSystem	string
AdlsGen2Folder	string
Blob	string
BlobFolder	string
Container	string
KustoCluster	string
KustoDatabase	string
KustoTable	string
SqlDBTable	string
SqlDWTable	string
SynapseWorkspaceSqlPoolTable	string

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

SynchronizationDetails

Détails de synchronisation au niveau du jeu de données

Nom	Type	Description
dataSetId	string	ID du jeu de données
dataSetType	dataSetType	Type du jeu de données
durationMs	integer	Durée de la copie au niveau du jeu de données
endTime	string	Heure de fin de la copie au niveau du jeu de données
filesRead	integer	Nombre de fichiers lus à partir du jeu de données source
filesWritten	integer	Nombre de fichiers écrits dans le jeu de données récepteur
message	string	Message d’erreur le cas échéant
name	string	Nom du jeu de données
rowsCopied	integer	Nombre de fichiers copiés dans le jeu de données récepteur
rowsRead	integer	Nombre de lignes lues à partir du jeu de données source.
sizeRead	integer	Taille des données lues à partir du jeu de données source en octets
sizeWritten	integer	Taille des données écrites dans le jeu de données récepteur en octets
startTime	string	Heure de début de la copie au niveau du jeu de données
status	string	État brut
vCore	integer	Unités vCore consommées pour la synchronisation du jeu de données

SynchronizationDetailsList

détails de la synchronisation

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

synchronizationMode

Mode de synchronisation

Nom	Type	Description
FullSync	string
Incremental	string

Partager via