CapacityReservation interface

  • Reference
Package:
@azure/arm-compute

Specifies information about the capacity reservation.

Extends
Resource

Properties

instanceView

The Capacity reservation instance view. NOTE: This property will not be serialized. It can only be populated by the server.
platformFaultDomainCount

Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. Note: The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningTime

The date time when the capacity reservation was last updated. NOTE: This property will not be serialized. It can only be populated by the server.
reservationId

A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
sku

SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.
timeCreated

Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. NOTE: This property will not be serialized. It can only be populated by the server.
virtualMachinesAssociated

A list of all virtual machine resource ids that are associated with the capacity reservation. NOTE: This property will not be serialized. It can only be populated by the server.
zones

Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone.

Inherited Properties

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location

Resource location
name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags

Resource tags
type

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

Property Details

instanceView

The Capacity reservation instance view. NOTE: This property will not be serialized. It can only be populated by the server.

instanceView?: CapacityReservationInstanceView

Property Value

CapacityReservationInstanceView

platformFaultDomainCount

Specifies the value of fault domain count that Capacity Reservation supports for requested VM size. Note: The fault domain count specified for a resource (like virtual machines scale set) must be less than or equal to this value if it deploys using capacity reservation. Minimum api-version: 2022-08-01. NOTE: This property will not be serialized. It can only be populated by the server.

platformFaultDomainCount?: number

Property Value

number

provisioningState

The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

provisioningTime

The date time when the capacity reservation was last updated. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningTime?: Date

Property Value

Date

reservationId

A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

reservationId?: string

Property Value

string

sku

SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. Refer to List Microsoft.Compute SKUs in a region (https://docs.microsoft.com/rest/api/compute/resourceskus/list) for supported values.

sku: Sku

Property Value

Sku

timeCreated

Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. NOTE: This property will not be serialized. It can only be populated by the server.

timeCreated?: Date

Property Value

Date

virtualMachinesAssociated

A list of all virtual machine resource ids that are associated with the capacity reservation. NOTE: This property will not be serialized. It can only be populated by the server.

virtualMachinesAssociated?: SubResourceReadOnly[]

Property Value

SubResourceReadOnly[]

zones

Availability Zone to use for this capacity reservation. The zone has to be single value and also should be part for the list of zones specified during the capacity reservation group creation. The zone can be assigned only during creation. If not provided, the reservation supports only non-zonal deployments. If provided, enforces VM/VMSS using this capacity reservation to be in same zone.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

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

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location

location: string

Property Value

string

Inherited From Resource.location

name

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

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags

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

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

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

type?: string

Property Value

string

Inherited From Resource.type