CapacityReservationUpdate interface
Specifies information about the capacity reservation. sku.capacity cannot be updated for Block Capacity Reservation. Tags can be update for all Capacity Reservation Types.
- Extends
Properties
| instance |
The Capacity reservation instance view. NOTE: This property will not be serialized. It can only be populated by the server. |
| 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. NOTE: This property will not be serialized. It can only be populated by the server. |
| provisioning |
The provisioning state, which only appears in the response. NOTE: This property will not be serialized. It can only be populated by the server. |
| provisioning |
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. |
| reservation |
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. |
| schedule |
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. |
| 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. 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. Note: The SKU name and capacity cannot be updated for Block capacity reservations. |
| time |
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. |
| virtual |
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. |
Inherited Properties
| tags | Resource tags |
Property Details
instanceView
The Capacity reservation instance view. NOTE: This property will not be serialized. It can only be populated by the server.
instanceView?: CapacityReservationInstanceViewProperty 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. NOTE: This property will not be serialized. It can only be populated by the server.
platformFaultDomainCount?: numberProperty 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?: stringProperty 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?: DateProperty 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?: stringProperty Value
string
scheduleProfile
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?: ScheduleProfileProperty Value
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. 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. Note: The SKU name and capacity cannot be updated for Block capacity reservations.
sku?: SkuProperty Value
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?: DateProperty 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
Inherited Property Details
tags
Resource tags
tags?: {[propertyName: string]: string}Property Value
{[propertyName: string]: string}
Inherited From UpdateResource.tags