CapacityReservationGroup interface
Specifies information about the capacity reservation group that the capacity reservations should be assigned to. Currently, a capacity reservation can only be added to a capacity reservation group at creation time. An existing capacity reservation cannot be added or moved to another capacity reservation group.
- Extends
Properties
| capacity |
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. |
| instance |
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. |
| reservation |
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. |
| sharing |
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. |
| virtual |
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. |
| zones | The availability zones. |
Inherited Properties
| id | Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server. |
| location | The geo-location where the resource lives |
| name | The name of the resource NOTE: This property will not be serialized. It can only be populated by the server. |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server. |
| tags | Resource tags. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server. |
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?: CapacityReservationGroupInstanceViewProperty 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?: stringProperty 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?: ResourceSharingProfileProperty 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
zones
The availability zones.
zones?: string[]Property Value
string[]
Inherited Property Details
id
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
id?: stringProperty Value
string
Inherited From TrackedResource.id
location
The geo-location where the resource lives
location: stringProperty Value
string
Inherited From TrackedResource.location
name
The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
name?: stringProperty Value
string
Inherited From TrackedResource.name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemDataProperty Value
Inherited From TrackedResource.systemData
tags
Resource tags.
tags?: {[propertyName: string]: string}Property Value
{[propertyName: string]: string}
Inherited From TrackedResource.tags
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.
type?: stringProperty Value
string
Inherited From TrackedResource.type