Share Subscriptions - List Synchronization Details

Riferimento

Service:: Data Share

API Version:: 2021-08-01

Elencare i dettagli del livello del set di dati per la sincronizzazione di una sottoscrizione di condivisione
Elencare i dettagli di sincronizzazione

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

With optional parameters:

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}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string	Nome dell'account di condivisione.
resourceGroupName	path	True	string	Il nome del gruppo di risorse.
shareSubscriptionName	path	True	string	Nome della sottoscrizione di condivisione.
subscriptionId	path	True	string	Identificatore della sottoscrizione
api-version	query	True	string	Versione dell'API da usare.
$filter	query		string	Filtra i risultati usando la sintassi OData.
$orderby	query		string	Ordina i risultati usando la sintassi OData.
$skipToken	query		string	token di continuazione

Corpo della richiesta

Nome	Necessario	Tipo	Descrizione
synchronizationId	True	string	ID sincronizzazione

Risposte

Nome	Tipo	Descrizione
200 OK	SynchronizationDetailsList	Operazione riuscita
Other Status Codes	DataShareError	Risposta di errore ricevuta dal provider di risorse Microsoft.DataShare.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

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

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

Definizioni

Nome	Descrizione
dataSetType	Tipo di set di dati
DataShareError	Modello di errore di condivisione dati.
DataShareErrorInfo	Modello del corpo dell'errore di condivisione dati.
ShareSubscriptionSynchronization	Oggetto di trasferimento dati ShareSubscriptionSynchronization.
SynchronizationDetails	Dettagli di sincronizzazione a livello di set di dati
SynchronizationDetailsList	dettagli della sincronizzazione
synchronizationMode	Modalità di sincronizzazione

dataSetType

Tipo di set di dati

Nome	Tipo	Descrizione
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

Modello di errore di condivisione dati.

Nome	Tipo	Descrizione
error	DataShareErrorInfo	Corpo dell'errore di condivisione dati

DataShareErrorInfo

Modello del corpo dell'errore di condivisione dati.

Nome	Tipo	Descrizione
code	string	Codice dell'errore
details	DataShareErrorInfo[]	Dettagli annidati del modello di errore
message	string	Messaggio dell'errore
target	string	Destinazione dell'errore

ShareSubscriptionSynchronization

Oggetto di trasferimento dati ShareSubscriptionSynchronization.

Nome	Tipo	Descrizione
durationMs	integer	Durata sincronizzazione
endTime	string	Ora di fine della sincronizzazione
message	string	messaggio di sincronizzazione
startTime	string	ora di inizio della sincronizzazione
status	string	Stato non elaborato
synchronizationId	string	ID sincronizzazione
synchronizationMode	synchronizationMode	Modalità di sincronizzazione

SynchronizationDetails

Dettagli di sincronizzazione a livello di set di dati

Nome	Tipo	Descrizione
dataSetId	string	ID del set di dati
dataSetType	dataSetType	Tipo del set di dati
durationMs	integer	Durata della copia a livello di set di dati
endTime	string	Ora di fine della copia a livello di set di dati
filesRead	integer	Numero di file letti dal set di dati di origine
filesWritten	integer	Numero di file scritti nel set di dati sink
message	string	Messaggio di errore se disponibile
name	string	Nome del set di dati
rowsCopied	integer	Numero di file copiati nel set di dati sink
rowsRead	integer	Numero di righe lette dal set di dati di origine.
sizeRead	integer	Dimensioni dei dati letti dal set di dati di origine in byte
sizeWritten	integer	Dimensioni dei dati scritti nel set di dati sink in byte
startTime	string	Ora di inizio della copia a livello di set di dati
status	string	Stato non elaborato
vCore	integer	Unità vCore utilizzate per la sincronizzazione del set di dati

SynchronizationDetailsList

dettagli della sincronizzazione

Nome	Tipo	Descrizione
nextLink	string	URL della pagina dei risultati successiva.
value	SynchronizationDetails[]	Raccolta di elementi di tipo DataTransferObjects.

synchronizationMode

Modalità di sincronizzazione

Nome	Tipo	Descrizione
FullSync	string
Incremental	string