Get-AzureRmReservation

Reference

Module:: AzureRM.Reservations

Get Reservations in a given reservation Order

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

Get-AzureRmReservation
   -ReservationOrderId <Guid>
   [-ReservationId <Guid>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmReservation
   [-ReservationOrder <PSReservationOrder>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Get-AzureRmReservation
   [-ReservationOrderPage <PSReservationOrderPage>]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Description

List Reservations within a single ReservationOrder.

Examples

Example 1

PS C:\> Get-AzureRmReservation -ReservationOrderId "1111aaaa-b1b2-c0c2-d0d2-00000fffff"

List Reservations within the specified ReservationOrder.

Example 2

PS C:\> Get-AzureRmReservation -ReservationOrderId "1111aaaa-b1b2-c0c2-d0d2-00000fffff" -ReservationId "11111111-1111-1111-1111-1111111111"

Get specific Reservation details.

Parameters

-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

-ReservationId

Id of the Reservation to look at

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

-ReservationOrder

Pipe object parameter for ReservationOrder

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

-ReservationOrderId

Id of the ReservationOrder that contains the Reservation. Required.

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

-ReservationOrderPage

Pipe object parameter for ReservationOrder

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

Inputs

Guid

Microsoft.Azure.Commands.Reservations.Models.PSReservationOrder

Parameters: ReservationOrder (ByValue)

Microsoft.Azure.Commands.Reservations.Models.PSReservationOrderPage

Parameters: ReservationOrderPage (ByValue)

Outputs

Microsoft.Azure.Commands.Reservations.Models.PSReservationPage

Microsoft.Azure.Commands.Reservations.Models.PSReservation

Share via