az dms

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage Azure Data Migration Service (classic) instances.

Commands

Name	Description	Type	Status
az dms check-name	Check if a given DMS instance name is available in a given region as well as the name's validity.	Core	GA
az dms check-status	Perform a health check and return the status of the service and virtual machine size.	Core	GA
az dms create	Create an instance of the Azure Database Migration Service (classic).	Core	GA
az dms delete	Delete an instance of the Azure Database Migration Service (classic).	Core	GA
az dms list	List the DMS instances within your currently configured subscription (to set this use "az account set"). If provided, only show the instances within a given resource group.	Core	GA
az dms list-skus	List the SKUs that are supported by the Azure Database Migration Service (classic).	Core	GA
az dms project	Manage projects for an instance of the Azure Database Migration Service (classic).	Core and Extension	GA
az dms project check-name	Check if a given project name is available within a given instance of DMS as well as the name's validity.	Core	GA
az dms project create	Create a migration project which can contain multiple tasks.	Core	GA
az dms project create (dms-preview extension)	Create a migration project which can contain multiple tasks.	Extension	GA
az dms project delete	Delete a project.	Core	GA
az dms project list	List the projects within an instance of DMS.	Core	GA
az dms project show	Show the details of a migration project.	Core	GA
az dms project task	Manage tasks for a Azure Database Migration Service (classic) instance's project.	Core and Extension	GA
az dms project task cancel	Cancel a task if it's currently queued or running.	Core	GA
az dms project task cancel (dms-preview extension)	This command is being deprecated. Use the stop command instead.	Extension	GA
az dms project task check-name	Check if a given task name is available within a given instance of DMS as well as the name's validity.	Core	GA
az dms project task create	Create and start a migration task.	Core	GA
az dms project task create (dms-preview extension)	Create and start a migration task.	Extension	GA
az dms project task cutover	For an online migration task, complete the migration by performing a cutover.	Core	GA
az dms project task delete	Delete a migration task.	Core	GA
az dms project task list	List the tasks within a project. Some tasks may have a status of Unknown, which indicates that an error occurred while querying the status of that task.	Core	GA
az dms project task restart	Restart either the entire migration or just a specified object. Currently only supported by MongoDB migrations.	Extension	GA
az dms project task show	Show the details of a migration task. Use the "--expand" to get more details.	Core	GA
az dms project task stop	Stops the task, or stops migration on the specified object (MongoDB migrations only).	Extension	GA
az dms show	Show the details for an instance of the Azure Database Migration Service (classic).	Core	GA
az dms start	Start an instance of the Azure Database Migration Service (classic). It can then be used to run data migrations.	Core	GA
az dms stop	Stop an instance of the Azure Database Migration Service (classic). While stopped, it can't be used to run data migrations and the owner won't be billed.	Core	GA
az dms wait	Place the CLI in a waiting state until a condition of the DMS instance is met.	Core	GA

az dms check-name

Check if a given DMS instance name is available in a given region as well as the name's validity.

az dms check-name --location
                  --name

Examples

Check if a given DMS instance name is available in a given region as well as the name's validity. (autogenerated)

az dms check-name --location westus2 --name MyService

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

The service name to check.

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 dms check-status

Perform a health check and return the status of the service and virtual machine size.

az dms check-status --name
                    --resource-group

Examples

Perform a health check and return the status of the service and virtual machine size. (autogenerated)

az dms check-status --name MyService --resource-group MyResourceGroup

Required Parameters

--name -n

The name of the Service.

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

Create an instance of the Azure Database Migration Service (classic).

az dms create --location
              --name
              --resource-group
              --sku-name
              --subnet
              [--no-wait]
              [--tags]

Examples

Create an instance of DMS.

az dms create -l westus -n mydms -g myresourcegroup --sku-name Basic_2vCores --subnet /subscriptions/{vnetSubscriptionId}/resourceGroups/{vnetResourceGroup}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} --tags tagName1=tagValue1 tagWithNoValue

Required Parameters

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--name -n

The name of the Service.

--resource-group -g

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

--sku-name

The name of the CPU SKU on which the service's virtual machine will run. Check the name and the availability of SKUs in your area with "az dms list-skus".

--subnet

The Resource ID of the VNet's Subnet you will use to connect the source and target DBs. Use "az network vnet subnet show -h" for help to get your subnet's ID.

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--tags

A space-delimited list of tags in "tag1[=value1]" format.

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

Delete an instance of the Azure Database Migration Service (classic).

az dms delete --name
              --resource-group
              [--delete-running-tasks]
              [--no-wait]
              [--yes]

Examples

Delete an instance of the Azure Database Migration Service (classic). (autogenerated)

az dms delete --name MyService --resource-group MyResourceGroup

Required Parameters

--name -n

The name of the Service.

--resource-group -g

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

Optional Parameters

--delete-running-tasks

Cancel any running tasks before deleting the service.

--no-wait

Do not wait for the long-running operation to finish.

default value: False

--yes -y

Do not prompt for confirmation.

default value: False

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

List the DMS instances within your currently configured subscription (to set this use "az account set"). If provided, only show the instances within a given resource group.

az dms list [--resource-group]

Examples

List all the instances in your subscription.

az dms list

List all the instances in a given resource group.

az dms list -g myresourcegroup

Optional Parameters

--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 dms list-skus

List the SKUs that are supported by the Azure Database Migration Service (classic).

az dms list-skus

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

Show the details for an instance of the Azure Database Migration Service (classic).

az dms show --name
            --resource-group

Required Parameters

--name -n

The name of the Service.

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

Start an instance of the Azure Database Migration Service (classic). It can then be used to run data migrations.

az dms start --name
             --resource-group
             [--no-wait]

Examples

Start an instance of the Azure Database Migration Service (classic). It can then be used to run data migrations. (autogenerated)

az dms start --name MyService --resource-group MyResourceGroup

Required Parameters

--name -n

The name of the Service.

--resource-group -g

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

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

default value: False

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

Stop an instance of the Azure Database Migration Service (classic). While stopped, it can't be used to run data migrations and the owner won't be billed.

az dms stop --name
            --resource-group
            [--no-wait]

Required Parameters

--name -n

The name of the Service.

--resource-group -g

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

Optional Parameters

--no-wait

Do not wait for the long-running operation to finish.

default value: False

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

Place the CLI in a waiting state until a condition of the DMS instance is met.

az dms wait --name
            --resource-group
            [--created]
            [--custom]
            [--deleted]
            [--exists]
            [--interval]
            [--timeout]
            [--updated]

Required Parameters

--name -n

The name of the Service.

--resource-group -g

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

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False

--exists

Wait until the resource exists.

default value: False

--interval

Polling interval in seconds.

default value: 30

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

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.