CapacityReservation Class
Specifies information about the capacity reservation.
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to server.
Constructor
CapacityReservation(*, location: str, sku: _models.Sku, tags: dict[str, str] | None = None, zones: list[str] | None = None, schedule_profile: _models.ScheduleProfile | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
tags
|
Resource tags. Default value: None
|
|
location
|
The geo-location where the resource lives. Required. |
|
sku
|
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. Required. |
|
zones
|
The availability zones. Default value: None
|
|
schedule_profile
|
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. Default value: None
|
Variables
| Name | Description |
|---|---|
|
id
|
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. |
|
name
|
The name of the resource. |
|
type
|
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
|
system_data
|
Azure Resource Manager metadata containing createdBy and modifiedBy information. |
|
tags
|
Resource tags. |
|
location
|
The geo-location where the resource lives. Required. |
|
sku
|
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. Required. |
|
zones
|
The availability zones. |
|
reservation_id
|
A unique id generated and assigned to the capacity reservation by the platform which does not change throughout the lifetime of the resource. |
|
platform_fault_domain_count
|
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. |
|
virtual_machines_associated
|
A list of all virtual machine resource ids that are associated with the capacity reservation. |
|
provisioning_time
|
The date time when the capacity reservation was last updated. |
|
provisioning_state
|
The provisioning state, which only appears in the response. |
|
instance_view
|
The Capacity reservation instance view. |
|
time_created
|
Specifies the time at which the Capacity Reservation resource was created. Minimum api-version: 2021-11-01. |
|
schedule_profile
|
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. |
