Get-AzReservationOrder
This cmdlet is part of a Preview module. Preview versions aren't recommended for use in production environments. For more information, see https://aka.ms/azps-refstatus.
Get the details of the ReservationOrder.
Syntax
List (Default)
Get-AzReservationOrder
[-DefaultProfile <PSObject>]
[<CommonParameters>]
Get
Get-AzReservationOrder
-Id <String>
[-Expand <String>]
[-DefaultProfile <PSObject>]
[<CommonParameters>]
GetViaIdentity
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 truncated 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 truncated 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.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | AzureRMContext, AzureCredential |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Expand
May be used to expand the planInformation.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Get
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
GetViaIdentity
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Id
Order Id of the reservation
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ReservationOrderId, ReservationId |
Parameter sets
Get
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InputObject
Identity Parameter
Parameter properties
| Type: | IReservationsIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
GetViaIdentity
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
