az dms

Manage Azure Data Migration Service (DMS) instances.

Commands

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-status Perform a health check and return the status of the service and virtual machine size.
az dms create Create an instance of the Data Migration Service.
az dms delete Delete an instance of the Data Migration Service.
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-skus List the SKUs that are supported by the Data Migration Service.
az dms project Manage Projects for an instance of the Data Migration Service.
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.
az dms project create Create a migration Project which can contain multiple Tasks.
az dms project delete Delete a Project.
az dms project list List the Projects within an instance of DMS.
az dms project show Show the details of a migration Project.
az dms project task Manage Tasks for a Data Migration Service instance's Project.
az dms project task cancel Cancel a Task if it's currently queued or running.
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.
az dms project task create Create and start a migration Task.
az dms project task delete Delete a migration Task.
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.
az dms project task show Show the details of a migration Task. Use the "--expand" to get more details.
az dms show Show the details for an instance of the Data Migration Service.
az dms start Start an instance of the Data Migration Service. It can then be used to run data migrations.
az dms stop Stop an instance of the Data Migration Service. While stopped, it can't be used to run data migrations and the owner won't be billed.
az dms wait Place the CLI in a waiting state until a condition of the DMS instance is met.

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
[--subscription]

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.

Optional Parameters

--subscription

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

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
[--subscription]

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

Optional Parameters

--subscription

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

az dms create

Create an instance of the Data Migration Service.

az dms create --location
--name
--resource-group
--sku-name
--subnet
[--no-wait]
[--subscription]
[--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.

--subscription

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

--tags

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

az dms delete

Delete an instance of the Data Migration Service.

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

Examples

Delete an instance of the Data Migration Service. (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.

--subscription

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

--yes -y

Do not prompt for confirmation.

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]
[--subscription]

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

--subscription

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

az dms list-skus

List the SKUs that are supported by the Data Migration Service.

az dms list-skus [--subscription]

Optional Parameters

--subscription

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

az dms show

Show the details for an instance of the Data Migration Service.

az dms show --name
--resource-group
[--subscription]

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

--subscription

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

az dms start

Start an instance of the Data Migration Service. It can then be used to run data migrations.

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

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.

--subscription

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

az dms stop

Stop an instance of the Data Migration Service. 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]
[--subscription]

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.

--subscription

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

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]
[--subscription]
[--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'.

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.