Share via

az dms project task

  • Reference

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 tasks for an Azure Database Migration Service (classic) instance's project.

Commands

Name Description Type Status
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 task cancel

Edit

Cancel a task if it's currently queued or running.

az dms project task cancel --name
                           --project-name
                           --resource-group
                           --service-name

Required Parameters

--name -n

The name of the Task.

--project-name

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.

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 project task cancel (dms-preview extension)

This command is being deprecated. Use the stop command instead.

To keep a more consistent experience with Azure's portal UI use: az dms project task stop.

az dms project task cancel --name
                           --project-name
                           --resource-group
                           --service-name
                           [--object-name]

Required Parameters

--name -n

The name of the Task. A DMS Project Task is the activity that performs migration related work. There could be multiple Tasks associated with a Project.

--project-name

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.

--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. DMS Service is an Azure instance that performs database migrations.

Optional Parameters

--object-name

Supported by MongoDB migrations only. The qualified name of the database or collection you wish to stop. Leave blank to stop the entire migration.

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 project task check-name

Edit

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 check-name --name
                               --project-name
                               --resource-group
                               --service-name

Required Parameters

--name -n

The task name to check.

--project-name

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.

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 project task create

Edit

Create and start a migration task.

The following task configurations are supported: -) source -> target :: task type

  1. SQL -> SQLDB :: OfflineMigration
  2. PostgreSQL -> AzureDbForPostgreSql :: OnlineMigration
  3. MySQL -> AzureDbForMySQL :: OfflineMigration, OnlineMigration, ReplicateChanges.
az dms project task create --database-options-json
                           --name
                           --project-name
                           --resource-group
                           --service-name
                           --source-connection-json
                           --target-connection-json
                           [--enable-data-integrity-validation]
                           [--enable-query-analysis-validation]
                           [--enable-schema-validation]
                           [--task-type]

Examples

Create and start an offline SQL migration task. For a SQL migration, this will perform no validation checks.

az dms project task create --task-type OfflineMigration --database-options-json "C:\CLI Files\databaseOptions.json" -n mytask --project-name myproject -g myresourcegroup --service-name mydms --source-connection-json "{'dataSource': 'myserver', 'authentication': 'SqlAuthentication', 'encryptConnection': 'true', 'trustServerCertificate': 'true'}" --target-connection-json "C:\CLI Files\targetConnection.json"

Create and start a SQL task which performs all validation checks.

az dms project task create --task-type OfflineMigration --database-options-json "C:\CLI Files\databaseOptions.json" -n mytask --project-name myproject -g myresourcegroup --service-name mydms --source-connection-json "C:\CLI Files\sourceConnection.json" --target-connection-json "C:\CLI Files\targetConnection.json" --enable-data-integrity-validation --enable-query-analysis-validation --enable-schema-validation

Required Parameters

--database-options-json

Database and table information. This can be either a JSON-formatted string or the location to a file containing the JSON object. See example below for the format.

For SQL we support per table migrations. To use this, specify the tables names in the 'table_map' as below. You can also set the source as read only. [ { "name": "source database", "target_database_name": "target database", "make_source_db_read_only": false|true, "table_map": { "schema.SourceTableName1": "schema.TargetTableName1", "schema.SourceTableName2": "schema.TargetTableName2", ...n } }, ...n ]

