Data Transfer Jobs - List By Database Account

Servizio:

Cosmos DB Resource Provider

Versione API:

2025-05-01-preview

Ottenere un elenco di processi di trasferimento dati.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs?api-version=2025-05-01-preview

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nome dell'account del database Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
subscriptionId	path	True	string minLength: 1	ID della sottoscrizione di destinazione.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	DataTransferJobFeedResults	Tutti i processi di trasferimento dati recuperati correttamente
Other Status Codes	CloudError	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	Impersonare l'account utente

Esempio

CosmosDBDataTransferJobFeed

Esempio di richiesta

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/dataTransferJobs?api-version=2025-05-01-preview

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16",
      "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
      "properties": {
        "jobName": "j1",
        "source": {
          "tableName": "table",
          "keyspaceName": "keyspace",
          "component": "CosmosDBCassandra"
        },
        "destination": {
          "component": "AzureBlobStorage",
          "endpointUrl": "https://blob.windows.net",
          "containerName": "blob_container"
        },
        "status": "Completed",
        "processedCount": 100,
        "totalCount": 100,
        "lastUpdatedUtcTime": "2021-06-12T12:04:23.1530000Z",
        "duration": "00:00:00"
      }
    }
  ]
}

Definizioni

Nome	Descrizione
AzureBlobDataTransferDataSourceSink	Un'origine dati/sink di Archiviazione BLOB di Azure
CloudError	Risposta di errore dal servizio.
CosmosMongoVCoreDataTransferDataSourceSink	Origine dati/sink dell'API Mongo vCore di CosmosDB
DataTransferJobFeedResults	Risposta dell'operazione List, che contiene i processi di trasferimento dati e le relative proprietà.
DataTransferJobGetResults	Processo di trasferimento dati di Cosmos DB
DataTransferJobMode	Modalità di esecuzione del processo
ErrorResponse	Risposta errore.

AzureBlobDataTransferDataSourceSink

Object

Un'origine dati/sink di Archiviazione BLOB di Azure

Nome	Tipo	Valore predefinito	Descrizione
component	string: AzureBlobStorage	CosmosDBCassandra
containerName	string
endpointUrl	string

CloudError

Object

Risposta di errore dal servizio.

Nome	Tipo	Descrizione
error	ErrorResponse	Risposta errore.

CosmosMongoVCoreDataTransferDataSourceSink

Object

Origine dati/sink dell'API Mongo vCore di CosmosDB

Nome	Tipo	Valore predefinito	Descrizione
collectionName	string
component	string: CosmosDBMongoVCore	CosmosDBCassandra
connectionStringKeyVaultUri	string
databaseName	string
hostName	string

DataTransferJobFeedResults

Object

Risposta dell'operazione List, che contiene i processi di trasferimento dati e le relative proprietà.

Nome	Tipo	Descrizione
nextLink	string	URL per ottenere il set successivo di risultati dell'elenco dei processi di trasferimento dati, se presenti.
value	DataTransferJobGetResults[]	Elenco dei processi di trasferimento dati e delle relative proprietà.

DataTransferJobGetResults

Object

Processo di trasferimento dati di Cosmos DB

Nome	Tipo	Descrizione
id	string	Identificatore univoco della risorsa dell'account del database.
name	string	Nome dell'account di database.
properties.destination	DataTransferDataSourceSink: AzureBlobDataTransferDataSourceSink CosmosMongoVCoreDataTransferDataSourceSink	Dettagli archivio dati di destinazione
properties.duration	string	Durata totale del processo
properties.error	ErrorResponse	Risposta di errore per il processo con errori
properties.jobName	string	Nome lavoro
properties.lastUpdatedUtcTime	string (date-time)	Ora ultimo aggiornamento (formato ISO-8601).
properties.mode	DataTransferJobMode	Modalità di esecuzione del processo
properties.processedCount	integer (int64)	Conteggio elaborato.
properties.source	DataTransferDataSourceSink: AzureBlobDataTransferDataSourceSink CosmosMongoVCoreDataTransferDataSourceSink	Dettagli dell'archivio dati di origine
properties.status	string	Stato del lavoro
properties.totalCount	integer (int64)	Conteggio totale.
properties.workerCount	integer (int32) minimum: 0	Conteggio ruoli di lavoro
type	string	Tipo di risorsa di Azure.

DataTransferJobMode

Enumerazione

Modalità di esecuzione del processo

Valore	Descrizione
Offline
Online

ErrorResponse

Object

Risposta errore.

Nome	Tipo	Descrizione
code	string	Codice di errore.
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.