Edit

Share via

New-AzResourceMoverMoveCollection

  • Reference
Module:
Az.ResourceMover

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)

Syntax

New-AzResourceMoverMoveCollection
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   [-IdentityPrincipalId <String>]
   [-IdentityTenantId <String>]
   [-IdentityType <ResourceIdentityType>]
   [-Location <String>]
   [-MoveRegion <String>]
   [-MoveType <MoveType>]
   [-SourceRegion <String>]
   [-Tag <Hashtable>]
   [-TargetRegion <String>]
   [-Version <String>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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)

Examples

Example 1: Create a new Move collection. (RegionToRegion)

New-AzResourceMoverMoveCollection -Name "PS-centralus-westcentralus-demoRMS"  -ResourceGroupName "RG-MoveCollection-demoRMS" -SourceRegion "centralus" -TargetRegion "westcentralus" -Location "centraluseuap" -IdentityType "SystemAssigned"

Etag                                   Location      Name
----                                   --------      ----
"0200d92f-0000-3300-0000-6021e9ec0000" centraluseuap PS-centralus-westcentralus-demoRMs

Create a new Move Collection for moving resources across regions. Please note that here the moveType is set to its default value 'RegionToRegion' for cross region move scenarios where 'SourceRegion' and 'TargetRegion' are required parameters. Please ensure 'MoveRegion' parameter is not required and should be set to null, as shown in the above example.

Example 2: Create a new Move collection. (RegionToZone)

New-AzResourceMoverMoveCollection -Name "PS-demo-RegionToZone"  -ResourceGroupName "RG-MoveCollection-demoRMS" -MoveRegion "eastus" -Location "eastus2euap" -IdentityType "SystemAssigned" -MoveType "RegionToZone"

Etag                                   Location    Name
----                                   --------    ----
"01000d98-0000-3400-0000-64f707c40000" eastus2euap PS-demo-RegionToZone

Create a new Move Collection for moving resources into a zone within the same region. Please note that for 'RegionToZone' type move collections 'MoveType' parameter should be set as 'RegionToZone' and 'MoveRegion' should be set as the location where resources undergoing zonal move reside. Please ensure 'SourceRegion' and 'TargetRegion' are not required and should be set to null, as shown in the above example.

Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityPrincipalId

Gets or sets the principal id.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityTenantId

Gets or sets the tenant id.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IdentityType

The type of identity used for the resource mover service.

Type:ResourceIdentityType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

The geo-location where the resource lives.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MoveRegion

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

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MoveType

Defines the MoveType.

Type:MoveType
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

The Move Collection Name.

Type:String
Aliases:MoveCollectionName
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

The Resource Group Name.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SourceRegion

Gets or sets the source region.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

The Subscription ID.

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

Resource tags.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TargetRegion

Gets or sets the target region.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Version

Gets or sets the version of move collection.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Outputs

IMoveCollection