az dms project task

Note

このコマンド グループには、Azure CLI と少なくとも 1 つの拡張機能の両方で定義されているコマンドがあります。 各拡張機能をインストールして、拡張機能を活用します。 拡張機能の詳細については、 を参照してください。

Azure Database Migration Service (クラシック) インスタンスのプロジェクトのタスクを管理します。

コマンド

名前	説明	型	状態
az dms project task cancel	タスクが現在キューに登録されているか実行中の場合は、タスクを取り消します。	Core	GA
az dms project task cancel (dms-preview 拡張機能)	このコマンドは非推奨です。 代わりに stop コマンドを使用してください。	Extension	GA
az dms project task check-name	指定されたタスク名が DMS の特定のインスタンス内で使用できるかどうかを確認し、名前の有効性を確認します。	Core	GA
az dms project task create	移行タスクを作成して開始します。	Core	GA
az dms project task create (dms-preview 拡張機能)	移行タスクを作成して開始します。	Extension	GA
az dms project task cutover	オンライン移行タスクの場合は、カットオーバーを実行して移行を完了します。	Core	GA
az dms project task delete	移行タスクを削除します。	Core	GA
az dms project task list	プロジェクト内のタスクを一覧表示します。 一部のタスクの状態が不明である場合があります。これは、そのタスクの状態のクエリ中にエラーが発生したことを示します。	Core	GA
az dms project task restart	移行全体または指定したオブジェクトのみを再起動します。 現在、MongoDB の移行でのみサポートされています。	Extension	GA
az dms project task show	移行タスクの詳細を表示します。 詳細を取得するには、"--expand" を使用します。	Core	GA
az dms project task stop	タスクを停止するか、指定したオブジェクトの移行を停止します (MongoDB の移行のみ)。	Extension	GA

az dms project task cancel

タスクが現在キューに登録されているか実行中の場合は、タスクを取り消します。

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

必須のパラメーター

--name -n

タスクの名前。

--project-name

プロジェクトの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name

サービスの名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az dms project task cancel (dms-preview 拡張機能)

このコマンドは非推奨です。 代わりに stop コマンドを使用してください。

Azure のポータル UI でのエクスペリエンスの一貫性を維持するには、az dms project task stop を使用します。

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

必須のパラメーター

--name -n

タスクの名前。 DMS プロジェクト タスクは、移行関連の作業を実行するアクティビティです。 1 つのプロジェクトに複数のタスクが関連付けられている可能性があります。

--project-name

プロジェクトの名前。 DMS プロジェクトは、ソース データベース接続、ターゲット データベース接続、移行するデータベースの一覧を含む論理グループです。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name

サービスの名前。 DMS サービスは、データベースの移行を実行する Azure インスタンスです。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--object-name

MongoDB 移行でのみサポートされます。 停止するデータベースまたはコレクションの修飾名。 移行全体を停止するには、空白のままにします。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az dms project task check-name

指定されたタスク名が DMS の特定のインスタンス内で使用できるかどうかを確認し、名前の有効性を確認します。

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

必須のパラメーター

--name -n

確認するタスク名。

--project-name

プロジェクトの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name

サービスの名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az dms project task create

移行タスクを作成して開始します。

次のタスク構成がサポートされています: -) ソース -> ターゲット:: タスクの種類

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]

例

オフライン SQL 移行タスクを作成して開始します。 SQL 移行の場合、検証チェックは実行されません。

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"

すべての検証チェックを実行する SQL タスクを作成して開始します。

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

必須のパラメーター

--database-options-json

データベースとテーブルの情報。 JSON 形式の文字列、または JSON オブジェクトを含むファイルの場所を指定できます。 形式については、以下の例を参照してください。

