az migrate runbook

Preview

Note

This reference is part of the migrate extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az migrate runbook command. Learn more about extensions.

Command group 'migrate' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage Azure Migrate runbooks.

Commands to generate and manage Azure Migrate runbooks and their executions. This command group is in preview and under active development; additional subgroups and commands are added incrementally.

To avoid repeating --resource-group/-g and --project-name/-p on every command, set defaults once. For example: az configure --defaults group=<rg> migrate_project=<name>. Once set, -g and -p can be omitted; an explicit flag always wins.

Commands

Name	Description	Type	Status
az migrate runbook definition	View and download the contents of a runbook definition.	Extension	Preview
az migrate runbook definition download	Download the runbook definition and documentation files.	Extension	Preview
az migrate runbook definition show	Show the definition (contents) of a runbook.	Extension	Preview
az migrate runbook definition step	Manage individual steps in a runbook definition.	Extension	Preview
az migrate runbook definition step-group	Manage step groups in a runbook definition.	Extension	Preview
az migrate runbook definition step-group merge	Merge two or more step groups into a single step group.	Extension	Preview
az migrate runbook definition step-group split	Split a step group into two step groups.	Extension	Preview
az migrate runbook definition step add	Add a step to the runbook definition.	Extension	Preview
az migrate runbook definition step remove	Remove a step from the runbook definition.	Extension	Preview
az migrate runbook definition step update	Update a step in the runbook definition.	Extension	Preview
az migrate runbook definition visualize	Render the runbook definition as a self-contained HTML page.	Extension	Preview
az migrate runbook delete	Delete a runbook.	Extension	Preview
az migrate runbook execution	Manage runbook executions.	Extension	Preview
az migrate runbook execution cancel	Cancel an in-progress or paused runbook execution.	Extension	Preview
az migrate runbook execution list	List the executions of a runbook.	Extension	Preview
az migrate runbook execution parameter	Download, upload, and configure an execution's input-parameters file.	Extension	Preview
az migrate runbook execution parameter configure	Generate an offline HTML editor for an execution's parameters.	Extension	Preview
az migrate runbook execution parameter download	Download an execution's parameters files.	Extension	Preview
az migrate runbook execution parameter upload	Upload an execution's input-parameters file.	Extension	Preview
az migrate runbook execution pause	Pause an in-progress runbook execution.	Extension	Preview
az migrate runbook execution resume	Resume a paused runbook execution.	Extension	Preview
az migrate runbook execution show	Show (or watch) the status of a runbook execution.	Extension	Preview
az migrate runbook execution start	Start a new execution of a runbook.	Extension	Preview
az migrate runbook execution step	Act on a single step within a runbook execution.	Extension	Preview
az migrate runbook execution step approve	Provide approval for an approval-type step during execution.	Extension	Preview
az migrate runbook execution step complete	Mark a manual step as complete during execution.	Extension	Preview
az migrate runbook execution step retry	Restart the execution of a failed step.	Extension	Preview
az migrate runbook execution visualize	Render an execution's status as a self-contained HTML graph.	Extension	Preview
az migrate runbook generate	Generate a runbook for a migration wave.	Extension	Preview
az migrate runbook list	List runbooks in a migrate project.	Extension	Preview
az migrate runbook parameter	Download, upload, and configure a runbook's parameters (inputs) file.	Extension	Preview
az migrate runbook parameter configure	Generate an offline HTML editor for the parameters file.	Extension	Preview
az migrate runbook parameter download	Download the runbook's parameters files.	Extension	Preview
az migrate runbook parameter upload	Upload a new parameters file and validate it.	Extension	Preview
az migrate runbook regenerate	Regenerate a runbook from its current scope.	Extension	Preview
az migrate runbook show	Get the details of a runbook.	Extension	Preview
az migrate runbook update	Update editable runbook metadata.	Extension	Preview
az migrate runbook wait	Wait until a runbook reaches a desired state.	Extension	Preview

az migrate runbook delete

Preview

Command group 'migrate runbook' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete a runbook.

az migrate runbook delete --name --runbook-name
                          --project-name
                          --resource-group
                          [--acquire-policy-token]
                          [--change-reference]
                          [--no-wait]
                          [--yes]

Examples

Delete a runbook.

az migrate runbook delete -g myRg --project-name myProject \
  -n myRunbook

Required Parameters

--name --runbook-name -n

Name of the runbook.

--project-name -p

Name of the Azure Migrate project. You can configure the default using az configure --defaults migrate_project=<name>.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az migrate runbook generate

Preview

Command group 'migrate runbook' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Generate a runbook for a migration wave.

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

Examples

Generate a runbook scoped to a wave.

