az resource-mover move-collection

Note

This reference is part of the resource-mover extension for the Azure CLI (version 2.50.0 or higher). The extension will automatically install the first time you run an az resource-mover move-collection command. Learn more about extensions.

Manage move-collection.

Commands

Name	Description	Type	Status
az resource-mover move-collection bulk-remove	Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.	Extension	GA
az resource-mover move-collection commit	Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.	Extension	GA
az resource-mover move-collection create	Create a move collection.	Extension	GA
az resource-mover move-collection delete	Delete a move collection.	Extension	GA
az resource-mover move-collection discard	Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.	Extension	GA
az resource-mover move-collection initiate-move	Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.	Extension	GA
az resource-mover move-collection list	List all the Move Collections in the subscription.	Extension	GA
az resource-mover move-collection list-required-for	List of the move resources for which an arm resource is required for.	Extension	GA
az resource-mover move-collection list-unresolved-dependency	Lists a list of unresolved dependencies.	Extension	GA
az resource-mover move-collection prepare	Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.	Extension	GA
az resource-mover move-collection resolve-dependency	Computes, resolves and validate the dependencies of the moveResources in the move collection.	Extension	GA
az resource-mover move-collection show	Get the move collection.	Extension	GA
az resource-mover move-collection update	Update a move collection.	Extension	GA
az resource-mover move-collection wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az resource-mover move-collection bulk-remove

Removes the set of move resources included in the request body from move collection. The orchestration is done by service. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

The 'az resource-mover move-collection bulk-remove' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections.

