PurchaseRequest interface

Package:

@azure/arm-reservations

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. This property will be deprecated and replaced by appliedScopeProperties instead for Single AppliedScopeType.
appliedScopeType	Type of the Applied Scope.
billingPlan	Represent the billing plans.
billingScopeId	Subscription that will be charged for purchasing reservation or savings plan
displayName	Friendly name of the reservation
location	The Azure region where the reserved resource lives.
quantity	Quantity of the skus that are part of the reservation.
renew	Setting this to true will automatically purchase a new reservation on the expiration date time.
reservedResourceProperties	Properties specific to each reserved resource type. Not required if not applicable.
reservedResourceType	The type of the resource that is being reserved.
reviewDateTime	This is the date-time when the Azure hybrid benefit needs to be reviewed.
sku	The name of sku
term	Represent the term of reservation.

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?: AppliedScopeProperties

Property Value

AppliedScopeProperties

appliedScopes

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.

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

billingScopeId?: string

Property Value

string

displayName

Friendly name of the reservation

displayName?: 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.

quantity?: number

Property Value

number

renew

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

renew?: boolean

Property Value

boolean

reservedResourceProperties

Properties specific to each reserved resource type. Not required if not applicable.

reservedResourceProperties?: PurchaseRequestPropertiesReservedResourceProperties

Property Value

PurchaseRequestPropertiesReservedResourceProperties

reservedResourceType

The type of the resource that is being reserved.

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

Represent the term of reservation.

term?: string

Property Value

string