Skip to content

Latest commit

 

History

History
115 lines (89 loc) · 3.73 KB

File metadata and controls

115 lines (89 loc) · 3.73 KB
external help file Az.Reservations-help.xml
Module Name Az.Reservations
online version https://learn.microsoft.com/powershell/module/az.reservations/get-azreservationorderid
schema 2.0.0
content_git_url https://github.com/Azure/azure-powershell/blob/main/src/Reservations/Reservations/help/Get-AzReservationOrderId.md
original_content_git_url https://github.com/Azure/azure-powershell/blob/main/src/Reservations/Reservations/help/Get-AzReservationOrderId.md
cmdletStatusMessage 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.
cmdletStatus preview

Get-AzReservationOrderId

SYNOPSIS

Get applicable Reservations that are applied to this subscription or a resource group under this subscription.

SYNTAX

Get (Default)

Get-AzReservationOrderId [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>]
 [<CommonParameters>]

GetViaIdentity

Get-AzReservationOrderId -InputObject <IReservationsIdentity> [-DefaultProfile <PSObject>]
 [<CommonParameters>]

DESCRIPTION

Get applicable Reservations that are applied to this subscription or a resource group under this subscription.

EXAMPLES

Example 1: Get list of applicable ReservationOrder Ids.

Get-AzReservationOrderId -SubscriptionId 'aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e'
Id                         : /subscriptions/aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e/providers/microsoft.capacity/AppliedReservations/default
Name                       : default
ReservationOrderIdNextLink : 
ReservationOrderIdValue    : {/providers/Microsoft.Capacity/reservationorders/7c6192be-7543-40c3-93e1-3d7f0b15203f, 
                             /providers/Microsoft.Capacity/reservationorders/aa6c95fe-f25b-4f2e-864f-3860ef5d5bd0, 
                             /providers/Microsoft.Capacity/reservationorders/d9e3935c-288e-4ef5-81a0-55201c1a6a67, 
                             /providers/Microsoft.Capacity/reservationorders/b60911ea-d990-4795-818a-b7396abdb13b…}
ResourceGroupName          : 
Type                       : Microsoft.Capacity/AppliedReservations

Get Ids of applicable ReservationOrders that can be applied to this subscription.

PARAMETERS

-DefaultProfile

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

Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

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

-InputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity
Parameter Sets: GetViaIdentity
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-SubscriptionId

Id of the subscription

Type: System.String[]
Parameter Sets: Get
Aliases:

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IReservationsIdentity

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.Reservations.Models.IAppliedReservations

NOTES

RELATED LINKS