Reservation interface

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

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

appliedScopes?: string[]

Property Value

The applied scope type of the reservation.

appliedScopeType?: string

Property Value

Indicates if the reservation is archived

archived?: boolean

Property Value

This is the DateTime when the reservation benefit started.

benefitStartTime?: Date

Property Value

The billing plan options available for this sku.

billingPlan?: string

Property Value

Subscription that will be charged for purchasing reservation or savings plan

billingScopeId?: string

Property Value

Capabilities of the reservation

capabilities?: string

Property Value

The display name of the reservation

displayName?: string

Property Value

The provisioning state of the reservation for display, e.g. Succeeded

displayProvisioningState?: string

Property Value

The effective date time of the reservation

effectiveDateTime?: Date

Property Value

etag?: number

Property Value

The expiry date of the reservation

expiryDate?: string

Property Value

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

expiryDateTime?: Date

Property Value

The message giving detailed information about the status code.

extendedStatusInfo?: ReservationExtendedStatusInfo

Property Value

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

DateTime of the last time the reservation was updated.

lastUpdatedDateTime?: Date

Property Value

The location of the reservation.

location?: string

Property Value

Properties of reservation merge

mergeProperties?: ReservationMergeProperties

Property Value

Represents UPN

productCode?: string

Property Value

The provisioning state of the reservation, e.g. Succeeded

provisioningState?: string

Property Value

The provisioning state of the reservation, e.g. Succeeded

provisioningSubState?: string

Property Value

This is the date when the reservation was purchased.

purchaseDate?: Date

Property Value

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

purchaseDateTime?: Date

Property Value

The number of the reservation.

quantity?: number

Property Value

The renew state of the reservation

renew?: boolean

Property Value

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

The renew properties for a reservation.

renewProperties?: RenewPropertiesResponse

Property Value

The renew source of the reservation

renewSource?: string

Property Value

The reserved source type of the reservation, e.g. virtual machine.

reservedResourceType?: string

Property Value

This is the date-time when the Azure Hybrid Benefit needs to be reviewed.

reviewDateTime?: Date

Property Value

The sku information associated to this reservation

sku?: ReservationSkuProperty

Property Value

The sku description of the reservation

skuDescription?: string

Property Value

Properties of reservation split

splitProperties?: ReservationSplitProperties

Property Value

Properties of reservation swap

swapProperties?: ReservationSwapProperties

Property Value

Tags for this reservation

tags?: Record<string, string>

Property Value

The term of the reservation, e.g. P1Y

term?: string

Property Value

The applied scope type of the reservation for display, e.g. Shared

userFriendlyAppliedScopeType?: string

Property Value

The renew state of the reservation for display, e.g. On

userFriendlyRenewState?: string

Property Value

Reservation utilization

utilization?: ReservationPropertyUtilization

Property Value

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

Inherited From ProxyResource.id

The name of the resource

name?: string

Property Value

Inherited From ProxyResource.name

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From ProxyResource.systemData

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

Inherited From ProxyResource.type