Edit

Get-AzReservationCatalog

  • Preview
Module:
Az.Reservations Module

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 regions and skus that are available for RI purchase for the specified Azure subscription.

Syntax

Get (Default) 

Get-AzReservationCatalog
    [-SubscriptionId <String[]>]
    [-Filter <String>]
    [-Location <String>]
    [-OfferId <String>]
    [-PlanId <String>]
    [-PublisherId <String>]
    [-ReservedResourceType <String>]
    [-Skip <Single>]
    [-Take <Single>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

GetViaIdentity 

Get-AzReservationCatalog
    -InputObject <IReservationsIdentity>
    [-Filter <String>]
    [-Location <String>]
    [-OfferId <String>]
    [-PlanId <String>]
    [-PublisherId <String>]
    [-ReservedResourceType <String>]
    [-Skip <Single>]
    [-Take <Single>]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Description

Get the regions and skus that are available for RI purchase for the specified Azure subscription.

Examples

Example 1: Get the list of reserved resource type skus with location

Get-AzReservationCatalog -SubscriptionId "10000000-aaaa-bbbb-cccc-100000000001" -Location "westus" -ReservedResourceType "VirtualMachine"

ResourceType    Terms           Name                   Locations
------------    -----           ----                   ---------
virtualMachines {P1Y, P3Y, P5Y} Standard_B12ms         {westus}
virtualMachines {P1Y, P3Y, P5Y} Standard_B16ms         {westus}
virtualMachines {P1Y, P3Y, P5Y} Standard_B1ls          {westus}
virtualMachines {P1Y, P3Y, P5Y} Standard_B1ms          {westus}
virtualMachines {P1Y, P3Y, P5Y} Standard_B1s           {westus}
virtualMachines {P1Y, P3Y, P5Y} Standard_B20ms         {westus}
virtualMachines {P1Y, P3Y, P5Y} Standard_B2ms          {westus}
virtualMachines {P1Y, P3Y, P5Y} Standard_B2s           {westus}
virtualMachines {P1Y, P3Y, P5Y} Standard_B4ms          {westus}

This command gets a catlog of reserved resource type skus with location

Example 2: Get the list of reserved resource type skus without location

Get-AzReservationCatalog -SubscriptionId "10000000-aaaa-bbbb-cccc-100000000001" -ReservedResourceType "SuseLinux"

ResourceType Terms           Name                            Locations
------------ -----           ----                            ---------
SuseLinux    {P1Y, P3Y, P5Y} sles_hpc_standard_3-4_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_hpc_standard_1-2_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_hpc_standard_5plus_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_hpc_priority_1-2_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_hpc_priority_5plus_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_hpc_priority_3-4_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_standard_5plus_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_standard_3-4_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_standard_1-2_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_priority_6_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_priority_2-4_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_priority_1_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_priority_8plus_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_sap_priority_5plus_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_sap_priority_1-2_vcpu_vm
SuseLinux    {P1Y, P3Y, P5Y} sles_sap_priority_3-4_vcpu_vm

This command gets a catlog of reserved resource type skus without location

Example 3: Get the list of eligible 3pp reserved resource type skus with publisher id, offer id, plan id

Get-AzReservationCatalog -SubscriptionId "10000000-aaaa-bbbb-cccc-100000000001" -ReservedResourceType "VirtualMachineSoftware" -PublisherId canonical -OfferId 0001-com-ubuntu-pro-xenial -PlanId pro-16_04-lts

ResourceType           Terms           Name                                                          Locations
------------           -----           ----                                                          ---------
VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.10core
VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.416core
VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.2core
VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.36core
VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.80core
VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.72core
VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.sharedcore
VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.20core
VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.40core
VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.48core
VirtualMachineSoftware {P1Y, P3Y, P5Y} canonical.0001-com-ubuntu-pro-xenial.pro-16_04-lts.4core

This command gets a catlog of eligible 3pp reserved resource type skus with publisher id, offer id, plan id

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

-Filter

May be used to filter by Catalog properties. The filter supports 'eq', 'or', and 'and'.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
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

-Location

Filters the skus based on the location specified in this parameter. This can be an Azure region or global

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OfferId

Offer id used to get the third party products

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PlanId

Plan id used to get the third party products

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PublisherId

Publisher id used to get the third party products

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ReservedResourceType

The type of the resource for which the skus should be provided.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Skip

The number of reservations to skip from the list before returning results

Parameter properties

Type:Single
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

Id of the subscription

Parameter properties

Type:

String[]

Default value:(Get-AzContext).Subscription.Id
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

-Take

To number of reservations to return

Parameter properties

Type:Single
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
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.

Inputs

IReservationsIdentity

Outputs

ICatalog