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.

Manage data transfer job with cosmosdb.

Commands

az cosmosdb dts cancel	Cancels a Data Transfer Job.
az cosmosdb dts copy	Creates a Data Transfer Copy Job.
az cosmosdb dts list	Get a list of Data Transfer Jobs.
az cosmosdb dts pause	Pause a Data Transfer Job.
az cosmosdb dts resume	Resumes a Data Transfer Job.
az cosmosdb dts show	Get a Data Transfer Job.

az cosmosdb dts cancel

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.

--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

Creates a Data Transfer Copy Job.

az cosmosdb dts copy --account-name
                     --resource-group
                     [--dest-cassandra-table]
                     [--dest-sql-container]
                     [--job-name]
                     [--source-cassandra-table]
                     [--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=k1 table=t1

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.

--dest-sql-container

Destination sql container.

--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.

--source-sql-container

Source sql container.

--worker-count

Worker count.

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.

--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

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.

--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

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.

--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

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.

--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

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.

--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.