az migrate runbook generate -g myRg --project-name myProject \
  -n myRunbook --wave-name myWave

Generate a runbook and return immediately.

az migrate runbook generate -g myRg --project-name myProject \
  -n myRunbook --wave-name myWave --no-wait

Required Parameters

--name --runbook-name -n

Name of the runbook.

--project-name -p

Name of the Azure Migrate project. You can configure the default using az configure --defaults migrate_project=<name>.

--resource-group -g

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

--wave-name

Name of the wave to generate the runbook from (required).

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-visualize

Do not open the runbook definition HTML view after the runbook is generated. Useful for automation and non-interactive environments.

Property	Value
Default value:	False

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az migrate runbook list

Preview

Command group 'migrate runbook' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List runbooks in a migrate project.

az migrate runbook list --project-name
                        --resource-group
                        [--status {Completed, Failed, Generating, InExecution, NotConfigured, Paused, ReadyToStart}]
                        [--wave-name]

Examples

List all runbooks in a project.

az migrate runbook list -g myRg --project-name myProject

List runbooks filtered by wave and status.

az migrate runbook list -g myRg --project-name myProject \
  --wave-name myWave --status InExecution

Required Parameters

--project-name -p

Name of the Azure Migrate project. You can configure the default using az configure --defaults migrate_project=<name>.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--status

Filter runbooks by lifecycle status.

Property	Value
Accepted values:	Completed, Failed, Generating, InExecution, NotConfigured, Paused, ReadyToStart

--wave-name

Filter runbooks by wave name.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az migrate runbook regenerate

Preview

Command group 'migrate runbook' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Regenerate a runbook from its current scope.

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

Examples

Regenerate a runbook.

az migrate runbook regenerate -g myRg \
  --project-name myProject -n myRunbook

Regenerate a runbook and return immediately.

az migrate runbook regenerate -g myRg \
  --project-name myProject -n myRunbook --no-wait

Required Parameters

--name --runbook-name -n

Name of the runbook.

--project-name -p

Name of the Azure Migrate project. You can configure the default using az configure --defaults migrate_project=<name>.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--no-visualize

Do not open the runbook definition HTML view after the runbook is regenerated. Useful for automation and non-interactive environments.

Property	Value
Default value:	False

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az migrate runbook show

Preview

Command group 'migrate runbook' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get the details of a runbook.

az migrate runbook show --name --runbook-name
                        --project-name
                        --resource-group

Examples

Show the details of a runbook.

az migrate runbook show -g myRg --project-name myProject \
  -n myRunbook

Required Parameters

--name --runbook-name -n

Name of the runbook.

--project-name -p

Name of the Azure Migrate project. You can configure the default using az configure --defaults migrate_project=<name>.

--resource-group -g

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az migrate runbook update

Preview

Command group 'migrate runbook' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Update editable runbook metadata.

az migrate runbook update --name --runbook-name
                          --project-name
                          --resource-group
                          [--acquire-policy-token]
                          [--change-reference]
                          [--description]

Examples

Update a runbook description.

az migrate runbook update -g myRg --project-name myProject \
  -n myRunbook --description "Wave 1 cutover runbook"

Required Parameters

--name --runbook-name -n

Name of the runbook.

--project-name -p

Name of the Azure Migrate project. You can configure the default using az configure --defaults migrate_project=<name>.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--description

Updated description for the runbook.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az migrate runbook wait

Preview

Command group 'migrate runbook' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Wait until a runbook reaches a desired state.

az migrate runbook wait --name --runbook-name
                        --project-name
                        --resource-group
                        [--acquire-policy-token]
                        [--change-reference]
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

Examples

Wait until execution completes.

az migrate runbook wait -g myRg --project-name myProject \
  -n myRunbook --custom "properties.state=='ExecutionSucceeded'"

Wait until the runbook exists.

az migrate runbook wait -g myRg --project-name myProject \
  -n myRunbook --created

Required Parameters

--name --runbook-name -n

Name of the runbook.

--project-name -p

Name of the Azure Migrate project. You can configure the default using az configure --defaults migrate_project=<name>.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--created

Wait until provisioningState reaches Succeeded.

Property	Value
Default value:	False

--custom

Wait until a JMESPath condition is met, e.g. "properties.state=='ExecutionSucceeded'".

--deleted

Wait until the runbook no longer exists.

Property	Value
Default value:	False

--exists

Wait until the runbook exists.

Property	Value
Default value:	False

--interval

Polling interval in seconds (default: 30).

Property	Value
Default value:	30

--timeout

Maximum wait time in seconds (default: 3600).

Property	Value
Default value:	3600

--updated

Wait until provisioningState reaches Succeeded after an update.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

Feedback

Was this page helpful?