az dms project
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 projects for an instance of the Azure Database Migration Service (classic).
Commands
Name | Description | Type | Status |
---|---|---|---|
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 an 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 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
Required Parameters
The project name to check.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Service.
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 dms project create
Create a migration project which can contain multiple tasks.
The following project configurations are supported: -) source -> target
- SQL -> SQLDB
- PostgreSQL -> AzureDbForPostgreSQL
- MySQL -> AzureDbForMySQL.
az dms project create --location
--name
--resource-group
--service-name
--source-platform
--target-platform
[--tags]
Examples
Create a SQL to SQLDB project for a DMS instance.
az dms project create -l westus -n sqlproject -g myresourcegroup --service-name mydms --source-platform SQL --target-platform SQLDB --tags tagName1=tagValue1 tagWithNoValue
Create a PostgreSql to AzureDbForPostgreSql project for a DMS instance.
az dms project create -l westus -n pgproject -g myresourcegroup --service-name mydms --source-platform PostgreSQL --target-platform AzureDbForPostgreSQL --tags tagName1=tagValue1 tagWithNoValue
Create a MySQL to AzureDbForMySQL project for a DMS instance.
az dms project create -l westus -n mysqlproject -g myresourcegroup --service-name mydms --source-platform MySQL --target-platform AzureDbForMySQL --tags tagName1=tagValue1 tagWithNoValue
Required Parameters
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
The name of the Project.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Service.
The type of server for the source database. The supported types are: SQL, PostgreSQL, MySQL.
The type of service for the target database. The supported types are: SQLDB, AzureDbForPostgreSQL, AzureDbForMySQL.
Optional Parameters
A space-delimited list of tags in "tag1[=value1]" format.
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 dms project create (dms-preview extension)
Create a migration project which can contain multiple tasks.
The following project configurations are supported: -) source -> target 1) SQL -> SQLDB 2) PostgreSQL -> AzureDbForPostgreSQL 3) MongoDB -> MongoDB (for migrating to Cosmos DB via their MongoDB API).
az dms project create --location
--name
--resource-group
--service-name
--source-platform
--target-platform
[--tags]
Examples
Create a SQL to SQLDB project for a DMS instance.
az dms project create -l westus -n sqlproject -g myresourcegroup --service-name mydms --source-platform SQL --target-platform SQLDB --tags tagName1=tagValue1 tagWithNoValue
Create a PostgreSql to AzureDbForPostgreSql project for a DMS instance.
az dms project create -l westus -n pgproject -g myresourcegroup --service-name mydms --source-platform PostgreSQL --target-platform AzureDbForPostgreSQL --tags tagName1=tagValue1 tagWithNoValue
Required Parameters
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
The name of the Project. DMS Project is a logical grouping that encompasses source database connection, target database connection and a list of databases to migrate.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Service. DMS Service is an Azure instance that performs database migrations.
The type of server for the source database. The supported types are: SQL, PostgreSQL, MongoDB.
The type of service for the target database. The supported types are: SQLDB, AzureDbForPostgreSQL, MongoDB.
Optional Parameters
A space-delimited list of tags in tag1[=value1]" format.
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 dms project delete
Delete a project.
az dms project delete --name
--resource-group
--service-name
[--delete-running-tasks]
[--yes]
Examples
Delete a project. (autogenerated)
az dms project delete --name MyProject --resource-group MyResourceGroup --service-name MyService
Required Parameters
The name of the Project.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Service.
Optional Parameters
Cancel any running tasks before deleting the project.
Do not prompt for confirmation.
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 dms project list
List the projects within an instance of DMS.
az dms project list --resource-group
--service-name
Examples
List the projects within an instance of DMS. (autogenerated)
az dms project list --resource-group MyResourceGroup --service-name MyService
Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Service.
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 dms project show
Show the details of a migration project.
az dms project show --name
--resource-group
--service-name
Examples
Show the details of a migration project. (autogenerated)
az dms project show --name MyProject --resource-group MyResourceGroup --service-name MyService
Required Parameters
The name of the Project.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
The name of the Service.
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.