Share via

Microsoft.DocumentDB databaseAccounts/dataTransferJobs 2023-03-01-preview

  • Article

Bicep 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 Bicep to your template.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    destination: {
      component: 'string'
      // For remaining properties, see DataTransferDataSourceSink objects
    }
    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'
  tableName: 'string'

For CosmosDBMongo, use:

  component: 'CosmosDBMongo'
  collectionName: 'string'
  databaseName: 'string'

For CosmosDBSql, use:

  component: 'CosmosDBSql'
  containerName: 'string'
  databaseName: 'string'

Property values

databaseAccounts/dataTransferJobs

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: databaseAccounts
properties Data Transfer Create Job Properties DataTransferJobProperties (required)

DataTransferJobProperties

Name Description Value
destination Destination DataStore details DataTransferDataSourceSink (required)
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)
tableName string (required)

CosmosMongoDataTransferDataSourceSink

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

CosmosSqlDataTransferDataSourceSink

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

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": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "destination": {
      "component": "string"
      // For remaining properties, see DataTransferDataSourceSink objects
    },
    "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",
  "tableName": "string"

For CosmosDBMongo, use:

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

For CosmosDBSql, use:

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

Property values

databaseAccounts/dataTransferJobs

Name Description Value
type The resource type 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs'
apiVersion The resource api version '2023-03-01-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)
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)
tableName string (required)

CosmosMongoDataTransferDataSourceSink

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

CosmosSqlDataTransferDataSourceSink

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

Terraform (AzAPI provider) resource definition

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

  • Resource groups

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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-03-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      destination = {
        component = "string"
        // For remaining properties, see DataTransferDataSourceSink objects
      }
      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"
  tableName = "string"

For CosmosDBMongo, use:

  component = "CosmosDBMongo"
  collectionName = "string"
  databaseName = "string"

For CosmosDBSql, use:

  component = "CosmosDBSql"
  containerName = "string"
  databaseName = "string"

Property values

databaseAccounts/dataTransferJobs

Name Description Value
type The resource type "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2023-03-01-preview"
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: databaseAccounts
properties Data Transfer Create Job Properties DataTransferJobProperties (required)

DataTransferJobProperties

Name Description Value
destination Destination DataStore details DataTransferDataSourceSink (required)
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)
tableName string (required)

CosmosMongoDataTransferDataSourceSink

Name Description Value
component "CosmosDBMongo" (required)
collectionName string (required)
databaseName string (required)

CosmosSqlDataTransferDataSourceSink

Name Description Value
component "CosmosDBSql" (required)
containerName string (required)
databaseName string (required)