Copy Jobs - Cancel

Service:

Cosmos DB Resource Provider

API Version:

2025-05-01-preview

Cancels a Copy Job.

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

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB database account name.
jobName	path	True	string pattern: ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$	Name of the Copy Job
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	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	CopyJobGetResults	Successful Cancel Job response
Other Status Codes	CloudError	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

CosmosDBCopyJobCancel

Sample request

HTTP

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

Sample response

Status code:

200

{
  "id": "ab1b6f34-b33c-46b1-98c7-3a0a63fd0d16",
  "type": "Microsoft.DocumentDB/databaseAccounts/copyJobs",
  "properties": {
    "jobProperties": {
      "jobType": "NoSqlRUToNoSqlRU",
      "tasks": [
        {
          "source": {
            "databaseName": "sourceDb1",
            "containerName": "sourceTable1"
          },
          "destination": {
            "databaseName": "destDB1",
            "containerName": "destTable1"
          }
        },
        {
          "source": {
            "databaseName": "sourceDb2",
            "containerName": "sourceTable2"
          },
          "destination": {
            "databaseName": "destDB2",
            "containerName": "destTable2"
          }
        }
      ]
    },
    "status": "Cancelled",
    "mode": "Offline",
    "processedCount": 20,
    "totalCount": 100,
    "lastUpdatedUtcTime": "2021-06-12T11:10:55.2780000Z",
    "duration": "00:00:00"
  }
}

Definitions

Name	Description
AzureBlobContainer	An Azure Blob container
AzureBlobSourceSinkDetails	An Azure Blob Storage data source/sink
BlobToCassandraRUCopyJobProperties	Source Azure Blob Storage to Destination Cassandra copy job properties
BlobToCassandraRUCopyJobTask
CassandraRUToBlobCopyJobProperties	Source Cassandra to Destination Azure Blob Storage copy job properties
CassandraRUToBlobCopyJobTask
CassandraRUToCassandraRUCopyJobProperties	Source Cassandra to Destination Cassandra copy job properties
CassandraRUToCassandraRUCopyJobTask
CloudError	An error response from the service.
CopyJobGetResults	A Cosmos DB Copy Job
CopyJobMode	Mode of job execution
CopyJobProperties	The properties of a Copy Job
CopyJobStatus	Job Status
CosmosDBCassandraTable	A CosmosDB Cassandra table
CosmosDBMongoCollection	A CosmosDB Mongo collection
CosmosDBMongoVCoreCollection	A CosmosDB Mongo vCore collection
CosmosDBNoSqlContainer	A CosmosDB NoSQL container
CosmosDBSourceSinkDetails	A CosmosDB data source/sink details
ErrorResponse	Error Response.
MongoRUToMongoRUCopyJobProperties	Source Mongo to Destination Mongo copy job properties
MongoRUToMongoRUCopyJobTask
MongoRUToMongoVCoreCopyJobProperties	Source Mongo to Destination Mongo vCore copy job properties
MongoRUToMongoVCoreCopyJobTask
MongoVCoreSourceSinkDetails	A CosmosDB Mongo vCore data source/sink details
NoSqlRUToNoSqlRUCopyJobProperties	Source SQL to Destination SQL copy job properties
NoSqlRUToNoSqlRUCopyJobTask

AzureBlobContainer

Object

An Azure Blob container

Name	Type	Description
containerName	string	Azure Blob container.

AzureBlobSourceSinkDetails

Object

An Azure Blob Storage data source/sink

Name	Type	Description
endpointUrl	string pattern: ^https?://[^/$.?# ]+.[^ ]*$	Azure Blob container endpoint.

BlobToCassandraRUCopyJobProperties

Object

Source Azure Blob Storage to Destination Cassandra copy job properties

