az migrate runbook definition step-group

  • 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-group 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 step groups in a runbook definition.

Commands

Name Description Type Status
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-group merge

Preview

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

Merge two or more step groups into a single step group.

az migrate runbook definition step-group merge --name --runbook-name
                                               --new-step-group-name
                                               --project-name
                                               --resource-group
                                               --source-step-group-ids
                                               [--acquire-policy-token]
                                               [--change-reference]

Examples

Merge two step groups.

az migrate runbook definition step-group merge -g myRg \
  --project-name myProject -n myRunbook \
  --source-step-group-ids ws1 ws2 \
  --new-step-group-name "Combined tier"

Required Parameters

--name --runbook-name -n

Name of the runbook.

--new-step-group-name

Display name for the merged step group.

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

--source-step-group-ids

Space-separated ids of the step groups to merge.

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 definition step-group split

Preview

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

Split a step group into two step groups.

az migrate runbook definition step-group split --name --runbook-name
                                               --new-step-group-name
                                               --project-name
                                               --resource-group
                                               --source-step-group-id
                                               --step-ids
                                               [--acquire-policy-token]
                                               [--change-reference]

Examples

Move steps into a new step group.

az migrate runbook definition step-group split -g myRg \
  --project-name myProject -n myRunbook \
  --source-step-group-id ws1 \
  --new-step-group-name "Database tier" \
  --step-ids step1 step2

Required Parameters

--name --runbook-name -n

Name of the runbook.

--new-step-group-name

Display name for the new step group.

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

--source-step-group-id

Id of the step group to split.

--step-ids

Space-separated step ids to move into the new step group.

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