Share via

ReservationsProperties interface

  • Reference
Package:
@azure/arm-reservations

The properties of the reservations

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

The list of applied scopes
appliedScopeType

The applied scope type
archived

Indicates if the reservation is archived
benefitStartTime

This is the DateTime when the reservation benefit started.
billingPlan

The billing plan options available for this sku.
billingScopeId

Subscription that will be charged for purchasing reservation or savings plan
capabilities

Capabilities of the reservation
displayName

Friendly name for user to easily identify the reservation
displayProvisioningState

The provisioning state of the reservation for display, e.g. Succeeded NOTE: This property will not be serialized. It can only be populated by the server.
effectiveDateTime

DateTime of the reservation starting when this version is effective from.
expiryDate

This is the date when the reservation will expire.
expiryDateTime

This is the date-time when the reservation will expire.
extendedStatusInfo

The message giving detailed information about the status code.
instanceFlexibility

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

DateTime of the last time the reservation was updated. NOTE: This property will not be serialized. It can only be populated by the server.
mergeProperties

Properties of reservation merge
provisioningState

Current state of the reservation.
provisioningSubState

The provisioning sub-state of the reservation, e.g. Succeeded NOTE: This property will not be serialized. It can only be populated by the server.
purchaseDate

This is the date when the reservation was purchased.
purchaseDateTime

This is the date-time when the reservation was purchased.
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.
renewDestination

Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
renewProperties

The renew properties for a reservation.
renewSource

Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.
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.
skuDescription

Description of the sku in english.
splitProperties

Properties of reservation split
swapProperties

Properties of reservation swap
term

Represent the term of reservation.
userFriendlyAppliedScopeType

The applied scope type of the reservation for display, e.g. Shared NOTE: This property will not be serialized. It can only be populated by the server.
userFriendlyRenewState

The renew state of the reservation for display, e.g. On NOTE: This property will not be serialized. It can only be populated by the server.
utilization

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

Property Value

AppliedScopeProperties

appliedScopes

The list of applied scopes

appliedScopes?: string[]

Property Value

string[]

appliedScopeType

The applied scope type

appliedScopeType?: string

Property Value

string

archived

Indicates if the reservation is archived

archived?: boolean

Property Value

boolean

benefitStartTime

This is the DateTime when the reservation benefit started.

benefitStartTime?: Date

Property Value

Date

billingPlan

The billing plan options available for this sku.

billingPlan?: string

Property Value

string

billingScopeId

Subscription that will be charged for purchasing reservation or savings plan

billingScopeId?: string

Property Value

string

capabilities

Capabilities of the reservation

capabilities?: string

Property Value

string

displayName

Friendly name for user to easily identify the reservation

displayName?: string

Property Value

string

displayProvisioningState

The provisioning state of the reservation for display, e.g. Succeeded NOTE: This property will not be serialized. It can only be populated by the server.

displayProvisioningState?: string

Property Value

string

effectiveDateTime

DateTime of the reservation starting when this version is effective from.

effectiveDateTime?: Date

Property Value

Date

expiryDate

This is the date when the reservation will expire.

expiryDate?: Date

Property Value

Date

expiryDateTime

This is the date-time when the reservation will expire.

expiryDateTime?: Date

Property Value

Date

extendedStatusInfo

The message giving detailed information about the status code.

extendedStatusInfo?: ExtendedStatusInfo

Property Value

ExtendedStatusInfo

instanceFlexibility

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

instanceFlexibility?: string

Property Value

string

lastUpdatedDateTime

DateTime of the last time the reservation was updated. NOTE: This property will not be serialized. It can only be populated by the server.

lastUpdatedDateTime?: Date

Property Value

Date

mergeProperties

Properties of reservation merge

mergeProperties?: ReservationMergeProperties

Property Value

ReservationMergeProperties

provisioningState

Current state of the reservation.

provisioningState?: string

Property Value

string

provisioningSubState

The provisioning sub-state of the reservation, e.g. Succeeded NOTE: This property will not be serialized. It can only be populated by the server.

provisioningSubState?: string

Property Value

string

purchaseDate

This is the date when the reservation was purchased.

purchaseDate?: Date

Property Value

Date

purchaseDateTime

This is the date-time when the reservation was purchased.

purchaseDateTime?: Date

Property Value

Date

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

renewDestination

Reservation Id of the reservation which is purchased because of renew. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.

renewDestination?: string

Property Value

string

renewProperties

The renew properties for a reservation.

renewProperties?: RenewPropertiesResponse

Property Value

RenewPropertiesResponse

renewSource

Reservation Id of the reservation from which this reservation is renewed. Format of the resource Id is /providers/Microsoft.Capacity/reservationOrders/{reservationOrderId}/reservations/{reservationId}.

renewSource?: string

Property Value

string

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

skuDescription

Description of the sku in english.

skuDescription?: string

Property Value

string

splitProperties

Properties of reservation split

splitProperties?: ReservationSplitProperties

Property Value

ReservationSplitProperties

swapProperties

Properties of reservation swap

swapProperties?: ReservationSwapProperties

Property Value

ReservationSwapProperties

term

Represent the term of reservation.

term?: string

Property Value

string

userFriendlyAppliedScopeType

The applied scope type of the reservation for display, e.g. Shared NOTE: This property will not be serialized. It can only be populated by the server.

userFriendlyAppliedScopeType?: string

Property Value

string

userFriendlyRenewState

The renew state of the reservation for display, e.g. On NOTE: This property will not be serialized. It can only be populated by the server.

userFriendlyRenewState?: string

Property Value

string

utilization

Reservation utilization NOTE: This property will not be serialized. It can only be populated by the server.

utilization?: ReservationsPropertiesUtilization

Property Value

ReservationsPropertiesUtilization