Get-AzReservationQuote

Module:

Az.Reservations Module

Calculate price for placing a ReservationOrder.

Syntax

CalculateExpanded (Default)

Get-AzReservationQuote
    [-AppliedScope <String[]>]
    [-AppliedScopePropertyDisplayName <String>]
    [-AppliedScopePropertyManagementGroupId <String>]
    [-AppliedScopePropertyResourceGroupId <String>]
    [-AppliedScopePropertySubscriptionId <String>]
    [-AppliedScopePropertyTenantId <String>]
    [-AppliedScopeType <String>]
    [-BillingPlan <String>]
    [-BillingScopeId <String>]
    [-DisplayName <String>]
    [-InstanceFlexibility <String>]
    [-Location <String>]
    [-Quantity <Int32>]
    [-Renew]
    [-ReservedResourceType <String>]
    [-ReviewDateTime <DateTime>]
    [-Sku <String>]
    [-Term <String>]
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CalculateViaJsonFilePath

Get-AzReservationQuote
    -JsonFilePath <String>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

CalculateViaJsonString

Get-AzReservationQuote
    -JsonString <String>
    [-DefaultProfile <PSObject>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Calculate price for placing a ReservationOrder.

Examples

Example 1: Get reservation price with 'Upfront' billing plan

Get-AzReservationQuote -AppliedScopeType 'Shared' -BillingPlan 'Upfront' -billingScopeId '/subscriptions/b0f278e1-1f18-4378-84d7-b44dfa708665' -DisplayName 'yourRIName' -Location 'westus' -Quantity 1 -ReservedResourceType 'VirtualMachines' -Sku 'Standard_b1ls' -Term 'P1Y'

BillingCurrencyTotal    : {
                            "currencyCode": "GBP",
                            "amount": 24
                          }
GrandTotal              : 0
IsBillingPartnerManaged :
IsTaxIncluded           :
NetTotal                : 0
PaymentSchedule         :
PricingCurrencyTotal    : {
                            "currencyCode": "GBP",
                            "amount": 24
                          }
ReservationOrderId      : 846655fa-d9e7-4fb8-9512-3ab7367352f1
SkuDescription          : Standard_b1ls
SkuTitle                : Reserved VM Instance, Standard_B1ls, US West, 1 Year
TaxTotal                : 0

Get reservation price with 'Upfront' billing plan

Example 2: Get reservation price with 'Monthly' billing plan

Get-AzReservationQuote -AppliedScopeType 'Shared' -BillingPlan 'Monthly' -billingScopeId '/subscriptions/b0f278e1-1f18-4378-84d7-b44dfa708665' -DisplayName 'yourRIName' -Location 'westus' -Quantity 1 -ReservedResourceType 'VirtualMachines' -Sku 'Standard_b1ls' -Term 'P1Y'

BillingCurrencyTotal    : {
                            "currencyCode": "GBP",
                            "amount": 24
                          }
GrandTotal              : 0
IsBillingPartnerManaged :
IsTaxIncluded           :
NetTotal                : 0
PaymentSchedule         : {{
                            "dueDate": "2022-07-07",
                            "pricingCurrencyTotal": {
                              "currencyCode": "GBP",
                              "amount": 2
                            },
                            "billingCurrencyTotal": {
                              "currencyCode": "GBP",
                              "amount": 2
                            },
                            "status": "Scheduled"
                          }, {
                            "dueDate": "2022-08-07",
                            "pricingCurrencyTotal": {
                              "currencyCode": "GBP",
                              "amount": 2
                            },
                            "status": "Scheduled"
                          }, {
                            "dueDate": "2022-09-07",
                            "pricingCurrencyTotal": {
                              "currencyCode": "GBP",
                              "amount": 2
                            },
                            "status": "Scheduled"
                          }, {
                            "dueDate": "2022-10-07",
                            "pricingCurrencyTotal": {
                              "currencyCode": "GBP",
                              "amount": 2
                            },
                            "status": "Scheduled"
                          }…}
PricingCurrencyTotal    : {
                            "currencyCode": "GBP",
                            "amount": 24
                          }
ReservationOrderId      : 23d4106a-8ec0-4709-839f-0e8073459e83
SkuDescription          : Standard_b1ls
SkuTitle                : Reserved VM Instance, Standard_B1ls, US West, 1 Year
TaxTotal                : 0

Get reservation price with 'Monthly' billing plan

Parameters

-AppliedScope

List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-AppliedScopePropertyDisplayName

Display name

Parameter properties

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

Parameter sets

CalculateExpanded

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

-AppliedScopePropertyManagementGroupId

Fully-qualified identifier of the management group where the benefit must be applied.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-AppliedScopePropertyResourceGroupId

Fully-qualified identifier of the resource group.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-AppliedScopePropertySubscriptionId

Fully-qualified identifier of the subscription.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-AppliedScopePropertyTenantId

Tenant ID where the savings plan should apply benefit.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-AppliedScopeType

Type of the Applied Scope.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-BillingPlan

Represent the billing plans.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-BillingScopeId

Subscription that will be charged for purchasing reservation or savings plan

Parameter properties

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

Parameter sets

CalculateExpanded

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	cf

Parameter sets

(All)

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

-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

-DisplayName

Friendly name of the reservation

Parameter properties

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

Parameter sets

CalculateExpanded

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

-InstanceFlexibility

Turning this on will apply the reservation discount to other VMs in the same VM size group. Only specify for VirtualMachines reserved resource type.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-JsonFilePath

Path of Json file supplied to the Calculate operation

Parameter properties

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

Parameter sets

CalculateViaJsonFilePath

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-JsonString

Json string supplied to the Calculate operation

Parameter properties

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

Parameter sets

CalculateViaJsonString

Position:	Named
Mandatory:	True
Value from pipeline:	False
Value from pipeline by property name:	False
Value from remaining arguments:	False

-Location

The Azure region where the reserved resource lives.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-Quantity

Quantity of the skus that are part of the reservation.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-Renew

Setting this to true will automatically purchase a new reservation on the expiration date time.

Parameter properties

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

Parameter sets

CalculateExpanded

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 that is being reserved.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-ReviewDateTime

This is the date-time when the Azure hybrid benefit needs to be reviewed.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-Sku

.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-Term

Represent the term of reservation.

Parameter properties

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

Parameter sets

CalculateExpanded

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Parameter properties

Type:	SwitchParameter
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	wi

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.

Outputs

ICalculatePriceResponse