CapacityReservationGroupProperties Class

capacity reservation group Properties.

Constructor

CapacityReservationGroupProperties()

Variables

Name Description
capacityReservations
list[<xref:"SubResourceReadOnly">]

A list of all capacity reservation resource ids that belong to capacity reservation group.

virtualMachinesAssociated
list[<xref:"SubResourceReadOnly">]

A list of references to all virtual machines associated to the capacity reservation group.

instanceView
<xref:<xref:"CapacityReservationGroupInstanceView">>

The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.

sharingProfile
<xref:<xref:"ResourceSharingProfile">>

Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.

reservationType
Union[str, <xref:"ReservationType">]

Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations that enable a VM to consume capacity only from this capacity block when it is associated using a capacity reservation group, 'Targeted' for reservations that enable a VM to consume capacity from an explicitly associated capacity reservation group and fall back to the publicly available capacity if the reservation is full, and 'Open' for reservations that a VM consumes when it is eligible from an implicitly associated capacity reservation group with the matching VM size and zone without associating that capacity reservation group and fall back to the publicly available capacity if the reservation is full. The reservation type is immutable and cannot be changed after the capacity reservation group is created. Known values are: "Targeted", "Block", and "Open".

Attributes

capacityReservations

A list of all capacity reservation resource ids that belong to capacity reservation group.

capacityReservations: list['SubResourceReadOnly']

instanceView

The capacity reservation group instance view which has the list of instance views for all the capacity reservations that belong to the capacity reservation group.

instanceView: CapacityReservationGroupInstanceView

reservationType

Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations that enable a VM to consume capacity only from this capacity block when it is associated using a capacity reservation group, 'Targeted' for reservations that enable a VM to consume capacity from an explicitly associated capacity reservation group and fall back to the publicly available capacity if the reservation is full, and 'Open' for reservations that a VM consumes when it is eligible from an implicitly associated capacity reservation group with the matching VM size and zone without associating that capacity reservation group and fall back to the publicly available capacity if the reservation is full. The reservation type is immutable and cannot be changed after the capacity reservation group is created. Known values are: "Targeted", "Block", and "Open".

reservationType: str | ReservationType

sharingProfile

Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. The capacity reservation group resource can generally be shared across subscriptions belonging to a single Azure AAD tenant or across AAD tenants if there is a trust relationship established between the tenants. Block capacity reservation does not support sharing across subscriptions. Note: Minimum api-version: 2023-09-01. Please refer to https://aka.ms/computereservationsharing for more details.

sharingProfile: ResourceSharingProfile

virtualMachinesAssociated

A list of references to all virtual machines associated to the capacity reservation group.

virtualMachinesAssociated: list['SubResourceReadOnly']