az dms project

Manage Projects for an instance of the Data Migration Service.

Commands

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 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 check-name --name
--resource-group
--service-name
[--subscription]

Required Parameters

--name -n

The Project name to check.

--resource-group -g

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

--service-name

The name of the Service.

Optional Parameters

--subscription

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

az dms project create

Create a migration Project which can contain multiple Tasks.

az dms project create --location
--name
--resource-group
--service-name
--source-platform
--target-platform
[--subscription]
[--tags]

Examples

Create a Project for a DMS instance.

az dms project create -l westus -n myproject -g myresourcegroup --service-name mydms --source-platform SQL --target-platform SQLDB --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 Project.

--resource-group -g

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

--service-name

The name of the Service.

--source-platform

The type of server for the source database. The supported types are: SQL.

--target-platform

The type of service for the target database. The supported types are: SQLDB.

Optional Parameters

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

Delete a Project.

az dms project delete --name
--resource-group
--service-name
[--delete-running-tasks]
[--subscription]
[--yes]

Required Parameters

--name -n

The name of the Project.

--resource-group -g

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

--service-name

The name of the Service.

Optional Parameters

--delete-running-tasks

Cancel any running tasks before deleting the Project.

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

List the Projects within an instance of DMS.

az dms project list --resource-group
--service-name
[--subscription]

Required Parameters

--resource-group -g

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

--service-name

The name of the Service.

Optional Parameters

--subscription

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

az dms project show

Show the details of a migration Project.

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

Required Parameters

--name -n

The name of the Project.

--resource-group -g

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

--service-name

The name of the Service.

Optional Parameters

--subscription

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