Microsoft.DocumentDB databaseAccounts/dataTransferJobs 2024-09-01-preview
Bicep resource definition
The databaseAccounts/dataTransferJobs resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2024-09-01-preview' = {
parent: resourceSymbolicName
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:
{
collectionName: 'string'
component: 'CosmosDBMongo'
databaseName: 'string'
remoteAccountName: 'string'
}
For CosmosDBSql, use:
{
component: 'CosmosDBSql'
containerName: 'string'
databaseName: 'string'
remoteAccountName: 'string'
}
For CosmosDBMongoVCore, use:
{
collectionName: 'string'
component: 'CosmosDBMongoVCore'
connectionStringKeyVaultUri: 'string'
databaseName: 'string'
hostName: 'string'
}
Property values
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 |
|---|---|---|
| collectionName | string (required) | |
| component | 'CosmosDBMongo' (required) | |
| databaseName | string (required) | |
| remoteAccountName | string |
CosmosMongoVCoreDataTransferDataSourceSink
| Name | Description | Value |
|---|---|---|
| collectionName | string (required) | |
| component | 'CosmosDBMongoVCore' (required) | |
| connectionStringKeyVaultUri | string | |
| databaseName | string (required) | |
| hostName | string |
CosmosSqlDataTransferDataSourceSink
| Name | Description | Value |
|---|---|---|
| component | 'CosmosDBSql' (required) | |
| containerName | string (required) | |
| databaseName | string (required) | |
| remoteAccountName | string |
DataTransferDataSourceSink
| Name | Description | Value |
|---|---|---|
| component | Set to 'AzureBlobStorage' for type AzureBlobDataTransferDataSourceSink. Set to 'CosmosDBCassandra' for type CosmosCassandraDataTransferDataSourceSink. Set to 'CosmosDBMongo' for type CosmosMongoDataTransferDataSourceSink. Set to 'CosmosDBSql' for type CosmosSqlDataTransferDataSourceSink. Set to 'CosmosDBMongoVCore' for type CosmosMongoVCoreDataTransferDataSourceSink. | 'AzureBlobStorage' 'CosmosDBCassandra' 'CosmosDBMongo' 'CosmosDBMongoVCore' 'CosmosDBSql' (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 |
Microsoft.DocumentDB/databaseAccounts/dataTransferJobs
| Name | Description | Value |
|---|---|---|
| name | The resource name | 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) |
ARM template resource definition
The databaseAccounts/dataTransferJobs resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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-09-01-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:
{
"collectionName": "string",
"component": "CosmosDBMongo",
"databaseName": "string",
"remoteAccountName": "string"
}
For CosmosDBSql, use:
{
"component": "CosmosDBSql",
"containerName": "string",
"databaseName": "string",
"remoteAccountName": "string"
}
For CosmosDBMongoVCore, use:
{
"collectionName": "string",
"component": "CosmosDBMongoVCore",
"connectionStringKeyVaultUri": "string",
"databaseName": "string",
"hostName": "string"
}
Property values
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 |
|---|---|---|
| collectionName | string (required) | |
| component | 'CosmosDBMongo' (required) | |
| databaseName | string (required) | |
| remoteAccountName | string |
CosmosMongoVCoreDataTransferDataSourceSink
| Name | Description | Value |
|---|---|---|
| collectionName | string (required) | |
| component | 'CosmosDBMongoVCore' (required) | |
| connectionStringKeyVaultUri | string | |
| databaseName | string (required) | |
| hostName | string |
CosmosSqlDataTransferDataSourceSink
| Name | Description | Value |
|---|---|---|
| component | 'CosmosDBSql' (required) | |
| containerName | string (required) | |
| databaseName | string (required) | |
| remoteAccountName | string |
DataTransferDataSourceSink
| Name | Description | Value |
|---|---|---|
| component | Set to 'AzureBlobStorage' for type AzureBlobDataTransferDataSourceSink. Set to 'CosmosDBCassandra' for type CosmosCassandraDataTransferDataSourceSink. Set to 'CosmosDBMongo' for type CosmosMongoDataTransferDataSourceSink. Set to 'CosmosDBSql' for type CosmosSqlDataTransferDataSourceSink. Set to 'CosmosDBMongoVCore' for type CosmosMongoVCoreDataTransferDataSourceSink. | 'AzureBlobStorage' 'CosmosDBCassandra' 'CosmosDBMongo' 'CosmosDBMongoVCore' 'CosmosDBSql' (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 |
Microsoft.DocumentDB/databaseAccounts/dataTransferJobs
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-09-01-preview' |
| name | The resource name | string (required) |
| properties | Data Transfer Create Job Properties | DataTransferJobProperties (required) |
| type | The resource type | 'Microsoft.DocumentDB/databaseAccounts/dataTransferJobs' |
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@2024-09-01-preview"
name = "string"
body = jsonencode({
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:
{
collectionName = "string"
component = "CosmosDBMongo"
databaseName = "string"
remoteAccountName = "string"
}
For CosmosDBSql, use:
{
component = "CosmosDBSql"
containerName = "string"
databaseName = "string"
remoteAccountName = "string"
}
For CosmosDBMongoVCore, use:
{
collectionName = "string"
component = "CosmosDBMongoVCore"
connectionStringKeyVaultUri = "string"
databaseName = "string"
hostName = "string"
}
Property values
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 |
|---|---|---|
| collectionName | string (required) | |
| component | 'CosmosDBMongo' (required) | |
| databaseName | string (required) | |
| remoteAccountName | string |
CosmosMongoVCoreDataTransferDataSourceSink
| Name | Description | Value |
|---|---|---|
| collectionName | string (required) | |
| component | 'CosmosDBMongoVCore' (required) | |
| connectionStringKeyVaultUri | string | |
| databaseName | string (required) | |
| hostName | string |
CosmosSqlDataTransferDataSourceSink
| Name | Description | Value |
|---|---|---|
| component | 'CosmosDBSql' (required) | |
| containerName | string (required) | |
| databaseName | string (required) | |
| remoteAccountName | string |
DataTransferDataSourceSink
| Name | Description | Value |
|---|---|---|
| component | Set to 'AzureBlobStorage' for type AzureBlobDataTransferDataSourceSink. Set to 'CosmosDBCassandra' for type CosmosCassandraDataTransferDataSourceSink. Set to 'CosmosDBMongo' for type CosmosMongoDataTransferDataSourceSink. Set to 'CosmosDBSql' for type CosmosSqlDataTransferDataSourceSink. Set to 'CosmosDBMongoVCore' for type CosmosMongoVCoreDataTransferDataSourceSink. | 'AzureBlobStorage' 'CosmosDBCassandra' 'CosmosDBMongo' 'CosmosDBMongoVCore' 'CosmosDBSql' (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 |
Microsoft.DocumentDB/databaseAccounts/dataTransferJobs
| Name | Description | Value |
|---|---|---|
| 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) |
| type | The resource type | "Microsoft.DocumentDB/databaseAccounts/dataTransferJobs@2024-09-01-preview" |