az migrate runbook parameter

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

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

Download, upload, and configure a runbook's parameters (inputs) file.

Commands

Name	Description	Type	Status
az migrate runbook parameter configure	Generate an offline HTML editor for the parameters file.	Extension	Preview
az migrate runbook parameter download	Download the runbook's parameters files.	Extension	Preview
az migrate runbook parameter upload	Upload a new parameters file and validate it.	Extension	Preview

az migrate runbook parameter configure

Preview

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

Generate an offline HTML editor for the parameters file.

Downloads the runbook's inputs and renders a self-contained HTML page for editing them, with fields and validation driven by the schema in the parameters file. The page cannot call Azure; it writes inputs.json locally and shows the parameter upload command to run.

az migrate runbook parameter configure [--acquire-policy-token]
                                       [--change-reference]
                                       [--file]
                                       [--from-file]
                                       [--name --runbook-name]
                                       [--project-name]
                                       [--resource-group]
                                       [--spec-file]

Examples

Open the parameters editor for a runbook.

az migrate runbook parameter configure -g myRg \
  --project-name myProject --runbook-name myRunbook

Render from a local inputs.json without contacting Azure.

az migrate runbook parameter configure \
  --from-file ./inputs.json --spec-file ./spec.json

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 editor (default: current directory).

--from-file

Render from a local parameters (inputs.json) file instead of fetching from the service.

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

--spec-file

Optional local spec JSON file supplying the per-step entity list when rendering from --from-file.

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

Preview

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

Download the runbook's parameters files.

Downloads the parameters file (inputs.json) and, when the validation schema is shipped separately, schema.json, into a directory.

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

Examples

Download the parameters files to the current directory.

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

Download the parameters files to a directory.

az migrate runbook parameter download -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --directory ./params

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

--directory

Output directory for the downloaded parameter files (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 parameter upload

Preview

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

Upload a new parameters file and validate it.

az migrate runbook parameter upload --file
                                    --name --runbook-name
                                    --project-name
                                    --resource-group
                                    [--acquire-policy-token]
                                    [--change-reference]

Examples

Upload a parameters file.

az migrate runbook parameter upload -g myRg \
  --project-name myProject --runbook-name myRunbook \
  --file ./params.json

Required Parameters

--file

Path to the parameters JSON file to upload.

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

Feedback

Was this page helpful?