Name	Type	Default value	Description
destinationDetails	CosmosDBSourceSinkDetails		Destination Cassandra DataStore details
jobType	string: AzureBlobStorageToCassandraRU	NoSqlRUToNoSqlRU	Copy Job Type
sourceDetails	AzureBlobSourceSinkDetails		Azure Storage container DataStore details
tasks	BlobToCassandraRUCopyJobTask[]		Copy Job tasks.

BlobToCassandraRUCopyJobTask

Object

Name	Type	Description
destination	CosmosDBCassandraTable	Destination Cassandra table
processedCount	integer (int64)	Task level Processed Count.
source	AzureBlobContainer	Source Azure Blob container
totalCount	integer (int64)	Task level Total Count.

CassandraRUToBlobCopyJobProperties

Object

Source Cassandra to Destination Azure Blob Storage copy job properties

Name	Type	Default value	Description
destinationDetails	AzureBlobSourceSinkDetails		Destination Cassandra DataStore details
jobType	string: CassandraRUToAzureBlobStorage	NoSqlRUToNoSqlRU	Copy Job Type
sourceDetails	CosmosDBSourceSinkDetails		Source Cassandra DataStore details
tasks	CassandraRUToBlobCopyJobTask[]		Copy Job tasks.

CassandraRUToBlobCopyJobTask

Object

Name	Type	Description
destination	AzureBlobContainer	Destination Azure Blob container
processedCount	integer (int64)	Task level Processed Count.
source	CosmosDBCassandraTable	Source Cassandra table
totalCount	integer (int64)	Task level Total Count.

CassandraRUToCassandraRUCopyJobProperties

Object

Source Cassandra to Destination Cassandra copy job properties

Name	Type	Default value	Description
destinationDetails	CosmosDBSourceSinkDetails		Destination Cassandra DataStore details
jobType	string: CassandraRUToCassandraRU	NoSqlRUToNoSqlRU	Copy Job Type
sourceDetails	CosmosDBSourceSinkDetails		Source Cassandra DataStore details
tasks	CassandraRUToCassandraRUCopyJobTask[]		Copy Job tasks.

CassandraRUToCassandraRUCopyJobTask

Object

Name	Type	Description
destination	CosmosDBCassandraTable	Destination Cassandra table
processedCount	integer (int64)	Task level Processed Count.
source	CosmosDBCassandraTable	Source Cassandra table
totalCount	integer (int64)	Task level Total Count.

CloudError

Object

An error response from the service.

Name	Type	Description
error	ErrorResponse	Error Response.

CopyJobGetResults

Object

A Cosmos DB Copy Job

Name	Type	Description
id	string	The unique resource identifier of the database account.
name	string	The name of the database account.
properties	CopyJobProperties	The properties of a Copy Job
type	string	The type of Azure resource.

CopyJobMode

Enumeration

Mode of job execution

Value	Description
Offline
Online

CopyJobProperties

Object

The properties of a Copy Job

Name	Type	Description
duration	string	Total Duration of Job
error	ErrorResponse	Error response for Faulted job
jobProperties	BaseCopyJobProperties: BlobToCassandraRUCopyJobProperties CassandraRUToBlobCopyJobProperties CassandraRUToCassandraRUCopyJobProperties MongoRUToMongoRUCopyJobProperties MongoRUToMongoVCoreCopyJobProperties NoSqlRUToNoSqlRUCopyJobProperties	Job Properties
lastUpdatedUtcTime	string (date-time)	Last Updated Time (ISO-8601 format)
mode	CopyJobMode	Mode of job execution
processedCount	integer (int64)	Processed Count
status	CopyJobStatus	Job Status
totalCount	integer (int64)	Total Count
workerCount	integer (int32) minimum: 0	Worker count

CopyJobStatus

Enumeration

Job Status

Value	Description
Pending
Partitioning
Running
Paused
Completed
Faulted
Cancelled

CosmosDBCassandraTable

Object

A CosmosDB Cassandra table

Name	Type	Description
keyspaceName	string	Azure Cosmos DB for Apache Cassandra keyspace.
tableName	string	Azure Cosmos DB for Apache Cassandra table.

