CapacityReservation interface

The Capacity reservation instance view.

instanceView?: CapacityReservationInstanceView

Property Value

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.

platformFaultDomainCount?: number

Property Value

The provisioning state, which only appears in the response.

provisioningState?: string

Property Value

The date time when the capacity reservation was last updated.

provisioningTime?: Date

Property Value

A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource.

reservationId?: string

Property Value

Defines the schedule for Block-type capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. This property is required and only supported when the capacity reservation group type is 'Block'. The scheduleProfile, start, and end fields are immutable after creation. Minimum API version: 2025-04-01. Please refer to https://aka.ms/blockcapacityreservation for more details.

scheduleProfile?: ScheduleProfile

Property Value

SKU of the resource for which capacity needs be reserved. The SKU name and capacity is required to be set. For Block capacity reservations, sku.capacity can only accept values 1, 2, 4, 8, 16, 32, 64. Currently VM Skus with the capability called 'CapacityReservationSupported' set to true are supported. When 'CapacityReservationSupported' is true, the SKU capability also specifies the 'SupportedCapacityReservationTypes', which lists the types of capacity reservations (such as Targeted or Block) that the SKU supports. 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

Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.

timeCreated?: Date

Property Value

A list of all virtual machine resource ids that are associated with the capacity reservation.

virtualMachinesAssociated?: SubResourceReadOnly[]

Property Value

The availability zones.

zones?: string[]

Property Value

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

id?: string

Property Value

Inherited From TrackedResource.id

The geo-location where the resource lives

location: string

Property Value

Inherited From TrackedResource.location

The name of the resource

name?: string

Property Value

Inherited From TrackedResource.name

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

Inherited From TrackedResource.systemData

Resource tags.

tags?: Record<string, string>

Property Value

Inherited From TrackedResource.tags

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

type?: string

Property Value

Inherited From TrackedResource.type