Share via

ReservationPurchaseRequest interface

  • Reference
Package:
@azure/arm-billing

The request for reservation purchase

Properties

appliedScopeProperties

Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup
appliedScopes

List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared.
appliedScopeType

Type of the Applied Scope.
billingPlan

Represent the billing plans.
billingScopeId

Subscription that will be charged for purchasing reservation or savings plan NOTE: This property will not be serialized. It can only be populated by the server.
displayName

Friendly name of the reservation
instanceFlexibilityPropertiesInstanceFlexibility

Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility.
instanceFlexibilityPropertiesReservedResourcePropertiesInstanceFlexibility

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

The Azure region where the reserved resource lives.
quantity

Quantity of the skus that are part of the reservation. Must be greater than zero.
renew

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

The reserved source type of the reservation, e.g. virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.
reviewDateTime

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

The name of sku
term

The term of the reservation, e.g. P1Y NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

appliedScopeProperties

Properties specific to applied scope type. Not required if not applicable. Required and need to provide tenantId and managementGroupId if AppliedScopeType is ManagementGroup

appliedScopeProperties?: ReservationAppliedScopeProperties

Property Value

ReservationAppliedScopeProperties

appliedScopes

List of the subscriptions that the benefit will be applied. Do not specify if AppliedScopeType is Shared.

appliedScopes?: string[]

Property Value

string[]

appliedScopeType

Type of the Applied Scope.

appliedScopeType?: string

Property Value

string

billingPlan

Represent the billing plans.

billingPlan?: string

Property Value

string

billingScopeId

Subscription that will be charged for purchasing reservation or savings plan NOTE: This property will not be serialized. It can only be populated by the server.

billingScopeId?: string

Property Value

string

displayName

Friendly name of the reservation

displayName?: string

Property Value

string

instanceFlexibilityPropertiesInstanceFlexibility

Allows reservation discount to be applied across skus within the same auto fit group. Not all skus support instance size flexibility.

instanceFlexibilityPropertiesInstanceFlexibility?: string

Property Value

string

instanceFlexibilityPropertiesReservedResourcePropertiesInstanceFlexibility

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

instanceFlexibilityPropertiesReservedResourcePropertiesInstanceFlexibility?: string

Property Value

string

location

The Azure region where the reserved resource lives.

location?: string

Property Value

string

quantity

Quantity of the skus that are part of the reservation. Must be greater than zero.

quantity?: number

Property Value

number

renew

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

renew?: boolean

Property Value

boolean

reservedResourceType

The reserved source type of the reservation, e.g. virtual machine. NOTE: This property will not be serialized. It can only be populated by the server.

reservedResourceType?: string

Property Value

string

reviewDateTime

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

reviewDateTime?: Date

Property Value

Date

sku

The name of sku

sku?: SkuName

Property Value

SkuName

term

The term of the reservation, e.g. P1Y NOTE: This property will not be serialized. It can only be populated by the server.

term?: string

Property Value

string