az resource-mover move-collection bulk-remove [--ids]
                                              [--input-type {MoveResourceId, MoveResourceSourceId}]
                                              [--move-collection-name --name]
                                              [--move-resources]
                                              [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                              [--resource-group]
                                              [--subscription]
                                              [--validate-only {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Remove a move-resource in a move-collection.

az resource-mover move-collection bulk-remove --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

--input-type

Defines the move resource input type.

Property	Value
Parameter group:	Body Arguments
Accepted values:	MoveResourceId, MoveResourceSourceId

--move-collection-name --name -n

The Move Collection Name.

Property	Value
Parameter group:	Resource Id Arguments

--move-resources

Gets or sets the list of resource Id's, by default it accepts move resource id's unless the input type is switched via moveResourceInputType property. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body 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

--validate-only

Gets or sets a value indicating whether the operation needs to only run pre-requisite.

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

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 resource-mover move-collection commit

Commits the set of resources included in the request body. The commit operation is triggered on the moveResources in the moveState 'CommitPending' or 'CommitFailed', on a successful completion the moveResource moveState do a transition to Committed. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

The 'az resource-mover move-collection commit' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections.

az resource-mover move-collection commit [--ids]
                                         [--input-type {MoveResourceId, MoveResourceSourceId}]
                                         [--move-collection-name --name]
                                         [--move-resources]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--validate-only {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Commit a move-resource in the move-collection (RegionToRegion)

az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup

Commit resources in the move-collection (RegionToZone)

az resource-mover move-collection commit --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--input-type

Defines the move resource input type.

Property	Value
Parameter group:	Body Arguments
Accepted values:	MoveResourceId, MoveResourceSourceId

--move-collection-name --name -n

The Move Collection Name.

Property	Value
Parameter group:	Resource Id Arguments

--move-resources

Property	Value
Parameter group:	Body 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

--validate-only

Gets or sets a value indicating whether the operation needs to only run pre-requisite.

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

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 resource-mover move-collection create

Create a move collection.

Creates or updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region).

az resource-mover move-collection create --move-collection-name --name
                                         --resource-group
                                         [--identity]
                                         [--location]
                                         [--move-region]
                                         [--move-type {RegionToRegion, RegionToZone}]
                                         [--source-region]
                                         [--tags]
                                         [--target-region]
                                         [--version]

Examples

Create a move-collection with system assigned identity. (RegionToRegion)

az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --source-region eastus --target-region westus --name MyMoveCollection --resource-group MyResourceGroup

Create a zonal type move-collection with system assigned identity. (RegionToZone)

az resource-mover move-collection create --identity type=SystemAssigned --location eastus2 --move-region uksouth --name MyZonalMoveCollection --resource-group MyResourceGroup --move-type RegionToZone

Required Parameters

--move-collection-name --name -n

The Move Collection 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.

--identity

Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

--location -l

The geo-location where the resource lives.

Property	Value
Parameter group:	Body Arguments

--move-region

Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.

Property	Value
Parameter group:	Properties Arguments

--move-type

Defines the MoveType.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	RegionToRegion, RegionToZone

--source-region

Gets or sets the source region.

Property	Value
Parameter group:	Properties Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

--target-region

Gets or sets the target region.

Property	Value
Parameter group:	Properties Arguments

--version

Gets or sets the version of move collection.

Property	Value
Parameter group:	Properties 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 resource-mover move-collection delete

Delete a move collection.

The 'az resource-mover move-collection delete' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections.

az resource-mover move-collection delete [--ids]
                                         [--move-collection-name --name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

Examples

Delete a move-collection.

az resource-mover move-collection delete --name MyMoveCollection --resource-group MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--move-collection-name --name -n

The Move Collection Name.

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 resource-mover move-collection discard

Discards the set of resources included in the request body. The discard operation is triggered on the moveResources in the moveState 'CommitPending' or 'DiscardFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

The 'az resource-mover move-collection discard' command is not applicable on move collections with move-type 'RegionToZone' since discard is not a valid operation for region to zone move scenario.

az resource-mover move-collection discard [--ids]
                                          [--input-type {MoveResourceId, MoveResourceSourceId}]
                                          [--move-collection-name --name]
                                          [--move-resources]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--resource-group]
                                          [--subscription]
                                          [--validate-only {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Discard a remove-resource.

az resource-mover move-collection discard --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--input-type

Defines the move resource input type.

Property	Value
Parameter group:	Body Arguments
Accepted values:	MoveResourceId, MoveResourceSourceId

--move-collection-name --name -n

The Move Collection Name.

Property	Value
Parameter group:	Resource Id Arguments

--move-resources

Property	Value
Parameter group:	Body 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

--validate-only

Gets or sets a value indicating whether the operation needs to only run pre-requisite.

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

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 resource-mover move-collection initiate-move

Moves the set of resources included in the request body. The move operation is triggered after the moveResources are in the moveState 'MovePending' or 'MoveFailed', on a successful completion the moveResource moveState do a transition to CommitPending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

The 'az resource-mover move-collection initiate-move' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections.

az resource-mover move-collection initiate-move [--ids]
                                                [--input-type {MoveResourceId, MoveResourceSourceId}]
                                                [--move-collection-name --name]
                                                [--move-resources]
                                                [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                [--resource-group]
                                                [--subscription]
                                                [--validate-only {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Move the set of resources. (RegionToRegion)

az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup

Move VMs into zonal configuration within the same region (RegionToZone)

az resource-mover move-collection initiate-move --move-resources "/subscriptions/subID/resourceGroups/MyResourceGroup/providers/Microsoft.Migrate/moveCollections/MyZonalMoveCollection/moveResources/MyVMMoveResource" --validate-only false --name MyZonalMoveCollection --resource-group MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--input-type

Defines the move resource input type.

Property	Value
Parameter group:	Body Arguments
Accepted values:	MoveResourceId, MoveResourceSourceId

--move-collection-name --name -n

The Move Collection Name.

Property	Value
Parameter group:	Resource Id Arguments

--move-resources

Property	Value
Parameter group:	Body 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

--validate-only

Gets or sets a value indicating whether the operation needs to only run pre-requisite.

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

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 resource-mover move-collection list

List all the Move Collections in the subscription.

The 'az resource-mover move-collection list' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections.

az resource-mover move-collection list [--max-items]
                                       [--next-token]
                                       [--resource-group]

Examples

List all move-collections.

az resource-mover move-collection list

List all move-collections by resource group.

az resource-mover move-collection list -g MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

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

az resource-mover move-collection list-required-for

List of the move resources for which an arm resource is required for.

The 'az resource-mover move-collection list-required-for' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections.

az resource-mover move-collection list-required-for --source-id
                                                    [--ids]
                                                    [--move-collection-name --name]
                                                    [--resource-group]
                                                    [--subscription]

Required Parameters

--source-id

The sourceId for which the api is invoked.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--move-collection-name --name -n

The Move Collection Name.

Property	Value
Parameter group:	Resource Id Arguments

--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 resource-mover move-collection list-unresolved-dependency

Lists a list of unresolved dependencies.

The 'az resource-mover move-collection list-unresolved-dependency' command is applicable for 'RegionToRegion' type move collections. However, for move collections with move-type 'RegionToZone' dependencies are automatically added to the move collection once 'az resource-mover move-collection resolve-dependency' is executed. Please refer to 'az resource-mover move-collection resolve-dependency' command documentation for additional details.

az resource-mover move-collection list-unresolved-dependency --move-collection-name --name
                                                             --resource-group
                                                             [--dependency-level {Descendant, Direct}]
                                                             [--filter]
                                                             [--max-items]
                                                             [--next-token]
                                                             [--orderby]

Examples

List the unresolved dependencies.

az resource-mover move-collection list-unresolved-dependency --move-collection-name MyMoveCollection --resource-group MyResourceGroup

Required Parameters

--move-collection-name --name -n

The Move Collection 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.

--dependency-level

Defines the dependency level.

Property	Value
Accepted values:	Descendant, Direct

--filter

The filter to apply on the operation. For example, $apply=filter(count eq 2).

--max-items

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

--orderby

OData order by query option. For example, you can use $orderby=Count desc.

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 resource-mover move-collection prepare

Initiates prepare for the set of resources included in the request body. The prepare operation is on the moveResources that are in the moveState 'PreparePending' or 'PrepareFailed', on a successful completion the moveResource moveState do a transition to MovePending. To aid the user to prerequisite the operation the client can call operation with validateOnly property set to true.

The 'az resource-mover move-collection prepare' command is not applicable on move collections with move-type 'RegionToZone' since prepare is not a valid operation for region to zone move scenario.

az resource-mover move-collection prepare [--ids]
                                          [--input-type {MoveResourceId, MoveResourceSourceId}]
                                          [--move-collection-name --name]
                                          [--move-resources]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--resource-group]
                                          [--subscription]
                                          [--validate-only {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Prepare a move-resource.

az resource-mover move-collection prepare --move-resources "/subscriptions/subID/resourceGroups/myRG/providers/Microsoft.Migrate/MoveCollections/movecollection1/MoveResources/moveresource1" --validate-only false --name MyMoveCollection --resource-group MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--input-type

Defines the move resource input type.

Property	Value
Parameter group:	Body Arguments
Accepted values:	MoveResourceId, MoveResourceSourceId

--move-collection-name --name -n

The Move Collection Name.

Property	Value
Parameter group:	Resource Id Arguments

--move-resources

Property	Value
Parameter group:	Body 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

--validate-only

Gets or sets a value indicating whether the operation needs to only run pre-requisite.

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

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 resource-mover move-collection resolve-dependency

Computes, resolves and validate the dependencies of the moveResources in the move collection.

Please note that for 'RegionToRegion' type move collections the 'az resource-mover move-collection resolve-dependency' command just resolves the move collection, the user is required to identify the list of unresolved dependencies using 'az resource-mover move-collection list-unresolved-dependency' and then manually add them to the move collection using 'az resource-mover move-resource add' command. However, for move-type 'RegionToZone' this command finds the required dependencies and automatically adds them to the move collection in a single step.

az resource-mover move-collection resolve-dependency [--ids]
                                                     [--move-collection-name --name]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--resource-group]
                                                     [--subscription]

Examples

Resolve the dependency of the move-resources. (RegionToRegion)

az resource-mover move-collection resolve-dependency --name MyMoveCollection --resource-group MyResourceGroup

Resolve the dependency of the move-resources. (RegionToZone)

az resource-mover move-collection resolve-dependency --name MyZonalMoveCollection --resource-group MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--move-collection-name --name -n

The Move Collection Name.

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 resource-mover move-collection show

Get the move collection.

The ' az resource-mover move-collection show' command remains same for both 'RegionToRegion' and 'RegionToZone' type move collections.

az resource-mover move-collection show [--ids]
                                       [--move-collection-name --name]
                                       [--resource-group]
                                       [--subscription]

Examples

Show information about a move-collection.

az resource-mover move-collection show --name MyMoveCollection --resource-group MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--ids

Property	Value
Parameter group:	Resource Id Arguments

--move-collection-name --name -n

The Move Collection Name.

Property	Value
Parameter group:	Resource Id Arguments

--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 resource-mover move-collection update

Update a move collection.

Updates a move collection. The following types of move collections based on the move scenario are supported currently: 1. RegionToRegion (Moving resources across regions) 2. RegionToZone (Moving virtual machines into a zone within the same region).

az resource-mover move-collection update [--add]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--identity]
                                         [--ids]
                                         [--move-collection-name --name]
                                         [--move-region]
                                         [--move-type {RegionToRegion, RegionToZone}]
                                         [--remove]
                                         [--resource-group]
                                         [--set]
                                         [--source-region]
                                         [--subscription]
                                         [--tags]
                                         [--target-region]
                                         [--version]

Examples

Update a move-collection.

az resource-mover move-collection update --identity type=SystemAssigned --tags key1=value1 --name MyMoveCollection --resource-group MyResourceGroup

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--identity

Defines the MSI properties of the Move Collection. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--move-collection-name --name -n

The Move Collection Name.

Property	Value
Parameter group:	Resource Id Arguments

--move-region

Gets or sets the move region which indicates the region where the VM Regional to Zonal move will be conducted.

Property	Value
Parameter group:	Properties Arguments

--move-type

Defines the MoveType.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	RegionToRegion, RegionToZone

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update Arguments

--source-region

Gets or sets the source region.

Property	Value
Parameter group:	Properties 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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

--target-region

Gets or sets the target region.

Property	Value
Parameter group:	Properties Arguments

--version

Gets or sets the version of move collection.

Property	Value
Parameter group:	Properties 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 resource-mover move-collection wait

Place the CLI in a waiting state until a condition is met.

az resource-mover move-collection wait [--created]
                                       [--custom]
                                       [--deleted]
                                       [--exists]
                                       [--ids]
                                       [--interval]
                                       [--move-collection-name --name]
                                       [--resource-group]
                                       [--subscription]
                                       [--timeout]
                                       [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--move-collection-name --name -n

The Move Collection Name.

Property	Value
Parameter group:	Resource Id Arguments

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
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

Share via

az resource-mover move-collection

Commands

az resource-mover move-collection bulk-remove

Examples

Optional Parameters

az resource-mover move-collection commit

Examples

Optional Parameters

az resource-mover move-collection create

Examples

Required Parameters

Optional Parameters

az resource-mover move-collection delete

Examples

Optional Parameters

az resource-mover move-collection discard

Examples

Optional Parameters

az resource-mover move-collection initiate-move

Examples

Optional Parameters

az resource-mover move-collection list

Examples

Optional Parameters

az resource-mover move-collection list-required-for

Required Parameters

Optional Parameters

az resource-mover move-collection list-unresolved-dependency

Examples

Required Parameters

Optional Parameters

az resource-mover move-collection prepare

Examples

Optional Parameters

az resource-mover move-collection resolve-dependency

Examples

Optional Parameters

az resource-mover move-collection show

Examples

Optional Parameters

az resource-mover move-collection update

Examples

Optional Parameters

az resource-mover move-collection wait

Optional Parameters

Feedback