Data Transfer Jobs - Resume
Resumes a Data Transfer Job.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/dataTransferJobs/{jobName}/resume?api-version=2025-05-01-preview
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string minLength: 3maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)* |
Cosmos DB database account name. |
job
|
path | True |
string |
Name of the Data Transfer Job |
resource
|
path | True |
string minLength: 1maxLength: 90 |
The name of the resource group. The name is case insensitive. |
subscription
|
path | True |
string minLength: 1 |
The ID of the target subscription. |
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Successful Resume Job response |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Impersonate your user account |
Examples
CosmosDBDataTransferJobResume
Sample request
POST https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/dataTransferJobs/j1/resume?api-version=2025-05-01-preview
Sample response
{
"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": "Pending",
"processedCount": 20,
"totalCount": 100,
"lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z",
"duration": "00:21:50"
}
}
Definitions
Name | Description |
---|---|
Azure |
An Azure Blob Storage data source/sink |
Cloud |
An error response from the service. |
Cosmos |
A CosmosDB Mongo vCore API data source/sink |
Data |
A Cosmos DB Data Transfer Job |
Data |
Mode of job execution |
Error |
Error Response. |
AzureBlobDataTransferDataSourceSink
An Azure Blob Storage data source/sink
Name | Type | Default value | Description |
---|---|---|---|
component |
string:
Azure |
CosmosDBCassandra | |
containerName |
string |
||
endpointUrl |
string |
CloudError
An error response from the service.
Name | Type | Description |
---|---|---|
error |
Error Response. |
CosmosMongoVCoreDataTransferDataSourceSink
A CosmosDB Mongo vCore API data source/sink
Name | Type | Default value | Description |
---|---|---|---|
collectionName |
string |
||
component |
string:
Cosmos |
CosmosDBCassandra | |
connectionStringKeyVaultUri |
string |
||
databaseName |
string |
||
hostName |
string |
DataTransferJobGetResults
A Cosmos DB Data Transfer Job
Name | Type | Description |
---|---|---|
id |
string |
The unique resource identifier of the database account. |
name |
string |
The name of the database account. |
properties.destination | DataTransferDataSourceSink: |
Destination DataStore details |
properties.duration |
string |
Total Duration of Job |
properties.error |
Error response for Faulted job |
|
properties.jobName |
string |
Job Name |
properties.lastUpdatedUtcTime |
string (date-time) |
Last Updated Time (ISO-8601 format). |
properties.mode |
Mode of job execution |
|
properties.processedCount |
integer (int64) |
Processed Count. |
properties.source | DataTransferDataSourceSink: |
Source DataStore details |
properties.status |
string |
Job Status |
properties.totalCount |
integer (int64) |
Total Count. |
properties.workerCount |
integer (int32) minimum: 0 |
Worker count |
type |
string |
The type of Azure resource. |
DataTransferJobMode
Mode of job execution
Value | Description |
---|---|
Offline | |
Online |
ErrorResponse
Error Response.
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
message |
string |
Error message indicating why the operation failed. |