Share Subscriptions - List Synchronization Details

Servicio:

Data Share

Versión de la API:

2021-08-01

Enumerar los detalles del nivel del conjunto de datos para una sincronización de suscripciones de recurso compartido
Enumerar los detalles de sincronización

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string	Nombre de la cuenta de recurso compartido.
resourceGroupName	path	True	string	Nombre del grupo de recursos.
shareSubscriptionName	path	True	string	Nombre de la suscripción de recurso compartido.
subscriptionId	path	True	string	Identificador de suscripción
api-version	query	True	string	Versión de api que se va a usar.
$filter	query		string	Filtra los resultados mediante la sintaxis de OData.
$orderby	query		string	Ordena los resultados mediante la sintaxis de OData.
$skipToken	query		string	Token de continuación

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
synchronizationId	True	string	Id. de sincronización

Respuestas

Nombre	Tipo	Description
200 OK	SynchronizationDetailsList	Éxito
Other Status Codes	DataShareError	Respuesta de error recibida del proveedor de recursos Microsoft.DataShare.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ShareSubscriptions_ListSynchronizationDetails

Solicitud de ejemplo

HTTP

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

{
  "synchronizationId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"
}

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_ListSynchronizationDetails.json
// this example is just showing the usage of "ShareSubscriptions_ListSynchronizationDetails" 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
ShareSubscriptionSynchronization shareSubscriptionSynchronization = new ShareSubscriptionSynchronization(Guid.Parse("7d0536a6-3fa5-43de-b152-3d07c4f6b2bb"));
await foreach (SynchronizationDetails item in shareSubscription.GetSynchronizationDetailsAsync(shareSubscriptionSynchronization))
{
    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

Respuesta de muestra

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

{
  "value": [
    {
      "endTime": "2018-11-14T04:47:52.9614956Z",
      "startTime": "2018-11-14T04:47:52.9614956Z",
      "durationMs": 2000,
      "status": "Completed",
      "name": "datasetmapping1",
      "dataSetId": "7d0536a6-3fa5-43de-b152-3d07c4f6b2bb",
      "dataSetType": "Blob"
    }
  ]
}

Definiciones

Nombre	Description
dataSetType	Tipo de conjunto de datos
DataShareError	Modelo de error del recurso compartido de datos.
DataShareErrorInfo	Modelo de cuerpo del error del recurso compartido de datos.
ShareSubscriptionSynchronization	Objeto de transferencia de datos ShareSubscriptionSynchronization.
SynchronizationDetails	Detalles de sincronización en el nivel de conjunto de datos
SynchronizationDetailsList	detalles de sincronización
synchronizationMode	Modo de sincronización

dataSetType

Enumeración

Tipo de conjunto de datos

Valor	Description
AdlsGen1File
AdlsGen1Folder
AdlsGen2File
AdlsGen2FileSystem
AdlsGen2Folder
Blob
BlobFolder
Container
KustoCluster
KustoDatabase
KustoTable
SqlDBTable
SqlDWTable
SynapseWorkspaceSqlPoolTable

DataShareError

Object

Modelo de error del recurso compartido de datos.

Nombre	Tipo	Description
error	DataShareErrorInfo	Cuerpo del error del recurso compartido de datos

DataShareErrorInfo

Object

Modelo de cuerpo del error del recurso compartido de datos.

Nombre	Tipo	Description
code	string	Código del error
details	DataShareErrorInfo[]	Detalles anidados del modelo de error
message	string	Mensaje del error
target	string	Destino del error

ShareSubscriptionSynchronization

Object

Objeto de transferencia de datos ShareSubscriptionSynchronization.

Nombre	Tipo	Description
durationMs	integer (int32)	Duración de la sincronización
endTime	string (date-time)	Hora de finalización de la sincronización
message	string	mensaje de sincronización
startTime	string (date-time)	hora de inicio de la sincronización
status	string	Estado sin procesar
synchronizationId	string	Id. de sincronización
synchronizationMode	synchronizationMode	Modo de sincronización

SynchronizationDetails

Object

Detalles de sincronización en el nivel de conjunto de datos

Nombre	Tipo	Description
dataSetId	string	Identificador del conjunto de datos
dataSetType	dataSetType	Tipo del conjunto de datos
durationMs	integer (int32)	Duración de la copia de nivel del conjunto de datos
endTime	string (date-time)	Hora de finalización de la copia de nivel del conjunto de datos
filesRead	integer (int64)	El número de archivos leídos del conjunto de datos de origen
filesWritten	integer (int64)	Número de archivos escritos en el conjunto de datos receptor
message	string	Mensaje de error si existe
name	string	Nombre del conjunto de datos
rowsCopied	integer (int64)	Número de archivos copiados en el conjunto de datos receptor
rowsRead	integer (int64)	Número de filas leídas del conjunto de datos de origen.
sizeRead	integer (int64)	Tamaño de los datos leídos del conjunto de datos de origen en bytes
sizeWritten	integer (int64)	Tamaño de los datos escritos en el conjunto de datos receptor en bytes
startTime	string (date-time)	Hora de inicio de la copia de nivel del conjunto de datos
status	string	Estado sin procesar
vCore	integer (int64)	Unidades de núcleo virtual consumidas para la sincronización del conjunto de datos

SynchronizationDetailsList

Object

detalles de sincronización

Nombre	Tipo	Description
nextLink	string	Dirección URL de la página de resultados siguiente.
value	SynchronizationDetails[]	Colección de elementos de tipo DataTransferObjects.

synchronizationMode

Enumeración

Modo de sincronización

Valor	Description
FullSync
Incremental