Share Subscriptions - List Synchronizations

Dienst:

Data Share

API-Version:

2021-08-01

Listensynchronisierungen in einem Freigabeabonnement.
Auflisten von Synchronisierungen eines Freigabeabonnements

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

Mit optionalen Parametern:

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}

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Der Name des Freigabekontos.
resourceGroupName	path	True	string	Der Ressourcengruppenname.
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

Antworten

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

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ShareSubscriptions_ListSynchronizations

Beispielanforderung

HTTP

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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.DataShare.Models;
using Azure.ResourceManager.DataShare;

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

Beispiel für eine Antwort

Statuscode:

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",
      "message": "nda",
      "synchronizationId": "runId",
      "synchronizationMode": "Incremental"
    }
  ]
}

Definitionen

Name	Beschreibung
DataShareError	Das Fehlermodell für die Datenfreigabe.
DataShareErrorInfo	Das Fehlertextmodell für die Datenfreigabe.
ShareSubscriptionSynchronization	Ein ShareSubscriptionSynchronization-Datenübertragungsobjekt.
ShareSubscriptionSynchronizationList	Eine verbraucherseitige Liste der Freigabeabonnementsynchronisierungen
synchronizationMode	Synchronisierungsmodus

DataShareError

Objekt

Das Fehlermodell für die Datenfreigabe.

Name	Typ	Beschreibung
error	DataShareErrorInfo	Der Fehlertext der Datenfreigabe

DataShareErrorInfo

Objekt

Das Fehlertextmodell für die Datenfreigabe.

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

Objekt

Ein ShareSubscriptionSynchronization-Datenübertragungsobjekt.

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

ShareSubscriptionSynchronizationList

Objekt

Eine verbraucherseitige Liste der Freigabeabonnementsynchronisierungen

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

synchronizationMode

Enumeration

Synchronisierungsmodus

Wert	Beschreibung
FullSync
Incremental