Shares - List Synchronizations

Service:

Data Share

API Version:

2021-08-01

Auflisten von Synchronisierungen in einer Freigabe
Auflisten von Synchronisierungen einer Freigabe

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

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataShare/accounts/{accountName}/shares/{shareName}/listSynchronizations?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.
shareName	path	True	string	Der Name der Freigabe.
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

Antworten

Name	Typ	Beschreibung
200 OK	ShareSynchronizationList	Erfolg
Other Status Codes	DataShareError	Eine Fehlerantwort, die vom Microsoft.DataShare-Ressourcenanbieter empfangen wurde.

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

Shares_ListSynchronizations

Sample Request

HTTP

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

dotnet

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/Shares_ListSynchronizations.json
// this example is just showing the usage of "Shares_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 DataShareResource created on azure
// for more information of creating DataShareResource, please refer to the document of DataShareResource
string subscriptionId = "433a8dfd-e5d5-4e77-ad86-90acdc75eb1a";
string resourceGroupName = "SampleResourceGroup";
string accountName = "Account1";
string shareName = "Share1";
ResourceIdentifier dataShareResourceId = DataShareResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, shareName);
DataShareResource dataShare = client.GetDataShareResource(dataShareResourceId);

// invoke the operation and iterate over the result
await foreach (ShareSynchronization item in dataShare.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",
      "consumerTenantName": "nda",
      "consumerName": "abc@yahoo.com",
      "synchronizationId": "runId",
      "synchronizationMode": "Incremental"
    }
  ]
}

Definitionen

Name	Beschreibung
DataShareError	Das Datenfreigabefehlermodell.
DataShareErrorInfo	Das Datenfreigabefehler-Textmodell.
ShareSynchronization	Ein ShareSynchronization-Datenübertragungsobjekt.
ShareSynchronizationList	Auflisten der Antwort zum Abrufen von ShareSynchronization.
synchronizationMode	Synchronisierungsmodus

DataShareError

Das Datenfreigabefehlermodell.

Name	Typ	Beschreibung
error	DataShareErrorInfo	Fehlertext der Datenfreigabe

DataShareErrorInfo

Das Datenfreigabefehler-Textmodell.

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

ShareSynchronization

Ein ShareSynchronization-Datenübertragungsobjekt.

Name	Typ	Beschreibung
consumerEmail	string	Email des Benutzers, der die Synchronisierung erstellt hat
consumerName	string	Name des Benutzers, der die Synchronisierung erstellt hat
consumerTenantName	string	Mandantenname des Consumers, der die Synchronisierung erstellt hat
durationMs	integer	Synchronisierungsdauer
endTime	string	Endzeit der Synchronisierung
message	string	Meldung der Synchronisierung
startTime	string	Startzeit der Synchronisierung
status	string	Rohzustand
synchronizationId	string	Synchronisierungs-ID
synchronizationMode	synchronizationMode	Synchronisierungsmodus

ShareSynchronizationList

Auflisten der Antwort zum Abrufen von ShareSynchronization.

Name	Typ	Beschreibung
nextLink	string	Die URL der nächsten Ergebnisseite.
value	ShareSynchronization[]	Sammlung von Elementen vom Typ DataTransferObjects.

synchronizationMode

Synchronisierungsmodus

Name	Typ	Beschreibung
FullSync	string
Incremental	string