For PostgreSQL, the format of the database options JSON object. [ { "name": "source database", "target_database_name": "target database", // Used for manipulating the underlying migration engine. // Only provide if instructed to do so or if you really know what you are doing. "migrationSetting": { "setting1": "value1", ...n }, // Used for manipulating the underlying migration engine. // Only provide if instructed to do so or if you really know what you are doing. "sourceSetting": { "setting1": "value1", ...n }, // Used for manipulating the underlying migration engine. // Only provide if instructed to do so or if you really know what you are doing. "targetSetting": { "setting1": "value1", ...n }, // Optional parameter to list tables that you want included in the migration. "selectedTables": [ "schemaName1.tableName1", ...n ] }, ...n ]

For MySQL, the format of the database options JSON object. { // Details of mapped schemas that needs to be migrated. Multiple schemas can be migrated at a time. "selected_databases":[ // database/schema 1 details { "name": "sourceSchema1", "target_database_name": "targetSchema1", // Table mapping from source to target schemas [Optional] // Don't add it if all tables of this database needs to be migrated "table_map": { "sourceSchema1.table1": "targetSchema1.table1", "sourceSchema1.table2": "targetSchema1.table2", "sourceSchema1.table3": "targetSchema1.table3", ..n } // the below items are only necessary for selective schema migration // optional, migrates schema for the following tables 'tables_to_migrate_schema': { "sourceSchema1.table2": "targetSchema1.table2", "sourceSchema1.table3": "targetSchema1.table3" }, // optional, migrates the enumerated views 'selected_views': [ 'sourceSchema1.view1' ], // optional, migrates the enumerated triggers 'selected_triggers': [ 'sourceSchema1.on_table1_updated' ], // optional, migrates the enumerated routines 'selected_routines': [ 'sourceSchema1.build_report' ], // optional, migrates the enumerated events 'selected_events': [ 'sourceSchema1.nightly_maintenance' ], // Optional. If true, DMS will migrate the source database schema to the target. "select_database_for_schema_migration": "true|false" }, ...n ],

// Used for manipulating the underlying migration engine. [Optional]
// Only provide if instructed to do so or if you really know what you are doing.
"migration_level_settings": {
    // Optional setting that configures the maximum number of parallel reads on tables located on the source database.
    "DesiredRangesCount": "4",
    // Optional setting that configures that size of the largest batch that will be committed to the target server.
    "MaxBatchSizeKb": "4096",
    // Optional setting that configures the minimum number of rows in each batch written to the target.
    "MinBatchRows": null,
    // Optional setting that configures the number of databases that will be prepared for migration in parallel.
    "PrepareDatabaseForBulkImportTaskCount": null,
    // Optional setting that configures the number of tables that will be prepared for migration in parallel.
    "PrepareTableForBulkImportTaskCount": null,
    // Optional setting that configures the number of threads available to read ranges on the source.
    "QueryTableDataRangeTaskCount": "8",
    // Optional setting that configures the number of threads available to write batches to the target.
    "WriteDataRangeBatchTaskCount": "12",
    // Optional setting that configures how much memory will be used to cache batches in memory before reads on the source are throttled.
    "MaxBatchCacheSizeMb": null,
    // Optional setting that configures the amount of available memory at which point reads on the source will be throttled.
    "ThrottleQueryTableDataRangeTaskAtAvailableMemoryMb": null,
    // Optional setting that configures the number of batches cached in memory that will trigger read throttling on the source.
    "ThrottleQueryTableDataRangeTaskAtBatchCount": 36,
    // Optional setting that configures the delay between updates of result objects in Azure Table Storage.
    "DelayProgressUpdatesInStorageInterval": "00:00:30",
},
// Optional setting to set the source server read only.
"make_source_server_read_only": "true|false",
// Optional setting to enable consistent backup. True by default for the sync migration, and false otherwise.
"enable_consistent_backup": "true|false",
// Optional. If true, all view definitions will be migrated in the selected databases.
"migrate_all_views": "true|false",
// Optional. If true, all trigger definitions will be migrated in the selected databases.
"migrate_all_triggers": "true|false",
// Optional. If true, all event definitions will be migrated in the selected databases.
"migrate_all_events": "true|false",
// Optional. If true, all stored proc definitions will be migrated in the selected databases.
"migrate_all_routines": "true|false",
// Optional. If true, all table's schemas will be migrated.
"migrate_all_tables_schema": "true|false",
// Optional. If true, all users/grants will be migrated.
"migrate_user_system_tables": "true|false",
// Binlog position to start the migration from. Only applicable for the ReplicateChanges migration.
"binLogInfo": {
    "filename": "binlog.0004523",
    "position": 283287
}

}.

--name -n

The name of the Task.

--project-name

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

The connection information to the source server. This can be either a JSON-formatted string or the location to a file containing the JSON object. See examples below for the format.

The format of the connection JSON object for SQL connections. { "userName": "user name", // if this is missing or null, you will be prompted "password": null, // if this is missing or null (highly recommended) you will be prompted "dataSource": "server name[,port]", "authentication": "SqlAuthentication|WindowsAuthentication", "encryptConnection": true, // highly recommended to leave as true "trustServerCertificate": false // highly recommended to leave as false }

The format of the connection JSON object for PostgreSQL connections. { "userName": "user name", // if this is missing or null, you will be prompted "password": null, // if this is missing or null (highly recommended) you will be prompted "serverName": "server name", "databaseName": "database name", // if this is missing, it will default to the 'postgres' database "port": 5432, // if this is missing, it will default to 5432 "encryptConnection": true, // highly recommended to leave as true "trustServerCertificate": false // highly recommended to leave as false }

The format of the connection JSON object for MySQL connections. { "userName": "user name", // if this is missing or null, you will be prompted "password": null, // if this is missing or null (highly recommended) you will be prompted "serverName": "server name", "port": 3306 // if this is missing, it will default to 3306 }.

--target-connection-json

The connection information to the target server. This can be either a JSON-formatted string or the location to a file containing the JSON object. See 'source-connection-json' for examples of connection formats.

Optional Parameters

--enable-data-integrity-validation

For SQL only. Whether to perform a checksum based data integrity validation between source and target for the selected database and tables.

Default value: False
--enable-query-analysis-validation

For SQL only. Whether to perform a quick and intelligent query analysis by retrieving queries from the source database and executing them in the target. The result will have execution statistics for executions in source and target databases for the extracted queries.

Default value: False
--enable-schema-validation

For SQL only. Whether to compare the schema information between source and target.

Default value: False
--task-type

The type of data movement the task will support. The supported types are: OnlineMigration, OfflineMigration. If not provided, will default to OfflineMigration for SQL, MySQL and OnlineMigration for PostgreSQL.

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 project task create (dms-preview extension)

Create and start a migration task.

The following task configurations are supported: -) source -> target :: task type 1) SQL -> SQLDB :: OfflineMigration 2) PostgreSQL -> AzureDbForPostgreSQL :: OnlineMigration 3) MongoDB -> MongoDB (for migrating to Cosmos DB via their MongoDB API) :: OfflineMigration.

az dms project task create --database-options-json
                           --name
                           --project-name
                           --resource-group
                           --service-name
                           --source-connection-json
                           --target-connection-json
                           [--enable-data-integrity-validation]
                           [--enable-query-analysis-validation]
                           [--enable-schema-validation]
                           [--task-type]
                           [--validate-only]
                           [--validated-task-name]

Examples

Create and start a SQL Task which performs no validation checks.

az dms project task create --database-options-json C:\CliFiles\databaseOptions.json -n mytask --project-name myproject -g myresourcegroup --service-name mydms --source-connection-json '{'dataSource': 'myserver', 'authentication': 'SqlAuthentication', 'encryptConnection': 'true', 'trustServerCertificate': 'true'}' --target-connection-json C:\CliFiles\targetConnection.json --task-type offlinemigration

Create and start a SQL Task which performs all validation checks.

az dms project task create --database-options-json C:\CliFiles\databaseOptions.json -n mytask --project-name myproject -g myresourcegroup --service-name mydms --source-connection-json C:\CliFiles\sourceConnection.json --target-connection-json C:\CliFiles\targetConnection.json --enable-data-integrity-validation --enable-query-analysis-validation --enable-schema-validation --task-type offlinemigration

Required Parameters

--database-options-json

Database and table information. This can be either a JSON-formatted string or the location to a file containing the JSON object. See examples below for the format.

For SQL we support per table migrations. To use this, specify the tables names in the 'table_map' as below. You can also set the source as read only. [ { "name": "source database", "target_database_name": "target database", "make_source_db_read_only": false|true, "table_map": { "schema.SourceTableName1": "schema.TargetTableName1", "schema.SourceTableName2": "schema.TargetTableName2", ...n } }, ...n ]

For PostgreSQL, the format of the database options JSON object. [ { "name": "source database", "target_database_name": "target database", // Used for manipulating the underlying migration engine. // Only provide if instructed to do so or if you really know what you are doing. "migrationSetting": { "setting1": "value1", ...n }, // Used for manipulating the underlying migration engine. // Only provide if instructed to do so or if you really know what you are doing. "sourceSetting": { "setting1": "value1", ...n }, // Used for manipulating the underlying migration engine. // Only provide if instructed to do so or if you really know what you are doing. "targetSetting": { "setting1": "value1", ...n }, // Optional parameter to list tables that you want included in the migration. "selectedTables": [ "schemaName1.tableName1", ...n ] }, ...n ]

For MongoDB we support per collection migrations. To use this, specify the collections inside the database object as below. { // set to zero to get the default boost during migration (recommended) "boostRUs": 0, // "OneTime" or "Continuous", only "OneTime" is currently supported "replication": "OneTime", // Set to null to use maximum resources available. "throttling": { // percentage of the CPU to try to avoid using "minFreeCpu": 25, // amount of RAM (in MBs) to try to avoid using "minFreeMemoryMb": 1024, // max number of collections to migrate at a time "maxParallelism": 2 }, "databases": { "database_name": { // see https://docs.microsoft.com/th-th/azure/cosmos-db/request-units, || // set to null to use default // or 0 if throughput should not be provisioned at the database level "targetRUs": 0, "collections": { "collection_name_1": { // Whether the target database/collection will be deleted if exists "canDelete": true, // set to null if target should not be sharded // or to copy the shard key from source (if exists) "shardKey": null, // set to null to use default (recommended) "targetRUs": null }, "collection_name_2": { "canDelete": true, "shardKey": { "fields": [ { "name": "field_name", // accepts "Forward", "Reverse", or "Hashed" but CosmosDB only accepts a single-field, hashed shard key "order": "Forward" }, ...n ], // whether shard key is unique // see https://docs.microsoft.com/azure/cosmos-db/partition-data "isUnique": false }, "targetRUs": 10000 }, ...n } }, ...n } }.

--name -n

The name of the Task. A DMS Project Task is the activity that performs migration related work. There could be multiple Tasks associated with a Project.

--project-name

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.

--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. DMS Service is an Azure instance that performs database migrations.

--source-connection-json

The connection information to the source server. This can be either a JSON-formatted string or the location to a file containing the JSON object. See examples below for the format.

The format of the connection JSON object for SQL connections. { "userName": "user name", // if this is missing or null, you will be prompted "password": null, // if this is missing or null (highly recommended) you will be prompted "dataSource": "server name[,port]", "authentication": "SqlAuthentication|WindowsAuthentication", "encryptConnection": true, // highly recommended to leave as true "trustServerCertificate": false // highly recommended to leave as false }

The format of the connection JSON object for PostgreSQL connections. { "userName": "user name", // if this is missing or null, you will be prompted "password": null, // if this is missing or null (highly recommended) you will be prompted "serverName": "server name", "databaseName": "database name", // if this is missing, it will default to the 'postgres' database "port": 5432, // if this is missing, it will default to 5432 "encryptConnection": true, // highly recommended to leave as true "trustServerCertificate": false // highly recommended to leave as false }

The format of the connection JSON object for MongoDB connections. { "userName": null, // if this is missing or null, you will be prompted "password": null, // if this is missing or null (highly recommended) you will be prompted "connectionString": "mongodb://hostOrIp:port" }.

--target-connection-json

The connection information to the target server. This can be either a JSON-formatted string or the location to a file containing the JSON object. See 'source-connection-json' for examples of connection formats.

Optional Parameters

--enable-data-integrity-validation

For SQL only. Whether to perform a checksum based data integrity validation between source and target for the selected database and tables.

Default value: False
--enable-query-analysis-validation

For SQL only. Whether to perform a quick and intelligent query analysis by retrieving queries from the source database and executing them in the target. The result will have execution statistics for executions in source and target databases for the extracted queries.

Default value: False
--enable-schema-validation

For SQL only. Whether to compare the schema information between source and target.

Default value: False
--task-type

The type of data movement the task will support. The supported types are: OnlineMigration, OfflineMigration. If not provided, will default to OfflineMigration for SQL, MongoDB and OnlineMigration for PostgreSQL.

--validate-only

For MongoDB to Cosmos DB only. Whether to run validation only and NOT run migration. It is mandatory to run a 'validate only' task before attempting an actual migration. Once the validation is complete, pass the name of this 'validate only' task to a new task's 'validated task name' argument.

Default value: False
--validated-task-name

(For MongoDB to Cosmos DB only) When running a migration it is neceaary to pass in the name of a previously run 'validate only' task.

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 project task cutover

Edit

For an online migration task, complete the migration by performing a cutover.

To see the result of the request, please use the 'task show' command: az dms project task show ... --expand command.

az dms project task cutover --name
                            --object-name
                            --project-name
                            --resource-group
                            --service-name

Required Parameters

--name -n

The name of the Task.

--object-name

The name of the database on the source you wish to cutover.

--project-name

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.

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

Edit

Delete a migration task.

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

Examples

Delete a migration task. (autogenerated)

az dms project task delete --name MyTask --project-name MyProject --resource-group MyResourceGroup --service-name MyService

Required Parameters

--name -n

The name of the Task.

--project-name

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

If the task is currently running, cancel the task before deleting the project.

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

Edit

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 list --project-name
                         --resource-group
                         --service-name
                         [--task-type]

Examples

List all tasks within a project.

az dms project task list --project-name myproject -g myresourcegroup --service-name mydms

List only the SQL to SQL migration tasks within a project.

az dms project task list --project-name myproject -g myresourcegroup --service-name mydms --task-type Migrate.SqlServer.SqlDb

Required Parameters

--project-name

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

--task-type

Filters the list by the type of task. For the list of possible types see "az dms check-status".

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 project task restart

Restart either the entire migration or just a specified object. Currently only supported by MongoDB migrations.

To see the result of the request, please use the 'task show' command: az dms project task show ... --expand command.

az dms project task restart --name
                            --project-name
                            --resource-group
                            --service-name
                            [--object-name]

Required Parameters

--name -n

The name of the Task. A DMS Project Task is the activity that performs migration related work. There could be multiple Tasks associated with a Project.

--project-name

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.

--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. DMS Service is an Azure instance that performs database migrations.

Optional Parameters

--object-name

The qualified name of the database or collection you wish to restart. Leave blank to restart the entire migration.

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 project task show

Edit

Show the details of a migration task. Use the "--expand" to get more details.

az dms project task show --name
                         --project-name
                         --resource-group
                         --service-name
                         [--expand]

Examples

Show the details of a migration task. Use the "--expand" to get more details. (autogenerated)

az dms project task show --name MyTask --project-name MyProject --resource-group MyResourceGroup --service-name MyService

Required Parameters

--name -n

The name of the Task.

--project-name

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

--expand

Expand the response to provide more details. Use with "command" to see more details of the task. Use with "output" to see the results of the task's migration.

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 project task stop

Stops the task, or stops migration on the specified object (MongoDB migrations only).

To see the result of the request, please use the 'task show' command: az dms project task show ... --expand command.

az dms project task stop --name
                         --project-name
                         --resource-group
                         --service-name
                         [--object-name]

Required Parameters

--name -n

The name of the Task. A DMS Project Task is the activity that performs migration related work. There could be multiple Tasks associated with a Project.

--project-name

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.

--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. DMS Service is an Azure instance that performs database migrations.

Optional Parameters

--object-name

Supported by MongoDB migrations only. The qualified name of the database or collection you wish to stop. Leave blank to stop the entire migration.

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.