Share via

CapacityReservationGroup interface

Package:
@azure/arm-compute

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
TrackedResource

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.
sharingProfile

Specifies the settings to enable sharing across subscriptions for the capacity reservation group resource. Pls. keep in mind the capacity reservation group resource generally can be shared across subscriptions belonging to a single azure AAD tenant or cross AAD tenant if there is a trust relationship established between the AAD tenants. 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.
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.
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.
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

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

instanceView?: CapacityReservationGroupInstanceView

Property Value

CapacityReservationGroupInstanceView

sharingProfile

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

sharingProfile?: ResourceSharingProfile

Property Value

ResourceSharingProfile

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

SubResourceReadOnly[]

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?: string

Property Value

string

Inherited From TrackedResource.id

location

The geo-location where the resource lives

location: string

Property 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?: string

Property 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?: SystemData

Property Value

SystemData

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?: string

Property Value

string

Inherited From TrackedResource.type