Split-AzureRmReservation

Split a Reservation.

Warning

The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.

Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.

Syntax

Split-AzureRmReservation
     -ReservationOrderId <Guid>
     -ReservationId <Guid>
     -Quantity <Int32[]>
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Split-AzureRmReservation
     -Quantity <Int32[]>
     -Reservation <PSReservation>
     [-DefaultProfile <IAzureContextContainer>]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

Split a Reservation into two Reservations with specified quantity distribution.

Examples

Example 1

PS C:\> Split-AzureRmReservation -ReservationOrderId "00000000-ffff-ffff-0000-00000fffff" -ReservationId "11111111-1111-1111-1111-1111111111" -Quantities 2,3

Split the specified Reservation into two Reservations with the corresponding quantities

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 credentials, account, tenant, and subscription used for communication with Azure.

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

-Quantity

Comma-separated integers for quantity field of the two Reservations

Type:Int32[]
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Reservation

Pipe object parameter for Reservation

Type:Microsoft.Azure.Commands.Reservations.Models.PSReservation
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ReservationId

Id of the Reservation to split

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

-ReservationOrderId

Id of the ReservationOrder that contains the Reservation that user wants to split

Type:Guid
Position:Named
Default value:None
Required:True
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

Inputs

Microsoft.Azure.Commands.Reservations.Models.PSReservation

Parameters: Reservation (ByValue)

Outputs

Microsoft.Azure.Commands.Reservations.Models.PSReservation