Microsoft.DocumentDB databaseAccounts/dataTransferJobs

ARM template resource definition

The databaseAccounts/dataTransferJobs resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DocumentDB/databaseAccounts/dataTransferJobs resource, add the following JSON to your template.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs",
  "apiVersion": "2024-02-15-preview",
  "name": "string",
  "properties": {
    "destination": {
      "component": "string"
      // For remaining properties, see DataTransferDataSourceSink objects
    },
    "mode": "string",
    "source": {
      "component": "string"
      // For remaining properties, see DataTransferDataSourceSink objects
    },
    "workerCount": "int"
  }
}

DataTransferDataSourceSink objects

Set the component property to specify the type of object.

For AzureBlobStorage, use:

  "component": "AzureBlobStorage",
  "containerName": "string",
  "endpointUrl": "string"

For CosmosDBCassandra, use:

  "component": "CosmosDBCassandra",
  "keyspaceName": "string",
  "remoteAccountName": "string",
  "tableName": "string"

For CosmosDBMongo, use:

  "component": "CosmosDBMongo",
  "collectionName": "string",
  "databaseName": "string",
  "remoteAccountName": "string"

For CosmosDBSql, use:

  "component": "CosmosDBSql",
  "containerName": "string",
  "databaseName": "string",
  "remoteAccountName": "string"

Property values

databaseAccounts/dataTransferJobs

Name Description Value
type The resource type 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs'
apiVersion The resource api version '2024-02-15-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
properties Data Transfer Create Job Properties DataTransferJobProperties (required)

DataTransferJobProperties

Name Description Value
destination Destination DataStore details DataTransferDataSourceSink (required)
mode Mode of job execution 'Offline'
'Online'
source Source DataStore details DataTransferDataSourceSink (required)
workerCount Worker count int

Constraints:
Min value = 0

DataTransferDataSourceSink

Name Description Value
component Set the object type AzureBlobStorage
CosmosDBCassandra
CosmosDBMongo
CosmosDBSql (required)

AzureBlobDataTransferDataSourceSink

Name Description Value
component 'AzureBlobStorage' (required)
containerName string (required)
endpointUrl string

CosmosCassandraDataTransferDataSourceSink

Name Description Value
component 'CosmosDBCassandra' (required)
keyspaceName string (required)
remoteAccountName string
tableName string (required)

CosmosMongoDataTransferDataSourceSink

Name Description Value
component 'CosmosDBMongo' (required)
collectionName string (required)
databaseName string (required)
remoteAccountName string

CosmosSqlDataTransferDataSourceSink

Name Description Value
component 'CosmosDBSql' (required)
containerName string (required)
databaseName string (required)
remoteAccountName string