Get-AzReservationCatalog
Get the regions and skus that are available for RI purchase for the specified Azure subscription.
Syntax
Get-AzReservationCatalog
[-SubscriptionId <String[]>]
[-Filter <String>]
[-Location <String>]
[-OfferId <String>]
[-PlanId <String>]
[-PublisherId <String>]
[-ReservedResourceType <String>]
[-Skip <Single>]
[-Take <Single>]
[-DefaultProfile <PSObject>]
[<CommonParameters>] 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_vmThis 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.4coreThis 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.
| Type: | PSObject |
| Aliases: | AzureRMContext, AzureCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
May be used to filter by Catalog properties. The filter supports 'eq', 'or', and 'and'.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
-Location
Filters the skus based on the location specified in this parameter. This can be an Azure region or global
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OfferId
Offer id used to get the third party products
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PlanId
Plan id used to get the third party products
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PublisherId
Publisher id used to get the third party products
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReservedResourceType
The type of the resource for which the skus should be provided.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
The number of reservations to skip from the list before returning results
| Type: | Single |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SubscriptionId
Id of the subscription
| Type: | String[] |
| Position: | Named |
| Default value: | (Get-AzContext).Subscription.Id |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Take
To number of reservations to return
| Type: | Single |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Outputs
Collaborate with us on GitHub
The source for this content can be found on GitHub, where you can also create and review issues and pull requests. For more information, see our contributor guide.
Azure PowerShell