Get-AzReservationOrder

Reference

Module:: Az.Reservations

Get the details of the ReservationOrder.

Syntax

Get-AzReservationOrder
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzReservationOrder
   -Id <String>
   [-Expand <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Get-AzReservationOrder
   -InputObject <IReservationsIdentity>
   [-Expand <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get the details of the ReservationOrder.

Examples

Example 1: Get the list of reservation orders in the current tenant

Get-AzReservationOrder

ReservationOrderId                   DisplayName                                          Term State     Quantity Reservations
------------------                   -----------                                          ---- -----     -------- ------------
179de21b-90ec-4fe4-9423-f804b856dfee VM_RI_08-20-2021_15-47                               P3Y  Succeeded 1        {{…
0de8d259-d48v-4db2-8fd9-ae4dd2bd2227 VM_RI_04-19-2021_13-48                               P3Y  Cancelled 4        {{…
02ffwsb1-4369-4m8s-b118-12efbfddd3fc VM_RI_04-19-2021_12-48                               P3Y  Succeeded 1        {{…
06629f91-b216-4d6f-80cd-fa91c8ba61b8 VM_RI_04-19-2021_19-48                               P3Y  Succeeded 1        {{…

Get the list of reservation orders in the current tenant. Some data might be trucated due to the width of powershell view, appending this to the end of the command to show the truncated data: | ft -Wrap

Example 2: Get the reservation order in the current tenant, given reservation order Id

Get-AzReservationOrder -ReservationOrderId 179de21b-90ec-4fe4-9423-f804b856dfee

ReservationOrderId                   DisplayName            Term State     Quantity Reservations
------------------                   -----------            ---- -----     -------- ------------
179ef21b-90ec-4fe4-9423-f794b856dfee VM_RI_08-20-2021_15-47 P3Y  Succeeded 1        {{…

Get the reservation order in the current tenant, given reservation order Id. Some data might be trucated due to the width of powershell view, appending this to the end of the command to show the truncated data: | ft -Wrap

Parameters

-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

-Expand

May be used to expand the planInformation.

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

-Id

Order Id of the reservation

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

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

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

Inputs

IReservationsIdentity

Outputs

IReservationOrderResponse

Notes

ALIASES

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

INPUTOBJECT <IReservationsIdentity>: Identity Parameter

[Id <String>]: Resource identity path
[ReservationId <String>]: Id of the reservation item
[ReservationOrderId <String>]: Order Id of the reservation
[SubscriptionId <String>]: Id of the subscription