az migrate runbook definition

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

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

View and download the contents of a runbook definition.

Commands

Name	Description	Type	Status
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 definition download

Preview

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

Download the runbook definition and documentation files.

az migrate runbook definition download --name --runbook-name
                                       --project-name
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--destination]

Examples

Download a runbook definition to the current directory.

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

Download a runbook definition to a specific directory.

az migrate runbook definition download -g myRg \
  --project-name myProject -n myRunbook \
  --destination ./runbooks

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

--destination

Directory to save the downloaded files to (default: current directory).

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 show

Preview

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

Show the definition (contents) of a runbook.

az migrate runbook definition show --name --runbook-name
                                   --project-name
                                   --resource-group
                                   [--step-group-id]
                                   [--step-id]

Examples

Show a runbook definition.

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

Show a single step group in a runbook definition.

az migrate runbook definition show -g myRg \
  --project-name myProject -n myRunbook \
  --step-group-id myStepGroup

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.

--step-group-id

Limit the output to a single step group.

--step-id

Limit the output to a single 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 visualize

Preview

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

Render the runbook definition as a self-contained HTML page.

az migrate runbook definition visualize [--acquire-policy-token]
                                        [--change-reference]
                                        [--file]
                                        [--from-file]
                                        [--name --runbook-name]
                                        [--no-open]
                                        [--parameters-file]
                                        [--project-name]
                                        [--resource-group]

Examples

Visualize a runbook definition (opens in the browser).

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

Write the HTML without opening a browser.

az migrate runbook definition visualize -g myRg \
  --project-name myProject -n myRunbook --no-open

Visualize from a local definition file.

az migrate runbook definition visualize \
  --from-file ./definition.json --file ./definition.html

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

--file

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

--from-file

Render from a local runbook definition JSON file instead of fetching from the service.

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

--parameters-file

Optional local parameters JSON file to merge when rendering from --from-file.

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

Feedback

Was this page helpful?