Package version:

Interface CapacityReservation

Specifies information about the capacity reservation.

interface CapacityReservation {
    id?: string;
    instanceView?: CapacityReservationInstanceView;
    location: string;
    name?: string;
    platformFaultDomainCount?: number;
    provisioningState?: string;
    provisioningTime?: any;
    reservationId?: string;
    sku: Sku;
    tags?: {
        [propertyName: string]: string;
    };
    timeCreated?: any;
    type?: string;
    virtualMachinesAssociated?: SubResourceReadOnly[];
    zones?: string[];
}

Hierarchy (view full)

Properties

id? instanceView? location name? platformFaultDomainCount? provisioningState? provisioningTime? reservationId? sku tags? timeCreated? type? virtualMachinesAssociated? zones?

Properties

Optional Readonlyid

id?: string

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

Optional ReadonlyinstanceView

instanceView?: CapacityReservationInstanceView

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

location

location: string

Resource location

Optional Readonlyname

name?: string

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

Optional ReadonlyplatformFaultDomainCount

platformFaultDomainCount?: number

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.

Optional ReadonlyprovisioningState

provisioningState?: string

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

Optional ReadonlyprovisioningTime

provisioningTime?: any

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.

Optional ReadonlyreservationId

reservationId?: string

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: 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.

Optionaltags

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

Resource tags

Optional ReadonlytimeCreated

timeCreated?: any

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.

Optional Readonlytype

type?: string

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

Optional ReadonlyvirtualMachinesAssociated

virtualMachinesAssociated?: SubResourceReadOnly[]

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.

Optionalzones

zones?: string[]

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.

Settings

Member Visibility