Reservation interface

  • Reference
Package:
@azure/arm-billing

The definition of the reservation.

Extends
ProxyResource

Properties

aggregates

The array of aggregates of a reservation's utilization
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 array of applied scopes of a reservation. Will be null if the reservation is in Shared scope
appliedScopeType

The applied scope type of the reservation. NOTE: This property will not be serialized. It can only be populated by the server.
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 NOTE: This property will not be serialized. It can only be populated by the server.
capabilities

Capabilities of the reservation
displayName

The display name of the reservation NOTE: This property will not be serialized. It can only be populated by the server.
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

The effective date time of the reservation NOTE: This property will not be serialized. It can only be populated by the server.
etag
expiryDate

The expiry date of the reservation NOTE: This property will not be serialized. It can only be populated by the server.
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.
location

The location of the reservation.
mergeProperties

Properties of reservation merge
productCode

Represents UPN
provisioningState

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

The provisioning 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

The number of the reservation. NOTE: This property will not be serialized. It can only be populated by the server.
renew

The renew state of the reservation NOTE: This property will not be serialized. It can only be populated by the server.
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

The renew source of the reservation NOTE: This property will not be serialized. It can only be populated by the server.
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 sku information associated to this reservation
skuDescription

The sku description of the reservation NOTE: This property will not be serialized. It can only be populated by the server.
splitProperties

Properties of reservation split
swapProperties

Properties of reservation swap
tags

Tags for this reservation
term

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

last 7 day utilization trend for a reservation NOTE: This property will not be serialized. It can only be populated by the server.
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.

Inherited Properties

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

aggregates

The array of aggregates of a reservation's utilization

aggregates?: ReservationUtilizationAggregates[]

Property Value

ReservationUtilizationAggregates[]

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

The array of applied scopes of a reservation. Will be null if the reservation is in Shared scope

appliedScopes?: string[]

Property Value

string[]

appliedScopeType

The applied scope type of the reservation. NOTE: This property will not be serialized. It can only be populated by the server.

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 NOTE: This property will not be serialized. It can only be populated by the server.

billingScopeId?: string

Property Value

string

capabilities

Capabilities of the reservation

capabilities?: string

Property Value

string

displayName

The display name of the reservation NOTE: This property will not be serialized. It can only be populated by the server.

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

The effective date time of the reservation NOTE: This property will not be serialized. It can only be populated by the server.

effectiveDateTime?: Date

Property Value

Date

etag 

etag?: number

Property Value

number

expiryDate

The expiry date of the reservation NOTE: This property will not be serialized. It can only be populated by the server.

expiryDate?: string

Property Value

string

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

Property Value

ReservationExtendedStatusInfo

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

location

The location of the reservation.

location?: string

Property Value

string

mergeProperties

Properties of reservation merge

mergeProperties?: ReservationMergeProperties

Property Value

ReservationMergeProperties

productCode

Represents UPN

productCode?: string

Property Value

string

provisioningState

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

provisioningState?: string

Property Value

string

provisioningSubState

The provisioning 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

The number of the reservation. NOTE: This property will not be serialized. It can only be populated by the server.

quantity?: number

Property Value

number

renew

The renew state of the reservation NOTE: This property will not be serialized. It can only be populated by the server.

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

The renew source of the reservation NOTE: This property will not be serialized. It can only be populated by the server.

renewSource?: string

Property Value

string

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 sku information associated to this reservation

sku?: ReservationSkuProperty

Property Value

ReservationSkuProperty

skuDescription

The sku description of the reservation NOTE: This property will not be serialized. It can only be populated by the server.

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

tags

Tags for this reservation

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

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

trend

last 7 day utilization trend for a reservation NOTE: This property will not be serialized. It can only be populated by the server.

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

Inherited Property Details

id

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type