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

Resource

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	Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones.

Inherited Properties

id	Resource Id NOTE: This property will not be serialized. It can only be populated by the server.
location	Resource location
name	Resource name NOTE: This property will not be serialized. It can only be populated by the server.
tags	Resource tags
type	Resource type 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

Availability Zones to use for this capacity reservation group. The zones can be assigned only during creation. If not provided, the group supports only regional resources in the region. If provided, enforces each capacity reservation in the group to be in one of the zones.

zones?: string[]

Property Value

string[]

Inherited Property Details

id

Resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From Resource.id

location

Resource location

location: string

Property Value

string

Inherited From Resource.location

name

Resource name NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From Resource.name

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From Resource.tags

type

Resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From Resource.type