SQL では、テーブルごとの移行がサポートされます。 これを使用するには、次のように 'table_map' にテーブル名を指定します。 ソースを読み取り専用として設定することもできます。 [ { "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 ]

PostgreSQL の場合、データベース オプション JSON オブジェクトの形式。 [ { "name": "source database", "target_database_name": "target database", // 基になる移行エンジンの操作に使用されます。 指示された場合、または実際に何をしているかがわかっている場合にのみ提供します。 "migrationSetting": { "setting1": "value1", ...n }, // 基になる移行エンジンを操作するために使用されます。 指示された場合、または実際に何をしているかがわかっている場合にのみ提供します。 "sourceSetting": { "setting1": "value1", ...n }, // 基になる移行エンジンを操作するために使用されます。 指示された場合、または実際に何をしているかがわかっている場合にのみ提供します。 "targetSetting": { "setting1": "value1", ...n }, // 移行に含めるテーブルを一覧表示する省略可能なパラメーター。 "selectedTables": [ "schemaName1.tableName1", ...n ] }, ...n ]

MySQL の場合、データベース オプション JSON オブジェクトの形式。 { // 移行する必要があるマップされたスキーマの詳細。 一度に複数のスキーマを移行できます。 "selected_databases":[ // database/schema 1 details { "name": "sourceSchema1", "target_database_name": "targetSchema1", // ソーススキーマからターゲット スキーマへのテーブル マッピング [省略可能] // このデータベースのすべてのテーブルを "table_map": { "sourceSchema1.table1": "targetSchema1.table1", "sourceSchema1.table2": "targetSchema1.table2", "sourceSchema1.table3": "targetSchema1.table3", ..n } // 以下の項目は、選択的スキーマ移行 // オプションにのみ必要です。次のテーブル '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' ], // 省略可能, 列挙イベント 'selected_events': [ 'sourceSchema1.nightly_maintenance' ], // 省略可能。 true の場合、DMS はソース データベース スキーマをターゲットに移行します。 "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 migrate the full server.
"migrate_full_server": "true|false",
// 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, unless lockless is enabled.
"enable_consistent_backup": "true|false",
// Optional setting to enable lockless snapshot.
"enable_consistent_backup_without_locks": "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.
"binlog_info": {
    "filename": "binlog.0004523",
    "position": 283287
}

}.

--name -n

タスクの名前。

--project-name

プロジェクトの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name

サービスの名前。

--source-connection-json

ソース サーバーへの接続情報。 JSON 形式の文字列、または JSON オブジェクトを含むファイルの場所を指定できます。 形式については、以下の例を参照してください。

SQL 接続の接続 JSON オブジェクトの形式。 { "userName": "user name", // if this is missing or null, you will prompted "password": null, // if this is missing or null (highly recommended) you will prompted "dataSource": "server name[,port]", "authentication": "SqlAuthentication|WindowsAuthentication"、"encryptConnection": true、// true の "trustServerCertificate" として残すことを強くお勧めします: false // false のままにすることを強くお勧めします }

PostgreSQL の接続に対する接続 JSON オブジェクトの形式。 { "userName": "user name", // が見つからないか null の場合は、"password": null, // が表示されます。これが見つからない場合、または null (強くお勧めします)、"serverName": "serverName"、"databaseName":"database name"、// が見つからない場合、既定値は 'postgres' データベース "port": 5432、// (これが存在しない場合)、既定値は 5432 "encryptConnection" になります。 true、// true の "trustServerCertificate" のままにすることを強くお勧めします: false // false のままにすることを強くお勧めします }

MySQL 接続の接続 JSON オブジェクトの形式。 { "userName": "user name", // if this is missing or null, "password": null、 // が見つからない場合、または null (強くお勧めします) というメッセージが表示されます。"serverName"、"server name"、"port": 3306、// が見つからない場合、既定値は 3306 "encryptConnection": true、// true の "trustServerCertificate": false // のままにすることを強くお勧めします。

--target-connection-json

ターゲット サーバーへの接続情報。 JSON 形式の文字列、または JSON オブジェクトを含むファイルの場所を指定できます。 接続形式の例については、「source-connection-json」を参照してください。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--enable-data-integrity-validation

SQL の場合のみ。 選択したデータベースとテーブルのソースとターゲットの間でチェックサム ベースのデータ整合性検証を実行するかどうか。

プロパティ	値
規定値:	False

--enable-query-analysis-validation

SQL の場合のみ。 ソース データベースからクエリを取得し、ターゲットで実行することで、迅速かつインテリジェントなクエリ分析を実行するかどうか。 結果には、抽出されたクエリのソース データベースとターゲット データベースでの実行に関する実行統計が表示されます。

プロパティ	値
規定値:	False

--enable-schema-validation

SQL の場合のみ。 ソースとターゲットの間でスキーマ情報を比較するかどうか。

プロパティ	値
規定値:	False

--task-type

タスクがサポートするデータ移動の種類。 サポートされている種類は、OnlineMigration、OfflineMigration です。 指定しない場合、既定では SQL、MySQL、OnlineMigration for PostgreSQL が OfflineMigration になります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az dms project task create (dms-preview 拡張機能)

移行タスクを作成して開始します。

次のタスク構成がサポートされています。 -) source -> target :: task type 1) SQL -> SQLDB :: OfflineMigration 2) PostgreSQL -> AzureDbForPostgreSQL :: OnlineMigration 3) MongoDB -> MongoDB (MongoDB API 経由で Cosmos DB に移行する場合) :: 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]

例

検証チェックを実行しない SQL タスクを作成して開始します。

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

すべての検証チェックを実行する SQL タスクを作成して開始します。

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

必須のパラメーター

--database-options-json

データベースとテーブルの情報。 JSON 形式の文字列、または JSON オブジェクトを含むファイルの場所を指定できます。 形式については、以下の例を参照してください。

SQL では、テーブルごとの移行がサポートされます。 これを使用するには、次のように 'table_map' にテーブル名を指定します。 ソースを読み取り専用として設定することもできます。 [ { "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 ]

PostgreSQL の場合、データベース オプション JSON オブジェクトの形式。 [ { "name": "source database", "target_database_name": "target database", // 基になる移行エンジンの操作に使用されます。 指示された場合、または実際に何をしているかがわかっている場合にのみ提供します。 "migrationSetting": { "setting1": "value1", ...n }, // 基になる移行エンジンを操作するために使用されます。 指示された場合、または実際に何をしているかがわかっている場合にのみ提供します。 "sourceSetting": { "setting1": "value1", ...n }, // 基になる移行エンジンを操作するために使用されます。 指示された場合、または実際に何をしているかがわかっている場合にのみ提供します。 "targetSetting": { "setting1": "value1", ...n }, // 移行に含めるテーブルを一覧表示する省略可能なパラメーター。 "selectedTables": [ "schemaName1.tableName1", ...n ] }, ...n ]

MongoDB では、コレクションごとの移行がサポートされます。 これを使用するには、次のようにデータベース オブジェクト内のコレクションを指定します。 { // 移行中に既定のブーストを取得するには 0 に設定します (推奨) "boost RU": 0、// "OneTime" または "Continuous"、現在サポートされているのは "レプリケーション" "OneTime"、// 使用可能な最大リソースを使用する場合は "OneTime" のみ。// null に設定します。 "throttling": { // "minFreeCpu" の使用を回避しようとする CPU の割合: 25, // "minFreeMemoryMb": 1024,// 一度に移行するコレクションの最大数 "maxParallelism": 2 }, "databases": { "database_name": { // see https://docs.microsoft.com/th-th/azure/cosmos-db/request-units, || // set to null for use default // or 0 if throughput should be be provisioned at the database level "targetRUs": 0, "collections": { "collection_name_1": { // ターゲット データベース/コレクションが存在する場合に削除されるかどうか "canDelete": true, // ターゲットをシャード化しない場合は null に設定するか、ソースからシャード キーをコピーする (存在する場合) "shardKey": null、// を null に設定して、既定 (推奨) "targetRUs": null }、"collection_name_2": { "canDelete": true、 "shardKey": { "fields": [ { "name": "field_name"、 は "Forward"、"Reverse"、または "Hashed" を受け入れますが、CosmosDB は単一フィールドのハッシュされたシャード キー "order": "Forward" }, ... のみを受け入れます。n ]、// シャード キーが一意かどうか // "isUnique": false }、"target RU": 10000 }、... https://docs.microsoft.com/azure/cosmos-db/partition-data 参照してください。n } }, ...n } }.

--name -n

タスクの名前。 DMS プロジェクト タスクは、移行関連の作業を実行するアクティビティです。 1 つのプロジェクトに複数のタスクが関連付けられている可能性があります。

--project-name

プロジェクトの名前。 DMS プロジェクトは、ソース データベース接続、ターゲット データベース接続、移行するデータベースの一覧を含む論理グループです。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name

サービスの名前。 DMS サービスは、データベースの移行を実行する Azure インスタンスです。

--source-connection-json

ソース サーバーへの接続情報。 JSON 形式の文字列、または JSON オブジェクトを含むファイルの場所を指定できます。 形式については、以下の例を参照してください。

SQL 接続の接続 JSON オブジェクトの形式。 { "userName": "user name", // if this is missing or null, you will prompted "password": null, // if this is missing or null (highly recommended) you will prompted "dataSource": "server name[,port]", "authentication": "SqlAuthentication|WindowsAuthentication"、"encryptConnection": true、// true の "trustServerCertificate" として残すことを強くお勧めします: false // false のままにすることを強くお勧めします }

PostgreSQL の接続に対する接続 JSON オブジェクトの形式。 { "userName": "user name", // が見つからないか null の場合は、"password": null, // が表示されます。これが見つからない場合、または null (強くお勧めします)、"serverName": "serverName"、"databaseName":"database name"、// が見つからない場合、既定値は 'postgres' データベース "port": 5432、// (これが存在しない場合)、既定値は 5432 "encryptConnection" になります。 true、// true の "trustServerCertificate" のままにすることを強くお勧めします: false // false のままにすることを強くお勧めします }

MongoDB 接続の接続 JSON オブジェクトの形式。 { "userName": null, // if this is missing or null, you will prompted "password": null, // if this is missing or null (highly recommended) you will prompted "connectionString": "mongodb://hostOrIp:port" }.

--target-connection-json

ターゲット サーバーへの接続情報。 JSON 形式の文字列、または JSON オブジェクトを含むファイルの場所を指定できます。 接続形式の例については、「source-connection-json」を参照してください。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--enable-data-integrity-validation

SQL の場合のみ。 選択したデータベースとテーブルのソースとターゲットの間でチェックサム ベースのデータ整合性検証を実行するかどうか。

プロパティ	値
規定値:	False

--enable-query-analysis-validation

SQL の場合のみ。 ソース データベースからクエリを取得し、ターゲットで実行することで、迅速かつインテリジェントなクエリ分析を実行するかどうか。 結果には、抽出されたクエリのソース データベースとターゲット データベースでの実行に関する実行統計が表示されます。

プロパティ	値
規定値:	False

--enable-schema-validation

SQL の場合のみ。 ソースとターゲットの間でスキーマ情報を比較するかどうか。

プロパティ	値
規定値:	False

--task-type

タスクがサポートするデータ移動の種類。 サポートされている種類は、OnlineMigration、OfflineMigration です。 指定しない場合、既定では SQL、MongoDB、OnlineMigration for PostgreSQL が OfflineMigration になります。

--validate-only

MongoDB から Cosmos DB へのみ。 検証のみを実行し、移行を実行するかどうかを指定します。 実際の移行を試みる前に、"検証のみ" タスクを実行する必要があります。 検証が完了したら、この 'validate only' タスクの名前を新しいタスクの 'validated task name' 引数に渡します。

プロパティ	値
規定値:	False

--validated-task-name

(MongoDB から Cosmos DB への場合のみ)移行を実行するときは、以前に実行した "検証のみ" タスクの名前を渡す必要があります。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az dms project task cutover

オンライン移行タスクの場合は、カットオーバーを実行して移行を完了します。

要求の結果を表示するには、'task show' コマンドを使用してください。 az dms project task show ... --expand コマンド。

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

必須のパラメーター

--name -n

タスクの名前。

--object-name

カットオーバーするソース上のデータベースの名前。

--project-name

プロジェクトの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name

サービスの名前。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az dms project task delete

移行タスクを削除します。

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

例

移行タスクを削除します。 (autogenerated)

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

必須のパラメーター

--name -n

タスクの名前。

--project-name

プロジェクトの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name

サービスの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--delete-running-tasks

タスクが現在実行中の場合は、プロジェクトを削除する前にタスクを取り消します。

--yes -y

確認を求めないでください。

プロパティ	値
規定値:	False

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az dms project task list

プロジェクト内のタスクを一覧表示します。 一部のタスクの状態が不明である場合があります。これは、そのタスクの状態のクエリ中にエラーが発生したことを示します。

az dms project task list --project-name
                         --resource-group
                         --service-name
                         [--task-type]

例

プロジェクト内のすべてのタスクを一覧表示します。

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

プロジェクト内の SQL から SQL への移行タスクのみを一覧表示します。

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

必須のパラメーター

--project-name

プロジェクトの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name

サービスの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--task-type

タスクの種類で一覧をフィルター処理します。 使用可能な型の一覧については、「az dms check-status」を参照してください。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az dms project task restart

移行全体または指定したオブジェクトのみを再起動します。 現在、MongoDB の移行でのみサポートされています。

要求の結果を表示するには、'task show' コマンドを使用してください。 az dms project task show ... --expand コマンド。

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

必須のパラメーター

--name -n

タスクの名前。 DMS プロジェクト タスクは、移行関連の作業を実行するアクティビティです。 1 つのプロジェクトに複数のタスクが関連付けられている可能性があります。

--project-name

プロジェクトの名前。 DMS プロジェクトは、ソース データベース接続、ターゲット データベース接続、移行するデータベースの一覧を含む論理グループです。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name

サービスの名前。 DMS サービスは、データベースの移行を実行する Azure インスタンスです。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--object-name

再起動するデータベースまたはコレクションの修飾名。 移行全体を再開するには、空白のままにします。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az dms project task show

移行タスクの詳細を表示します。 詳細を取得するには、"--expand" を使用します。

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

例

移行タスクの詳細を表示します。 詳細を取得するには、"--expand" を使用します。 (autogenerated)

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

必須のパラメーター

--name -n

タスクの名前。

--project-name

プロジェクトの名前。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name

サービスの名前。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--expand

応答を展開して詳細を指定します。 タスクの詳細を表示するには、"command" と共に使用します。 "output" と共に使用して、タスクの移行の結果を確認します。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False

az dms project task stop

タスクを停止するか、指定したオブジェクトの移行を停止します (MongoDB の移行のみ)。

要求の結果を表示するには、'task show' コマンドを使用してください。 az dms project task show ... --expand コマンド。

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

必須のパラメーター

--name -n

タスクの名前。 DMS プロジェクト タスクは、移行関連の作業を実行するアクティビティです。 1 つのプロジェクトに複数のタスクが関連付けられている可能性があります。

--project-name

プロジェクトの名前。 DMS プロジェクトは、ソース データベース接続、ターゲット データベース接続、移行するデータベースの一覧を含む論理グループです。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--service-name

サービスの名前。 DMS サービスは、データベースの移行を実行する Azure インスタンスです。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--object-name

MongoDB 移行でのみサポートされます。 停止するデータベースまたはコレクションの修飾名。 移行全体を停止するには、空白のままにします。

グローバル パラメーター

--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ	値
規定値:	False

--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ	値
規定値:	False

--output -o

出力フォーマット。

プロパティ	値
規定値:	json
指定可能な値:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ	値
規定値:	False