Data Transfer Jobs - Pause

Dienst:

Cosmos DB Resource Provider

API-Version:

2025-05-01-preview

Anhalten eines Datenübertragungsauftrags.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Name des Cosmos DB-Datenbankkontos.
jobName	path	True	string	Name des Datenübertragungsauftrags
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string minLength: 1	Die ID des Zielabonnements.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	DataTransferJobGetResults	Antwort auf erfolgreichen Pausenauftrag
Other Status Codes	CloudError	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

CosmosDBDataTransferJobPause

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

200

{
  "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16",
  "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
  "properties": {
    "jobName": "j1",
    "source": {
      "tableName": "table",
      "keyspaceName": "keyspace",
      "component": "CosmosDBCassandra"
    },
    "destination": {
      "component": "AzureBlobStorage",
      "containerName": "blob_container",
      "endpointUrl": "https://blob.windows.net"
    },
    "status": "Paused",
    "processedCount": 20,
    "totalCount": 100,
    "lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z",
    "duration": "00:11:25"
  }
}

Definitionen

Name	Beschreibung
AzureBlobDataTransferDataSourceSink	Eine Azure Blob Storage-Datenquelle/-Spüle
CloudError	Eine Fehlerantwort des Diensts.
CosmosMongoVCoreDataTransferDataSourceSink	A CosmosDB Mongo vCore API data source/sink
DataTransferJobGetResults	Ein Cosmos DB-Datenübertragungsauftrag
DataTransferJobMode	Ausführungsmodus des Auftrags
ErrorResponse	Fehlerantwort.

AzureBlobDataTransferDataSourceSink

Objekt

Eine Azure Blob Storage-Datenquelle/-Spüle

Name	Typ	Standardwert	Beschreibung
component	string: AzureBlobStorage	CosmosDBCassandra
containerName	string
endpointUrl	string

CloudError

Objekt

Eine Fehlerantwort des Diensts.

Name	Typ	Beschreibung
error	ErrorResponse	Fehlerantwort.

CosmosMongoVCoreDataTransferDataSourceSink

Objekt

A CosmosDB Mongo vCore API data source/sink

Name	Typ	Standardwert	Beschreibung
collectionName	string
component	string: CosmosDBMongoVCore	CosmosDBCassandra
connectionStringKeyVaultUri	string
databaseName	string
hostName	string

DataTransferJobGetResults

Objekt

Ein Cosmos DB-Datenübertragungsauftrag

Name	Typ	Beschreibung
id	string	Der eindeutige Ressourcenbezeichner des Datenbankkontos.
name	string	Der Name des Datenbankkontos.
properties.destination	DataTransferDataSourceSink: AzureBlobDataTransferDataSourceSink CosmosMongoVCoreDataTransferDataSourceSink	Details zum Zieldatenspeicher
properties.duration	string	Gesamtdauer des Auftrags
properties.error	ErrorResponse	Fehlerantwort für fehlerhaften Auftrag
properties.jobName	string	Auftragsname
properties.lastUpdatedUtcTime	string (date-time)	Uhrzeit der letzten Aktualisierung (ISO-8601-Format).
properties.mode	DataTransferJobMode	Ausführungsmodus des Auftrags
properties.processedCount	integer (int64)	Verarbeitete Anzahl.
properties.source	DataTransferDataSourceSink: AzureBlobDataTransferDataSourceSink CosmosMongoVCoreDataTransferDataSourceSink	Details zum Datenquellendatenspeicher
properties.status	string	Auftragsstatus
properties.totalCount	integer (int64)	Gesamtanzahl.
properties.workerCount	integer (int32) minimum: 0	Anzahl arbeite
type	string	Der Typ der Azure-Ressource.

DataTransferJobMode

Enumeration

Ausführungsmodus des Auftrags

Wert	Beschreibung
Offline
Online

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
code	string	Fehlercode.
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.