Share via

CapacityReservation interface

Package:
@azure/arm-compute

Specifies information about the capacity reservation.

Extends
TrackedResource

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

The availability zones.

Inherited Properties

id

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

The geo-location where the resource lives
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.
tags

Resource tags.
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

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

The availability zones.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /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 TrackedResource.id

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From TrackedResource.location

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 TrackedResource.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 TrackedResource.systemData

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From TrackedResource.tags

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 TrackedResource.type