az cosmosdb dts
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
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-groupExamples
Cancel job j1
az cosmosdb dts cancel --account-name "ddb1" --job-name "j1" -g "rg1"Required Parameters
Name of the CosmosDB database account.
Name of the Data Transfer Job.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb dts copy
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=c2Copy 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=t2Copy 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=c2Required Parameters
Name of the CosmosDB database account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Destination cassandra table.
Usage: --dest-cassandra-table keyspace=XX table=XX' keyspace: Keyspace name of CosmosDB Cassandra. table: Table name of CosmosDB Cassandra.
Destination mongo collection.
Usage: --dest-mongo database=XX collection=XX' database: Database name of CosmosDB Mongo. collection: Collection name of CosmosDB Mongo.
Destination sql container.
Usage: --dest-sql-container database=XX container=XX' database: Database name of CosmosDB Sql. container: Container name of CosmosDB Sql.
Name of the Data Transfer Job. A random job name will be generated if not passed.
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 collection.
Usage: --source-mongo database=XX collection=XX' database: Database name of CosmosDB Mongo. collection: Collection name of CosmosDB Mongo.
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.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb dts list
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-groupExamples
List all jobs
az cosmosdb dts list --account-name "ddb1" -g "rg1"Required Parameters
Name of the CosmosDB database account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb dts pause
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-groupExamples
Pause job j1
az cosmosdb dts pause --account-name "ddb1" --job-name "j1" -g "rg1"Required Parameters
Name of the CosmosDB database account.
Name of the Data Transfer Job.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb dts resume
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-groupExamples
Resume job j1
az cosmosdb dts resume --account-name "ddb1" --job-name "j1" -g "rg1"Required Parameters
Name of the CosmosDB database account.
Name of the Data Transfer Job.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az cosmosdb dts show
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-groupExamples
Show details of job j1
az cosmosdb dts show --account-name "ddb1" --job-name "j1" -g "rg1"Required Parameters
Name of the CosmosDB database account.
Name of the Data Transfer Job.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for