az migrate runbook execution

Note

このリファレンスは、Azure CLI (バージョン 2.75.0 以降) の migrate 拡張機能の一部です。 拡張機能は、 az migrate Runbook 実行 コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

コマンド グループ 'Migrate Runbook' はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook の実行を管理します。

コマンド

Name	説明	型	状態
az migrate runbook execution cancel	進行中または一時停止中の Runbook の実行を取り消します。	拡張	Preview
az migrate runbook execution list	Runbook の実行を一覧表示します。	拡張	Preview
az migrate runbook execution parameter	実行の入力パラメーター ファイルをダウンロード、アップロード、および構成します。	拡張	Preview
az migrate runbook execution parameter configure	実行のパラメーターのオフライン HTML エディターを生成します。	拡張	Preview
az migrate runbook execution parameter download	実行のパラメーター ファイルをダウンロードします。	拡張	Preview
az migrate runbook execution parameter upload	実行の入力パラメーター ファイルをアップロードします。	拡張	Preview
az migrate runbook execution pause	進行中の Runbook の実行を一時停止します。	拡張	Preview
az migrate runbook execution resume	一時停止中の Runbook の実行を再開します。	拡張	Preview
az migrate runbook execution show	Runbook 実行の状態を表示 (または監視) します。	拡張	Preview
az migrate runbook execution start	Runbook の新しい実行を開始します。	拡張	Preview
az migrate runbook execution step	Runbook の実行内の 1 つの手順に基づいて操作します。	拡張	Preview
az migrate runbook execution step approve	実行中に承認の種類のステップの承認を提供します。	拡張	Preview
az migrate runbook execution step complete	実行中に手動ステップを完了としてマークします。	拡張	Preview
az migrate runbook execution step retry	失敗したステップの実行を再開します。	拡張	Preview
az migrate runbook execution visualize	実行の状態を自己完結型 HTML グラフとしてレンダリングします。	拡張	Preview

az migrate runbook execution cancel

プレビュー

コマンド グループ "Runbook の実行の移行" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

進行中または一時停止中の Runbook の実行を取り消します。

キャンセルはターミナルです。取り消された実行を再開できません。 代わりに新しい実行を開始します。

az migrate runbook execution cancel --execution-id
                                    --name --runbook-name
                                    --project-name
                                    --resource-group
                                    [--acquire-policy-token]
                                    [--change-reference]
                                    [--yes]

例

実行を取り消します。

az migrate runbook execution cancel -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

必須パラメーター

--execution-id

Runbook 実行の ID。

--name --runbook-name -n

Runbook の名前。

--project-name -p

Azure Migrate プロジェクトの名前。 既定値は、 az configure --defaults migrate_project=<name>を使用して構成できます。

--resource-group -g

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

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

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

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--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 migrate runbook execution list

プレビュー

コマンド グループ "Runbook の実行の移行" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook の実行を一覧表示します。

az migrate runbook execution list --name --runbook-name
                                  --project-name
                                  --resource-group

例

Runbook の実行を一覧表示します。

az migrate runbook execution list -g myRg \
  --project-name myProject --runbook-name myRunbook

必須パラメーター

--name --runbook-name -n

Runbook の名前。

--project-name -p

Azure Migrate プロジェクトの名前。 既定値は、 az configure --defaults migrate_project=<name>を使用して構成できます。

--resource-group -g

リソース グループの名前。 az configure --defaults group=<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 migrate runbook execution pause

プレビュー

コマンド グループ "Runbook の実行の移行" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

進行中の Runbook の実行を一時停止します。

az migrate runbook execution pause --execution-id
                                   --name --runbook-name
                                   --project-name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]

例

実行を一時停止します。

az migrate runbook execution pause -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

必須パラメーター

--execution-id

Runbook 実行の ID。

--name --runbook-name -n

Runbook の名前。

--project-name -p

Azure Migrate プロジェクトの名前。 既定値は、 az configure --defaults migrate_project=<name>を使用して構成できます。

--resource-group -g

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

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

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

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

グローバル パラメーター

--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 migrate runbook execution resume

プレビュー

コマンド グループ "Runbook の実行の移行" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

一時停止中の Runbook の実行を再開します。

az migrate runbook execution resume --execution-id
                                    --name --runbook-name
                                    --project-name
                                    --resource-group
                                    [--acquire-policy-token]
                                    [--change-reference]

例

実行を再開します。

az migrate runbook execution resume -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

必須パラメーター

