Share Subscriptions - List Synchronizations

Service:

Data Share

API Version:

2021-08-01

Listar Sincronizações numa subscrição de partilha.
Listar sincronizações de uma subscrição de partilha

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

With optional parameters:

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}

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	O nome da conta de partilha.
resourceGroupName	path	True	string	O nome do grupo de recursos.
shareSubscriptionName	path	True	string	O nome da subscrição de partilha.
subscriptionId	path	True	string	O identificador da subscrição
api-version	query	True	string	A versão da API a utilizar.
$filter	query		string	Filtra os resultados com a sintaxe OData.
$orderby	query		string	Ordena os resultados com a sintaxe OData.
$skipToken	query		string	Token de continuação

Respostas

Name	Tipo	Description
200 OK	ShareSubscriptionSynchronizationList	Com êxito
Other Status Codes	DataShareError	Uma resposta de erro recebida do fornecedor de recursos Microsoft.DataShare.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ShareSubscriptions_ListSynchronizations

Sample Request

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

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

Definições

Name	Description
DataShareError	O modelo de erro de partilha de dados.
DataShareErrorInfo	O modelo do corpo do erro da partilha de dados.
ShareSubscriptionSynchronization	Um objeto de transferência de dados ShareSubscriptionSynchronization.
ShareSubscriptionSynchronizationList	Uma lista do lado do consumidor das sincronizações de subscrições de partilha
synchronizationMode	Modo de sincronização

DataShareError

O modelo de erro de partilha de dados.

Name	Tipo	Description
error	DataShareErrorInfo	O corpo do erro da partilha de dados

DataShareErrorInfo

O modelo do corpo do erro da partilha de dados.

Name	Tipo	Description
code	string	Código do erro
details	DataShareErrorInfo[]	Detalhes aninhados do modelo de erro
message	string	Mensagem do erro
target	string	Destino do erro

ShareSubscriptionSynchronization

Um objeto de transferência de dados ShareSubscriptionSynchronization.

Name	Tipo	Description
durationMs	integer	Duração da sincronização
endTime	string	Hora de fim da sincronização
message	string	mensagem de Sincronização
startTime	string	hora de início da sincronização
status	string	Estado Não Processado
synchronizationId	string	ID de sincronização
synchronizationMode	synchronizationMode	Modo de Sincronização

ShareSubscriptionSynchronizationList

Uma lista do lado do consumidor das sincronizações de subscrições de partilha

Name	Tipo	Description
nextLink	string	O URL da página de resultados seguinte.
value	ShareSubscriptionSynchronization[]	Coleção de itens do tipo DataTransferObjects.

synchronizationMode

Modo de sincronização

Name	Tipo	Description
FullSync	string
Incremental	string