az migrate runbook definition 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 definition step command. Learn more about extensions.

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

Manage individual steps in a runbook definition.

Commands

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

Preview

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

Add a step to the runbook definition.

az migrate runbook definition step add --name --runbook-name
                                       --project-name
                                       --resource-group
                                       --step-group-id
                                       --step-name
                                       --step-type {Approval, Manual}
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--depends-on-mapped-entities]
                                       [--depends-on-per-entity]
                                       [--depends-on-whole-step]
                                       [--migration-entity-ids]
                                       [--step-description]

Examples

Add a manual step to a step group.

az migrate runbook definition step add -g myRg \
  --project-name myProject -n myRunbook \
  --step-type Manual --step-name "Verify cutover" \
  --step-group-id workstream-0

Add an approval step that waits for a whole step.

az migrate runbook definition step add -g myRg \
  --project-name myProject -n myRunbook \
  --step-type Approval --step-name "Change approval" \
  --step-group-id workstream-0 --depends-on-whole-step step0

Add an approval that waits per entity (same entity upstream).

az migrate runbook definition step add -g myRg \
  --project-name myProject -n myRunbook \
  --step-type Approval --step-name "Approve cutover" \
  --step-group-id workstream-0 --migration-entity-ids e1 e2 \
  --depends-on-per-entity prepare-1

Add an approval with mapped-entity dependencies.

az migrate runbook definition step add -g myRg \
  --project-name myProject -n myRunbook \
  --step-type Approval --step-name "Approve" \
  --step-group-id workstream-0 --migration-entity-ids e1 e2 \
  --depends-on-mapped-entities "enable-1=e1:f1,e2:f2"

Add a manual step scoped to specific migration entities.

az migrate runbook definition step add -g myRg \
  --project-name myProject -n myRunbook \
  --step-type Manual --step-name "Post checks" \
  --step-group-id workstream-0 \
  --migration-entity-ids entity1 entity2

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

--step-group-id

Id of the step group to add the step to.

--step-name

Display name for the step.

--step-type

Kind of step to add.

Property Value
Accepted values: Approval, Manual

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
--depends-on-mapped-entities

Mapped-entity dependencies, each as <stepId>=<dependentEntity>:<waitsForEntity>,.... Requires a step with entities.

--depends-on-per-entity

Step ids this step waits for per entity (the same entity in the upstream step). Requires a step with entities.

--depends-on-whole-step

Step ids this step waits for as a whole step (all entities).

--migration-entity-ids

Space-separated migration entity GUIDs to associate with the step.

--step-description

Optional description 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 definition step remove

Preview

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

Remove a step from the runbook definition.

az migrate runbook definition step remove --name --runbook-name
                                          --project-name
                                          --resource-group
                                          --step-id
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--yes]

Examples

Remove a step by id.

az migrate runbook definition step remove -g myRg \
  --project-name myProject -n myRunbook --step-id step1

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

--step-id

Id of the step to remove.

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 definition step update

Preview

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

Update a step in the runbook definition.

az migrate runbook definition step update --name --runbook-name
                                          --project-name
                                          --resource-group
                                          --step-id
                                          [--acquire-policy-token]
                                          [--change-reference]
                                          [--depends-on-mapped-entities]
                                          [--depends-on-per-entity]
                                          [--depends-on-whole-step]
                                          [--step-description]
                                          [--step-name]

Examples

Rename a step and replace its dependencies.

az migrate runbook definition step update -g myRg \
  --project-name myProject -n myRunbook \
  --step-id step1 --step-name "New name" \
  --depends-on-whole-step step0

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

--step-id

Id of the step to update.

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
--depends-on-mapped-entities

Replace dependencies: mapped-entity dependencies, each as <stepId>=<dependentEntity>:<waitsForEntity>,.... Requires a step with entities.

--depends-on-per-entity

Replace dependencies: step ids this step waits for per entity. Requires a step with entities.

--depends-on-whole-step

Replace dependencies: step ids this step waits for as a whole step. Omit all --depends-on-* flags to keep the existing dependencies unchanged.

--step-description

Updated description for the step.

--step-name

Updated display name 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