Share via


CapacityReservationGroupUpdate interface

Specifies information about the capacity reservation group. Only tags can be updated.

Extends

Properties

capacityReservations

A list of all capacity reservation resource ids that belong to capacity reservation group. NOTE: This property will not be serialized. It can only be populated by the server.

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. NOTE: This property will not be serialized. It can only be populated by the server.

reservationType

Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations and 'Targeted' for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned.

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.

virtualMachinesAssociated

A list of references to all virtual machines associated to the capacity reservation group. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

tags

Resource tags

Property Details

capacityReservations

A list of all capacity reservation resource ids that belong to capacity reservation group. NOTE: This property will not be serialized. It can only be populated by the server.

capacityReservations?: SubResourceReadOnly[]

Property Value

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. NOTE: This property will not be serialized. It can only be populated by the server.

instanceView?: CapacityReservationGroupInstanceView

Property Value

reservationType

Indicates the type of capacity reservation. Allowed values are 'Block' for block capacity reservations and 'Targeted' for reservations that enable a VM to consume a specific capacity reservation when a capacity reservation group is provided. The reservation type is immutable and cannot be changed after it is assigned.

reservationType?: string

Property Value

string

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

Property Value

virtualMachinesAssociated

A list of references to all virtual machines associated to the capacity reservation group. 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