CosmosDBMongoCollection

Object

A CosmosDB Mongo collection

Name	Type	Description
collectionName	string	Azure Cosmos DB for MongoDB (RU) collection.
databaseName	string	Azure Cosmos DB for MongoDB (RU) database.

CosmosDBMongoVCoreCollection

Object

A CosmosDB Mongo vCore collection

Name	Type	Description
collectionName	string	Azure Cosmos DB for MongoDB (vCore) collection.
databaseName	string	Azure Cosmos DB for MongoDB (vCore) database.

CosmosDBNoSqlContainer

Object

A CosmosDB NoSQL container

Name	Type	Description
containerName	string	Azure Cosmos DB for NoSQL container.
databaseName	string	Azure Cosmos DB for NoSQL database.

CosmosDBSourceSinkDetails

Object

A CosmosDB data source/sink details

Name	Type	Description
remoteAccountName	string	Name of remote account in case of cross-account data transfer.

ErrorResponse

Object

Error Response.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

MongoRUToMongoRUCopyJobProperties

Object

Source Mongo to Destination Mongo copy job properties

Name	Type	Default value	Description
destinationDetails	CosmosDBSourceSinkDetails		Destination Mongo DataStore details
jobType	string: MongoRUToMongoRU	NoSqlRUToNoSqlRU	Copy Job Type
sourceDetails	CosmosDBSourceSinkDetails		Source Mongo DataStore details
tasks	MongoRUToMongoRUCopyJobTask[]		Copy Job tasks.

MongoRUToMongoRUCopyJobTask

Object

Name	Type	Description
destination	CosmosDBMongoCollection	Destination Mongo (RU) collection
processedCount	integer (int64)	Task level Processed Count.
source	CosmosDBMongoCollection	Source Mongo (RU) collection
totalCount	integer (int64)	Task level Total Count.

MongoRUToMongoVCoreCopyJobProperties

Object

Source Mongo to Destination Mongo vCore copy job properties

Name	Type	Default value	Description
destinationDetails	MongoVCoreSourceSinkDetails		Destination Mongo (vCore) DataStore details
jobType	string: MongoRUToMongoVCore	NoSqlRUToNoSqlRU	Copy Job Type
sourceDetails	CosmosDBSourceSinkDetails		Source Mongo (RU) DataStore details
tasks	MongoRUToMongoVCoreCopyJobTask[]		Copy Job tasks.

MongoRUToMongoVCoreCopyJobTask

Object

Name	Type	Description
destination	CosmosDBMongoVCoreCollection	Destination Mongo (vCore) collection
processedCount	integer (int64)	Task level Processed Count.
source	CosmosDBMongoCollection	Source Mongo (RU) collection
totalCount	integer (int64)	Task level Total Count.

MongoVCoreSourceSinkDetails

Object

A CosmosDB Mongo vCore data source/sink details

Name	Type	Description
connectionStringKeyVaultUri	string pattern: ^https?://[^/$.?# ]+.[^ ]*$	URI of Azure KeyVault secret containing connection string.
hostName	string

NoSqlRUToNoSqlRUCopyJobProperties

Object

Source SQL to Destination SQL copy job properties

Name	Type	Default value	Description
destinationDetails	CosmosDBSourceSinkDetails		Destination SQL DataStore details
jobType	string: NoSqlRUToNoSqlRU	NoSqlRUToNoSqlRU	Copy Job Type
sourceDetails	CosmosDBSourceSinkDetails		Source SQL DataStore details
tasks	NoSqlRUToNoSqlRUCopyJobTask[]		Copy Job tasks.

NoSqlRUToNoSqlRUCopyJobTask

Object

Name	Type	Description
destination	CosmosDBNoSqlContainer	Destination SQL container
processedCount	integer (int64)	Task level Processed Count.
source	CosmosDBNoSqlContainer	Source SQL container
totalCount	integer (int64)	Task level Total Count.