az network virtual-appliance migration

Manage the infrastructure migration of an Azure Network Virtual Appliance.

The migration workflow is executed in phases. Run prepare first, then execute, and finally commit to complete the migration or abort to roll it back.

Commands

Name	Description	Type	Status
az network virtual-appliance migration abort	Abort an in-progress migration of a Network Virtual Appliance.	Core	GA
az network virtual-appliance migration commit	Commit the migration of a Network Virtual Appliance.	Core	GA
az network virtual-appliance migration execute	Execute the migration of a Network Virtual Appliance.	Core	GA
az network virtual-appliance migration prepare	Prepare a Network Virtual Appliance for an infrastructure migration.	Core	GA

az network virtual-appliance migration abort

Abort an in-progress migration of a Network Virtual Appliance.

Aborting a migration discards any changes staged by the prepare or execute phases and restores the Network Virtual Appliance to its previous configuration. The migration type is inferred from the in-progress migration on the resource. This action cannot be run once the migration has been committed.

az network virtual-appliance migration abort [--acquire-policy-token]
                                             [--change-reference]
                                             [--ids]
                                             [--name --network-virtual-appliance-name]
                                             [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                             [--resource-group]
                                             [--subscription]
                                             [--yes]

Examples

Abort an in-progress Network Virtual Appliance migration.

az network virtual-appliance migration abort -n MyName -g MyRG

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --network-virtual-appliance-name -n

The name of the Network Virtual Appliance.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network virtual-appliance migration commit

Commit the migration of a Network Virtual Appliance.

This is the final phase of the migration workflow and must be run after execute. Committing a migration finalizes the new infrastructure and discards the previous configuration. This action cannot be reversed with abort.

az network virtual-appliance migration commit --migration-type {MigrateToNewILBArchitecture, MigrateToNewOSVersion}
                                              [--acquire-policy-token]
                                              [--change-reference]
                                              [--ids]
                                              [--name --network-virtual-appliance-name]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--subscription]

Examples

Commit the migration of a Network Virtual Appliance to the new internal load balancer (ILB) architecture.

az network virtual-appliance migration commit -n MyName -g MyRG --migration-type MigrateToNewILBArchitecture

Required Parameters

--migration-type

The type of migration workflow to commit for the Network Virtual Appliance. Must match the type used in the prepare and execute phases.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	MigrateToNewILBArchitecture, MigrateToNewOSVersion

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --network-virtual-appliance-name -n

The name of the Network Virtual Appliance.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network virtual-appliance migration execute

Execute the migration of a Network Virtual Appliance.

This is the second phase of the migration workflow and must be run after prepare. Executing a migration applies the new infrastructure to the Network Virtual Appliance. Once the execution completes, run commit to finalize the migration or abort to roll it back.

az network virtual-appliance migration execute --migration-type {MigrateToNewILBArchitecture, MigrateToNewOSVersion}
                                               [--acquire-policy-token]
                                               [--change-reference]
                                               [--ids]
                                               [--name --network-virtual-appliance-name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--subscription]

Examples

Execute the migration of a Network Virtual Appliance to the new internal load balancer (ILB) architecture.

az network virtual-appliance migration execute -n MyName -g MyRG --migration-type MigrateToNewILBArchitecture

Required Parameters

--migration-type

The type of migration workflow to execute for the Network Virtual Appliance. Must match the type used in the prepare phase.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	MigrateToNewILBArchitecture, MigrateToNewOSVersion

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--name --network-virtual-appliance-name -n

The name of the Network Virtual Appliance.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az network virtual-appliance migration prepare

Prepare a Network Virtual Appliance for an infrastructure migration.

This is the first phase of the migration workflow and must be run before execute. Preparing a migration validates that the Network Virtual Appliance is eligible for the requested migration and stages the resources required to perform it.

az network virtual-appliance migration prepare --migration-type {MigrateToNewILBArchitecture, MigrateToNewOSVersion}
                                               [--acquire-policy-token]
                                               [--change-reference]
                                               [--ids]
                                               [--marketplace-version]
                                               [--name --network-virtual-appliance-name]
                                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                               [--resource-group]
                                               [--subscription]

Examples

Prepare a Network Virtual Appliance for migration to the new internal load balancer (ILB) architecture.

az network virtual-appliance migration prepare -n MyName -g MyRG --migration-type MigrateToNewILBArchitecture

Required Parameters

--migration-type

The type of migration workflow to prepare for the Network Virtual Appliance.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	MigrateToNewILBArchitecture, MigrateToNewOSVersion

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

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--marketplace-version

The marketplace version to migrate to. Only applicable when --migration-type is MigrateToNewOSVersion.

Property	Value
Parameter group:	Properties Arguments

--name --network-virtual-appliance-name -n

The name of the Network Virtual Appliance.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id 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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False