Share Subscriptions - List Synchronization Details

Referenz

Service:: Data Share

API Version:: 2021-08-01

Auflisten von Datasetebenendetails für eine Freigabeabonnementsynchronisierung
Auflisten von Synchronisierungsdetails

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}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Der Name des Freigabekontos.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe.
shareSubscriptionName	path	True	string	Der Name des Freigabeabonnements.
subscriptionId	path	True	string	Der Abonnementbezeichner
api-version	query	True	string	Die zu verwendende API-Version.
$filter	query		string	Filtert die Ergebnisse mithilfe der OData-Syntax.
$orderby	query		string	Sortiert die Ergebnisse mithilfe der OData-Syntax.
$skipToken	query		string	Fortsetzungstoken

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
synchronizationId	True	string	Synchronisierungs-ID

Antworten

Name	Typ	Beschreibung
200 OK	SynchronizationDetailsList	Erfolg
Other Status Codes	DataShareError	Eine Vom Microsoft.DataShare-Ressourcenanbieter empfangene Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

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

Definitionen

Name	Beschreibung
dataSetType	Typ des Datasets
DataShareError	Das Datenfreigabefehlermodell.
DataShareErrorInfo	Das Datenfreigabefehlermodell.
ShareSubscriptionSynchronization	Ein ShareSubscriptionSynchronization-Datenübertragungsobjekt.
SynchronizationDetails	Synchronisierungsdetails auf Datensatzebene
SynchronizationDetailsList	Details der Synchronisierung
synchronizationMode	Synchronisierungsmodus

dataSetType

Typ des Datasets

Name	Typ	Beschreibung
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

Das Datenfreigabefehlermodell.

Name	Typ	Beschreibung
error	DataShareErrorInfo	Fehlertext der Datenfreigabe

DataShareErrorInfo

Das Datenfreigabefehlermodell.

Name	Typ	Beschreibung
code	string	Code des Fehlers
details	DataShareErrorInfo[]	Geschachtelte Details des Fehlermodells
message	string	Meldung des Fehlers
target	string	Ziel des Fehlers

ShareSubscriptionSynchronization

Ein ShareSubscriptionSynchronization-Datenübertragungsobjekt.

Name	Typ	Beschreibung
durationMs	integer	Synchronisierungsdauer
endTime	string	Endzeit der Synchronisierung
message	string	Meldung der Synchronisierung
startTime	string	Startzeit der Synchronisierung
status	string	Unformatierter Status
synchronizationId	string	Synchronisierungs-ID
synchronizationMode	synchronizationMode	Synchronisierungsmodus

SynchronizationDetails

Synchronisierungsdetails auf Datensatzebene

Name	Typ	Beschreibung
dataSetId	string	ID des Datasets
dataSetType	dataSetType	Typ des Datasets
durationMs	integer	Dauer des Kopiervorgangs auf Datasetebene
endTime	string	Endzeit des Kopiervorgangs auf Datasetebene
filesRead	integer	Die Anzahl der Dateien, die aus dem Quelldataset gelesen werden
filesWritten	integer	Die Anzahl der Dateien, die in das Senkendatensatz geschrieben wurden.
message	string	Fehlermeldung, falls vorhanden
name	string	Name des Datasets
rowsCopied	integer	Die Anzahl der Dateien, die in das Senkendatensatz kopiert wurden.
rowsRead	integer	Die Anzahl der Zeilen, die aus dem Quelldataset gelesen werden.
sizeRead	integer	Die Größe der aus dem Quelldataset gelesenen Daten in Bytes
sizeWritten	integer	Die Größe der in das Senkendatensatz geschriebenen Daten in Byte
startTime	string	Startzeit des Kopiervorgangs auf Datasetebene
status	string	Unformatierter Status
vCore	integer	Die für die Datasetsynchronisierung verbrauchten V-Kern-Einheiten

SynchronizationDetailsList

Details der Synchronisierung

Name	Typ	Beschreibung
nextLink	string	Die URL der nächsten Ergebnisseite.
value	SynchronizationDetails[]	Auflistung von Elementen des Typs DataTransferObjects.

synchronizationMode

Synchronisierungsmodus

Name	Typ	Beschreibung
FullSync	string
Incremental	string

Freigeben über