az migrate runbook execution

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 execution command. Learn more about extensions.

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

Manage runbook executions.

Commands

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

Preview

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

Cancel an in-progress or paused runbook execution.

Cancellation is terminal; a cancelled execution cannot be resumed. Start a new execution instead.

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

Examples

Cancel an execution.

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

Required Parameters

--execution-id

Id of the runbook execution.

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

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

Preview

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

List the executions of a runbook.

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

Examples

List a runbook's executions.

az migrate runbook execution list -g myRg \
  --project-name myProject --runbook-name 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 execution pause

Preview

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

Pause an in-progress runbook execution.

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

Examples

Pause an execution.

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

Required Parameters

--execution-id

Id of the runbook execution.

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

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

Preview

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

Resume a paused runbook execution.

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

Examples

Resume an execution.

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

Required Parameters

--execution-id

Id of the runbook execution.

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

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

Preview

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

Show (or watch) the status of a runbook execution.

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

Examples

Show an execution's status.

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

Show the status of a single step.

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

Auto-refresh the status table until it completes.

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

Required Parameters

--execution-id

Id of the runbook execution.

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

--interval

Refresh interval in seconds for --watch (default: 60).

Property	Value
Default value:	60

--step-id

Limit the output to a single step.

--watch

Re-render the status table on an interval until the execution reaches a terminal state.

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 execution start

Preview

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

Start a new execution of a runbook.

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

Examples

Start a runbook execution.

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

Start without waiting for completion.

az migrate runbook execution start -g myRg \
  --project-name myProject --runbook-name 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 live execution watch view after the execution starts. 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 execution visualize

Preview

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

Render an execution's status as a self-contained HTML graph.

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]

Examples

Visualize an execution's status (opens in the browser).

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

Regenerate the snapshot on an interval until it completes.

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

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

--execution-id

Id of the runbook execution to visualize.

--file

Output path for the generated HTML file (default: current directory).

--from-file

Render from a local execution status JSON file instead of fetching from the service.

--interval

Refresh interval in seconds for --watch (default: 60).

Property	Value
Default value:	60

--name --runbook-name -n

Name of the runbook.

--no-open

Write the HTML file but do not open it in a browser.

Property	Value
Default value:	False

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

--watch

Regenerate the HTML snapshot on an interval until the execution reaches a terminal state.

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?