Share via


CapacityReservationGroup Class

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.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to server.

Constructor

CapacityReservationGroup(*, location: str, tags: dict[str, str] | None = None, zones: list[str] | None = None, sharing_profile: _models.ResourceSharingProfile | None = None, reservation_type: str | _models.ReservationType | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
tags

Resource tags.

Default value: None
location
str

The geo-location where the resource lives. Required.

zones

The availability zones.

Default value: None
sharing_profile

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.

Default value: None
reservation_type

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. Known values are: "Targeted" and "Block".

Default value: None

Variables

Name Description
id
str

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

name
str

The name of the resource.

type
str

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

system_data

Azure Resource Manager metadata containing createdBy and modifiedBy information.

tags

Resource tags.

location
str

The geo-location where the resource lives. Required.

zones

The availability zones.

capacity_reservations

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

virtual_machines_associated

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

instance_view

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.

sharing_profile

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.

reservation_type

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. Known values are: "Targeted" and "Block".