1. Packages
  2. Azure Native v2
  3. API Docs
  4. compute
  5. CapacityReservationGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native-v2.compute.CapacityReservationGroup

Explore with Pulumi AI

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. Azure REST API version: 2023-03-01. Prior API version in Azure Native 1.x: 2021-04-01.

Other available API versions: 2023-07-01, 2023-09-01, 2024-03-01, 2024-07-01.

Example Usage

Create or update a capacity reservation group.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var capacityReservationGroup = new AzureNative.Compute.CapacityReservationGroup("capacityReservationGroup", new()
    {
        CapacityReservationGroupName = "myCapacityReservationGroup",
        Location = "westus",
        ResourceGroupName = "myResourceGroup",
        Tags = 
        {
            { "department", "finance" },
        },
        Zones = new[]
        {
            "1",
            "2",
        },
    });

});
Copy
package main

import (
	compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := compute.NewCapacityReservationGroup(ctx, "capacityReservationGroup", &compute.CapacityReservationGroupArgs{
			CapacityReservationGroupName: pulumi.String("myCapacityReservationGroup"),
			Location:                     pulumi.String("westus"),
			ResourceGroupName:            pulumi.String("myResourceGroup"),
			Tags: pulumi.StringMap{
				"department": pulumi.String("finance"),
			},
			Zones: pulumi.StringArray{
				pulumi.String("1"),
				pulumi.String("2"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.CapacityReservationGroup;
import com.pulumi.azurenative.compute.CapacityReservationGroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var capacityReservationGroup = new CapacityReservationGroup("capacityReservationGroup", CapacityReservationGroupArgs.builder()
            .capacityReservationGroupName("myCapacityReservationGroup")
            .location("westus")
            .resourceGroupName("myResourceGroup")
            .tags(Map.of("department", "finance"))
            .zones(            
                "1",
                "2")
            .build());

    }
}
Copy
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const capacityReservationGroup = new azure_native.compute.CapacityReservationGroup("capacityReservationGroup", {
    capacityReservationGroupName: "myCapacityReservationGroup",
    location: "westus",
    resourceGroupName: "myResourceGroup",
    tags: {
        department: "finance",
    },
    zones: [
        "1",
        "2",
    ],
});
Copy
import pulumi
import pulumi_azure_native as azure_native

capacity_reservation_group = azure_native.compute.CapacityReservationGroup("capacityReservationGroup",
    capacity_reservation_group_name="myCapacityReservationGroup",
    location="westus",
    resource_group_name="myResourceGroup",
    tags={
        "department": "finance",
    },
    zones=[
        "1",
        "2",
    ])
Copy
resources:
  capacityReservationGroup:
    type: azure-native:compute:CapacityReservationGroup
    properties:
      capacityReservationGroupName: myCapacityReservationGroup
      location: westus
      resourceGroupName: myResourceGroup
      tags:
        department: finance
      zones:
        - '1'
        - '2'
Copy

Create CapacityReservationGroup Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new CapacityReservationGroup(name: string, args: CapacityReservationGroupArgs, opts?: CustomResourceOptions);
@overload
def CapacityReservationGroup(resource_name: str,
                             args: CapacityReservationGroupArgs,
                             opts: Optional[ResourceOptions] = None)

@overload
def CapacityReservationGroup(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             resource_group_name: Optional[str] = None,
                             capacity_reservation_group_name: Optional[str] = None,
                             location: Optional[str] = None,
                             tags: Optional[Mapping[str, str]] = None,
                             zones: Optional[Sequence[str]] = None)
func NewCapacityReservationGroup(ctx *Context, name string, args CapacityReservationGroupArgs, opts ...ResourceOption) (*CapacityReservationGroup, error)
public CapacityReservationGroup(string name, CapacityReservationGroupArgs args, CustomResourceOptions? opts = null)
public CapacityReservationGroup(String name, CapacityReservationGroupArgs args)
public CapacityReservationGroup(String name, CapacityReservationGroupArgs args, CustomResourceOptions options)
type: azure-native:compute:CapacityReservationGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. CapacityReservationGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. CapacityReservationGroupArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. CapacityReservationGroupArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. CapacityReservationGroupArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. CapacityReservationGroupArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var capacityReservationGroupResource = new AzureNative.Compute.CapacityReservationGroup("capacityReservationGroupResource", new()
{
    ResourceGroupName = "string",
    CapacityReservationGroupName = "string",
    Location = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Zones = new[]
    {
        "string",
    },
});
Copy
example, err := compute.NewCapacityReservationGroup(ctx, "capacityReservationGroupResource", &compute.CapacityReservationGroupArgs{
	ResourceGroupName:            "string",
	CapacityReservationGroupName: "string",
	Location:                     "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
	Zones: []string{
		"string",
	},
})
Copy
var capacityReservationGroupResource = new CapacityReservationGroup("capacityReservationGroupResource", CapacityReservationGroupArgs.builder()
    .resourceGroupName("string")
    .capacityReservationGroupName("string")
    .location("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .zones("string")
    .build());
Copy
capacity_reservation_group_resource = azure_native.compute.CapacityReservationGroup("capacityReservationGroupResource",
    resource_group_name=string,
    capacity_reservation_group_name=string,
    location=string,
    tags={
        string: string,
    },
    zones=[string])
Copy
const capacityReservationGroupResource = new azure_native.compute.CapacityReservationGroup("capacityReservationGroupResource", {
    resourceGroupName: "string",
    capacityReservationGroupName: "string",
    location: "string",
    tags: {
        string: "string",
    },
    zones: ["string"],
});
Copy
type: azure-native:compute:CapacityReservationGroup
properties:
    capacityReservationGroupName: string
    location: string
    resourceGroupName: string
    tags:
        string: string
    zones:
        - string
Copy

CapacityReservationGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The CapacityReservationGroup resource accepts the following input properties:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
CapacityReservationGroupName Changes to this property will trigger replacement. string
The name of the capacity reservation group.
Location string
Resource location
Tags Dictionary<string, string>
Resource tags
Zones List<string>
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.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
CapacityReservationGroupName Changes to this property will trigger replacement. string
The name of the capacity reservation group.
Location string
Resource location
Tags map[string]string
Resource tags
Zones []string
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
capacityReservationGroupName Changes to this property will trigger replacement. String
The name of the capacity reservation group.
location String
Resource location
tags Map<String,String>
Resource tags
zones List<String>
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
capacityReservationGroupName Changes to this property will trigger replacement. string
The name of the capacity reservation group.
location string
Resource location
tags {[key: string]: string}
Resource tags
zones string[]
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.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
capacity_reservation_group_name Changes to this property will trigger replacement. str
The name of the capacity reservation group.
location str
Resource location
tags Mapping[str, str]
Resource tags
zones Sequence[str]
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.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
capacityReservationGroupName Changes to this property will trigger replacement. String
The name of the capacity reservation group.
location String
Resource location
tags Map<String>
Resource tags
zones List<String>
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.

Outputs

All input properties are implicitly available as output properties. Additionally, the CapacityReservationGroup resource produces the following output properties:

CapacityReservations List<Pulumi.AzureNative.Compute.Outputs.SubResourceReadOnlyResponse>
A list of all capacity reservation resource ids that belong to capacity reservation group.
Id string
The provider-assigned unique ID for this managed resource.
InstanceView Pulumi.AzureNative.Compute.Outputs.CapacityReservationGroupInstanceViewResponse
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.
Name string
Resource name
Type string
Resource type
VirtualMachinesAssociated List<Pulumi.AzureNative.Compute.Outputs.SubResourceReadOnlyResponse>
A list of references to all virtual machines associated to the capacity reservation group.
CapacityReservations []SubResourceReadOnlyResponse
A list of all capacity reservation resource ids that belong to capacity reservation group.
Id string
The provider-assigned unique ID for this managed resource.
InstanceView CapacityReservationGroupInstanceViewResponse
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.
Name string
Resource name
Type string
Resource type
VirtualMachinesAssociated []SubResourceReadOnlyResponse
A list of references to all virtual machines associated to the capacity reservation group.
capacityReservations List<SubResourceReadOnlyResponse>
A list of all capacity reservation resource ids that belong to capacity reservation group.
id String
The provider-assigned unique ID for this managed resource.
instanceView CapacityReservationGroupInstanceViewResponse
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.
name String
Resource name
type String
Resource type
virtualMachinesAssociated List<SubResourceReadOnlyResponse>
A list of references to all virtual machines associated to the capacity reservation group.
capacityReservations SubResourceReadOnlyResponse[]
A list of all capacity reservation resource ids that belong to capacity reservation group.
id string
The provider-assigned unique ID for this managed resource.
instanceView CapacityReservationGroupInstanceViewResponse
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.
name string
Resource name
type string
Resource type
virtualMachinesAssociated SubResourceReadOnlyResponse[]
A list of references to all virtual machines associated to the capacity reservation group.
capacity_reservations Sequence[SubResourceReadOnlyResponse]
A list of all capacity reservation resource ids that belong to capacity reservation group.
id str
The provider-assigned unique ID for this managed resource.
instance_view CapacityReservationGroupInstanceViewResponse
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.
name str
Resource name
type str
Resource type
virtual_machines_associated Sequence[SubResourceReadOnlyResponse]
A list of references to all virtual machines associated to the capacity reservation group.
capacityReservations List<Property Map>
A list of all capacity reservation resource ids that belong to capacity reservation group.
id String
The provider-assigned unique ID for this managed resource.
instanceView Property Map
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.
name String
Resource name
type String
Resource type
virtualMachinesAssociated List<Property Map>
A list of references to all virtual machines associated to the capacity reservation group.

Supporting Types

CapacityReservationGroupInstanceViewResponse
, CapacityReservationGroupInstanceViewResponseArgs

CapacityReservations This property is required. List<Pulumi.AzureNative.Compute.Inputs.CapacityReservationInstanceViewWithNameResponse>
List of instance view of the capacity reservations under the capacity reservation group.
CapacityReservations This property is required. []CapacityReservationInstanceViewWithNameResponse
List of instance view of the capacity reservations under the capacity reservation group.
capacityReservations This property is required. List<CapacityReservationInstanceViewWithNameResponse>
List of instance view of the capacity reservations under the capacity reservation group.
capacityReservations This property is required. CapacityReservationInstanceViewWithNameResponse[]
List of instance view of the capacity reservations under the capacity reservation group.
capacity_reservations This property is required. Sequence[CapacityReservationInstanceViewWithNameResponse]
List of instance view of the capacity reservations under the capacity reservation group.
capacityReservations This property is required. List<Property Map>
List of instance view of the capacity reservations under the capacity reservation group.

CapacityReservationInstanceViewWithNameResponse
, CapacityReservationInstanceViewWithNameResponseArgs

Name This property is required. string
The name of the capacity reservation.
Statuses List<Pulumi.AzureNative.Compute.Inputs.InstanceViewStatusResponse>
The resource status information.
UtilizationInfo Pulumi.AzureNative.Compute.Inputs.CapacityReservationUtilizationResponse
Unutilized capacity of the capacity reservation.
Name This property is required. string
The name of the capacity reservation.
Statuses []InstanceViewStatusResponse
The resource status information.
UtilizationInfo CapacityReservationUtilizationResponse
Unutilized capacity of the capacity reservation.
name This property is required. String
The name of the capacity reservation.
statuses List<InstanceViewStatusResponse>
The resource status information.
utilizationInfo CapacityReservationUtilizationResponse
Unutilized capacity of the capacity reservation.
name This property is required. string
The name of the capacity reservation.
statuses InstanceViewStatusResponse[]
The resource status information.
utilizationInfo CapacityReservationUtilizationResponse
Unutilized capacity of the capacity reservation.
name This property is required. str
The name of the capacity reservation.
statuses Sequence[InstanceViewStatusResponse]
The resource status information.
utilization_info CapacityReservationUtilizationResponse
Unutilized capacity of the capacity reservation.
name This property is required. String
The name of the capacity reservation.
statuses List<Property Map>
The resource status information.
utilizationInfo Property Map
Unutilized capacity of the capacity reservation.

CapacityReservationUtilizationResponse
, CapacityReservationUtilizationResponseArgs

CurrentCapacity This property is required. int
The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
VirtualMachinesAllocated This property is required. List<Pulumi.AzureNative.Compute.Inputs.SubResourceReadOnlyResponse>
A list of all virtual machines resource ids allocated against the capacity reservation.
CurrentCapacity This property is required. int
The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
VirtualMachinesAllocated This property is required. []SubResourceReadOnlyResponse
A list of all virtual machines resource ids allocated against the capacity reservation.
currentCapacity This property is required. Integer
The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
virtualMachinesAllocated This property is required. List<SubResourceReadOnlyResponse>
A list of all virtual machines resource ids allocated against the capacity reservation.
currentCapacity This property is required. number
The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
virtualMachinesAllocated This property is required. SubResourceReadOnlyResponse[]
A list of all virtual machines resource ids allocated against the capacity reservation.
current_capacity This property is required. int
The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
virtual_machines_allocated This property is required. Sequence[SubResourceReadOnlyResponse]
A list of all virtual machines resource ids allocated against the capacity reservation.
currentCapacity This property is required. Number
The value provides the current capacity of the VM size which was reserved successfully and for which the customer is getting billed. Minimum api-version: 2022-08-01.
virtualMachinesAllocated This property is required. List<Property Map>
A list of all virtual machines resource ids allocated against the capacity reservation.

InstanceViewStatusResponse
, InstanceViewStatusResponseArgs

Code string
The status code.
DisplayStatus string
The short localizable label for the status.
Level string
The level code.
Message string
The detailed status message, including for alerts and error messages.
Time string
The time of the status.
Code string
The status code.
DisplayStatus string
The short localizable label for the status.
Level string
The level code.
Message string
The detailed status message, including for alerts and error messages.
Time string
The time of the status.
code String
The status code.
displayStatus String
The short localizable label for the status.
level String
The level code.
message String
The detailed status message, including for alerts and error messages.
time String
The time of the status.
code string
The status code.
displayStatus string
The short localizable label for the status.
level string
The level code.
message string
The detailed status message, including for alerts and error messages.
time string
The time of the status.
code str
The status code.
display_status str
The short localizable label for the status.
level str
The level code.
message str
The detailed status message, including for alerts and error messages.
time str
The time of the status.
code String
The status code.
displayStatus String
The short localizable label for the status.
level String
The level code.
message String
The detailed status message, including for alerts and error messages.
time String
The time of the status.

SubResourceReadOnlyResponse
, SubResourceReadOnlyResponseArgs

Id This property is required. string
Resource Id
Id This property is required. string
Resource Id
id This property is required. String
Resource Id
id This property is required. string
Resource Id
id This property is required. str
Resource Id
id This property is required. String
Resource Id

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:compute:CapacityReservationGroup myCapacityReservationGroup /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/capacityReservationGroups/{capacityReservationGroupName} 
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0