CapacityReservationProperties interface
Properties of the Capacity reservation.
Properties
| instance |
The Capacity reservation instance view. |
| platform |
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. |
| provisioning |
The provisioning state, which only appears in the response. |
| provisioning |
The date time when the capacity reservation was last updated. |
| reservation |
A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. |
| schedule |
Defines the schedule for Block and Future capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. For Block capacity reservations, the scheduleProfile, start, and end fields are immutable after creation. Please refer to https://aka.ms/blockcapacityreservation for more details. Minimum API version for Block capacity reservations: 2025-04-01. Future capacity reservations must use this property with only a start time, which can be changed until the ‘modifiableUntil’ time. Please refer to https://aka.ms/futurecapacityreservation for more details. Minimum API version for Future capacity reservations: 2026-04-01. |
| time |
Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. |
| virtual |
A list of all virtual machine resource ids that are associated with the capacity reservation. |
Property Details
instanceView
The Capacity reservation instance view.
instanceView?: CapacityReservationInstanceView
Property Value
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.
platformFaultDomainCount?: number
Property Value
number
provisioningState
The provisioning state, which only appears in the response.
provisioningState?: string
Property Value
string
provisioningTime
The date time when the capacity reservation was last updated.
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.
reservationId?: string
Property Value
string
scheduleProfile
Defines the schedule for Block and Future capacity reservations. Specifies the schedule during which capacity reservation is active and VM or VMSS resource can be allocated using reservation. For Block capacity reservations, the scheduleProfile, start, and end fields are immutable after creation. Please refer to https://aka.ms/blockcapacityreservation for more details. Minimum API version for Block capacity reservations: 2025-04-01. Future capacity reservations must use this property with only a start time, which can be changed until the ‘modifiableUntil’ time. Please refer to https://aka.ms/futurecapacityreservation for more details. Minimum API version for Future capacity reservations: 2026-04-01.
scheduleProfile?: ScheduleProfile
Property Value
timeCreated
Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01.
timeCreated?: Date
Property Value
Date
virtualMachinesAssociated
A list of all virtual machine resource ids that are associated with the capacity reservation.
virtualMachinesAssociated?: SubResourceReadOnly[]