Share via

az cosmosdb dts

  • Preview
  • Deprecated
  • Reference

Note

This reference is part of the cosmosdb-preview extension for the Azure CLI (version 2.17.1 or higher). The extension will automatically install the first time you run an az cosmosdb dts command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command group has been deprecated and will be removed in a future release. Use 'cosmosdb copy' instead.

Manage data transfer job with cosmosdb.

Commands

Name Description Type Status
az cosmosdb dts cancel

Cancels a Data Transfer Job.

 Extension Preview and Deprecated
az cosmosdb dts copy

Creates a Data Transfer Copy Job.

 Extension Preview and Deprecated
az cosmosdb dts list

Get a list of Data Transfer Jobs.

 Extension Preview and Deprecated
az cosmosdb dts pause

Pause a Data Transfer Job.

 Extension Preview and Deprecated
az cosmosdb dts resume

Resumes a Data Transfer Job.

 Extension Preview and Deprecated
az cosmosdb dts show

Get a Data Transfer Job.

 Extension Preview and Deprecated

az cosmosdb dts cancel

Preview Deprecated

Command group 'cosmosdb dts' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command is implicitly deprecated because command group 'cosmosdb dts' is deprecated and will be removed in a future release. Use 'cosmosdb copy' instead.

Cancels a Data Transfer Job.

az cosmosdb dts cancel --account-name
                       --job-name
                       --resource-group

Examples

Cancel job j1

az cosmosdb dts cancel --account-name "ddb1" --job-name "j1" -g "rg1"

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--job-name -n

Name of the Data Transfer Job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb dts copy

Preview Deprecated

Command group 'cosmosdb dts' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command is implicitly deprecated because command group 'cosmosdb dts' is deprecated and will be removed in a future release. Use 'cosmosdb copy' instead.

Creates a Data Transfer Copy Job.

az cosmosdb dts copy --account-name
                     --resource-group
                     [--dest-cassandra-table]
                     [--dest-mongo]
                     [--dest-sql-container]
                     [--job-name]
                     [--source-cassandra-table]
                     [--source-mongo]
                     [--source-sql-container]
                     [--worker-count]

Examples

Copy sql container

az cosmosdb dts copy -g "rg1" --job-name "j1" --account-name "db1" --source-sql-container database=db1 container=c1 --dest-sql-container database=db2 container=c2

Copy cassandra table

az cosmosdb dts copy -g "rg1" --job-name "j1" --account-name "db1" --source-cassandra-table keyspace=k1 table=t1 --dest-cassandra-table keyspace=k2 table=t2

Copy mongo collection

az cosmosdb dts copy -g "rg1" --job-name "j1" --account-name "db1" --source-mongo database=d1 collection=c1 --dest-mongo database=d2 collection=c2

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

--dest-cassandra-table

Destination cassandra table.

Usage: --dest-cassandra-table keyspace=XX table=XX' keyspace: Keyspace name of CosmosDB Cassandra. table: Table name of CosmosDB Cassandra.

--dest-mongo

Destination mongo collection.

Usage: --dest-mongo database=XX collection=XX' database: Database name of CosmosDB Mongo. collection: Collection name of CosmosDB Mongo.

--dest-sql-container

Destination sql container.

Usage: --dest-sql-container database=XX container=XX' database: Database name of CosmosDB Sql. container: Container name of CosmosDB Sql.

--job-name -n

Name of the Data Transfer Job. A random job name will be generated if not passed.

--source-cassandra-table

Source cassandra table.

Usage: --source-cassandra-table keyspace=XX table=XX' keyspace: Keyspace name of CosmosDB Cassandra. table: Table name of CosmosDB Cassandra.

--source-mongo

Source mongo collection.

Usage: --source-mongo database=XX collection=XX' database: Database name of CosmosDB Mongo. collection: Collection name of CosmosDB Mongo.

--source-sql-container

Source sql container.

Usage: --source-sql-container database=XX container=XX' database: Database name of CosmosDB Sql. container: Container name of CosmosDB Sql.

--worker-count

Worker count.

Default value: 0
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb dts list

Preview Deprecated

Command group 'cosmosdb dts' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command is implicitly deprecated because command group 'cosmosdb dts' is deprecated and will be removed in a future release. Use 'cosmosdb copy' instead.

Get a list of Data Transfer Jobs.

az cosmosdb dts list --account-name
                     --resource-group

Examples

List all jobs

az cosmosdb dts list --account-name "ddb1" -g "rg1"

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb dts pause

Preview Deprecated

Command group 'cosmosdb dts' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command is implicitly deprecated because command group 'cosmosdb dts' is deprecated and will be removed in a future release. Use 'cosmosdb copy' instead.

Pause a Data Transfer Job.

az cosmosdb dts pause --account-name
                      --job-name
                      --resource-group

Examples

Pause job j1

az cosmosdb dts pause --account-name "ddb1" --job-name "j1" -g "rg1"

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--job-name -n

Name of the Data Transfer Job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb dts resume

Preview Deprecated

Command group 'cosmosdb dts' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command is implicitly deprecated because command group 'cosmosdb dts' is deprecated and will be removed in a future release. Use 'cosmosdb copy' instead.

Resumes a Data Transfer Job.

az cosmosdb dts resume --account-name
                       --job-name
                       --resource-group

Examples

Resume job j1

az cosmosdb dts resume --account-name "ddb1" --job-name "j1" -g "rg1"

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--job-name -n

Name of the Data Transfer Job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az cosmosdb dts show

Preview Deprecated

Command group 'cosmosdb dts' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

This command is implicitly deprecated because command group 'cosmosdb dts' is deprecated and will be removed in a future release. Use 'cosmosdb copy' instead.

Get a Data Transfer Job.

az cosmosdb dts show --account-name
                     --job-name
                     --resource-group

Examples

Show details of job j1

az cosmosdb dts show --account-name "ddb1" --job-name "j1" -g "rg1"

Required Parameters

--account-name -a

Name of the CosmosDB database account.

--job-name -n

Name of the Data Transfer Job.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.