az migrate runbook execution step

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

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

Act on a single step within a runbook execution.

Commands

Name	Description	Type	Status
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 step approve

Preview

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

Provide approval for an approval-type step during execution.

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

Examples

Approve a Full approval step.

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

Approve specific ready entities for a Partial approval step.

az migrate runbook execution step approve -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution --step-id step1 \
  --entities vm1 vm2

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

--step-id

Id of the approval step to approve.

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

--entities

Space-separated entity ids to approve (partial approval steps only). Omit to approve every currently ready entity for the step.

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

Preview

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

Mark a manual step as complete during execution.

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

Examples

Complete a manual step with a comment.

az migrate runbook execution step complete -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --execution-id myExecution --step-id step1 \
  --comment "Verified manually"

Required Parameters

--comment

Comment recording who/why the step was completed.

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

--step-id

Id of the manual step to complete.

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

Preview

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

Restart the execution of a failed step.

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

Examples

Retry a failed step.

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

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

--step-id

Id of the step to retry.

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

Feedback

Was this page helpful?