Shares - List Synchronizations

Service:

Data Share

API Version:

2021-08-01

Lista synkroniseringar i en resurs
Visa en lista över synkroniseringar av en resurs

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

Name	I	Obligatorisk	Typ	Description
accountName	path	True	string	Namnet på resurskontot.
resourceGroupName	path	True	string	Resursgruppens namn.
shareName	path	True	string	Namnet på resursen.
subscriptionId	path	True	string	Prenumerationsidentifieraren
api-version	query	True	string	Api-versionen som ska användas.
$filter	query		string	Filtrerar resultatet med OData-syntax.
$orderby	query		string	Sorterar resultatet med OData-syntax.
$skipToken	query		string	Fortsättningstoken

Svar

Name	Typ	Description
200 OK	ShareSynchronizationList	Klart
Other Status Codes	DataShareError	Ett felsvar som tagits emot från resursprovidern Microsoft.DataShare.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

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

Definitioner

Name	Description
DataShareError	Dataresursens felmodell.
DataShareErrorInfo	Dataresursens feltextmodell.
ShareSynchronization	Ett ShareSynchronization-dataöverföringsobjekt.
ShareSynchronizationList	Listsvar för att hämta ShareSynchronization.
synchronizationMode	Synkroniseringsläge

DataShareError

Dataresursens felmodell.

Name	Typ	Description
error	DataShareErrorInfo	Dataresursens feltext

DataShareErrorInfo

Dataresursens feltextmodell.

Name	Typ	Description
code	string	Felkoden
details	DataShareErrorInfo[]	Kapslad information om felmodellen
message	string	Meddelande om felet
target	string	Målet för felet

ShareSynchronization

Ett ShareSynchronization-dataöverföringsobjekt.

Name	Typ	Description
consumerEmail	string	Email för användaren som skapade synkroniseringen
consumerName	string	Namnet på den användare som skapade synkroniseringen
consumerTenantName	string	Klientorganisationens namn på den konsument som skapade synkroniseringen
durationMs	integer	varaktighet för synkronisering
endTime	string	Sluttid för synkronisering
message	string	meddelande om synkronisering
startTime	string	synkroniseringens starttid
status	string	Råstatus
synchronizationId	string	Synkroniserings-ID
synchronizationMode	synchronizationMode	Synkroniseringsläge

ShareSynchronizationList

Listsvar för att hämta ShareSynchronization.

Name	Typ	Description
nextLink	string	Url:en för nästa resultatsida.
value	ShareSynchronization[]	Samling objekt av typen DataTransferObjects.

synchronizationMode

Synkroniseringsläge

Name	Typ	Description
FullSync	string
Incremental	string