--execution-id

Runbook 実行の ID。

--name --runbook-name -n

Runbook の名前。

--project-name -p

Azure Migrate プロジェクトの名前。 既定値は、 az configure --defaults migrate_project=<name>を使用して構成できます。

--resource-group -g

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

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

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

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

グローバル パラメーター

--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 migrate runbook execution show

プレビュー

コマンド グループ "Runbook の実行の移行" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook 実行の状態を表示 (または監視) します。

az migrate runbook execution show --execution-id
                                  --name --runbook-name
                                  --project-name
                                  --resource-group
                                  [--interval]
                                  [--step-id]
                                  [--watch]

例

実行の状態を表示します。

az migrate runbook execution show -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

1 つのステップの状態を表示します。

az migrate runbook execution show -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution --step-id step1

状態テーブルが完了するまで、状態テーブルを自動更新します。

az migrate runbook execution show -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution --watch

必須パラメーター

--execution-id

Runbook 実行の ID。

--name --runbook-name -n

Runbook の名前。

--project-name -p

Azure Migrate プロジェクトの名前。 既定値は、 az configure --defaults migrate_project=<name>を使用して構成できます。

--resource-group -g

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

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

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

--interval

--watch の更新間隔 (既定値: 60)。

プロパティ	値
規定値:	60

--step-id

出力を 1 つのステップに制限します。

--watch

実行が終了状態になるまで、一定の間隔で状態テーブルを再レンダリングします。

プロパティ	値
規定値:	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 migrate runbook execution start

プレビュー

コマンド グループ "Runbook の実行の移行" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

Runbook の新しい実行を開始します。

az migrate runbook execution start --name --runbook-name
                                   --project-name
                                   --resource-group
                                   [--acquire-policy-token]
                                   [--change-reference]
                                   [--no-visualize]
                                   [--no-wait]

例

Runbook の実行を開始します。

az migrate runbook execution start -g myRg \
  --project-name myProject --runbook-name myRunbook

完了を待たずに開始します。

az migrate runbook execution start -g myRg \
  --project-name myProject --runbook-name myRunbook --no-wait

必須パラメーター

--name --runbook-name -n

Runbook の名前。

--project-name -p

Azure Migrate プロジェクトの名前。 既定値は、 az configure --defaults migrate_project=<name>を使用して構成できます。

--resource-group -g

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

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

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

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--no-visualize

実行の開始後にライブ実行ウォッチ ビューを開かないでください。 オートメーション環境と非対話型環境に便利です。

プロパティ	値
規定値:	False

--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ	値
規定値:	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 migrate runbook execution visualize

プレビュー

コマンド グループ "Runbook の実行の移行" はプレビュー段階であり、開発中です。 参照レベルとサポート レベル: https://aka.ms/CLI_refstatus

実行の状態を自己完結型 HTML グラフとしてレンダリングします。

az migrate runbook execution visualize [--acquire-policy-token]
                                       [--change-reference]
                                       [--execution-id]
                                       [--file]
                                       [--from-file]
                                       [--interval]
                                       [--name --runbook-name]
                                       [--no-open]
                                       [--project-name]
                                       [--resource-group]
                                       [--watch]

例

実行の状態を視覚化します (ブラウザーで開きます)。

az migrate runbook execution visualize -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution

スナップショットが完了するまでの間隔でスナップショットを再生成します。

az migrate runbook execution visualize -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution --watch

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

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

--acquire-policy-token

このリソース操作のAzure Policy トークンを自動的に取得します。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--change-reference

このリソース操作の関連する変更参照 ID。

プロパティ	値
パラメーター グループ:	Global Policy Arguments

--execution-id

視覚化する Runbook 実行の ID。

--file

生成された HTML ファイルの出力パス (既定値: 現在のディレクトリ)。

--from-file

サービスからフェッチするのではなく、ローカルの実行状態の JSON ファイルからレンダリングします。

--interval

--watch の更新間隔 (既定値: 60)。

プロパティ	値
規定値:	60

--name --runbook-name -n

Runbook の名前。

--no-open

HTML ファイルを記述しますが、ブラウザーで開かないでください。

プロパティ	値
規定値:	False

--project-name -p

Azure Migrate プロジェクトの名前。 既定値は、 az configure --defaults migrate_project=<name>を使用して構成できます。

--resource-group -g

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

--watch

実行が終了状態になるまで、間隔を置き、HTML スナップショットを再生成します。

プロパティ	値
規定値:	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