Share Subscriptions - List Synchronizations

Serviço:

Data Share

Versão da API:

2021-08-01

Listar sincronizações em uma assinatura de compartilhamento.
Listar sincronizações de uma assinatura de compartilhamento

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

Com parâmetros opcionais:

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 compartilhamento.
resourceGroupName	path	True	string	O nome do grupo de recursos.
shareSubscriptionName	path	True	string	O nome da assinatura de compartilhamento.
subscriptionId	path	True	string	O identificador da subscrição
api-version	query	True	string	A versão da api a ser usada.
$filter	query		string	Filtra os resultados usando a sintaxe OData.
$orderby	query		string	Classifica os resultados usando a sintaxe OData.
$skipToken	query		string	Token de continuação

Respostas

Name	Tipo	Description
200 OK	ShareSubscriptionSynchronizationList	Sucesso
Other Status Codes	DataShareError	Uma resposta de erro recebida do provedor de recursos Microsoft.DataShare.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ShareSubscriptions_ListSynchronizations

Pedido de amostra

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

Resposta da amostra

Código de estado:

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

Definições

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

DataShareError

Object

O modelo de erro de compartilhamento de dados.

Name	Tipo	Description
error	DataShareErrorInfo	O corpo do erro de compartilhamento de dados

DataShareErrorInfo

Object

O modelo de corpo de erro de compartilhamento 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	Alvo do erro

ShareSubscriptionSynchronization

Object

Um objeto de transferência de dados ShareSubscriptionSynchronization.

Name	Tipo	Description
durationMs	integer (int32)	Duração da sincronização
endTime	string (date-time)	Hora de fim da sincronização
message	string	mensagem de sincronização
startTime	string (date-time)	Hora de início da sincronização
status	string	Estado bruto
synchronizationId	string	ID de sincronização
synchronizationMode	synchronizationMode	Modo de sincronização

ShareSubscriptionSynchronizationList

Object

Uma lista do lado do consumidor de sincronizações de assinatura de compartilhamento

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

synchronizationMode

Enumeração

Modo de sincronização

Valor	Description
FullSync
Incremental