Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. compute
  5. CapacityReservation

We recommend using Azure Native.

Azure v6.22.1 published on Monday, May 12, 2025 by Pulumi
pulumi/pulumi-azure

azure.compute.CapacityReservation

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure v6.22.1 published on Monday, May 12, 2025 by Pulumi
pulumi/pulumi-azure

    Manages a Capacity Reservation within a Capacity Reservation Group.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-rg",
    location: "West Europe",
});
const exampleCapacityReservationGroup = new azure.compute.CapacityReservationGroup("example", {
    name: "example-capacity-reservation-group",
    resourceGroupName: example.name,
    location: example.location,
});
const exampleCapacityReservation = new azure.compute.CapacityReservation("example", {
    name: "example-capacity-reservation",
    capacityReservationGroupId: exampleCapacityReservationGroup.id,
    sku: {
        name: "Standard_D2s_v3",
        capacity: 1,
    },
});

    import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-rg",
    location="West Europe")
example_capacity_reservation_group = azure.compute.CapacityReservationGroup("example",
    name="example-capacity-reservation-group",
    resource_group_name=example.name,
    location=example.location)
example_capacity_reservation = azure.compute.CapacityReservation("example",
    name="example-capacity-reservation",
    capacity_reservation_group_id=example_capacity_reservation_group.id,
    sku={
        "name": "Standard_D2s_v3",
        "capacity": 1,
    })

    package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/compute"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-rg"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		exampleCapacityReservationGroup, err := compute.NewCapacityReservationGroup(ctx, "example", &compute.CapacityReservationGroupArgs{
			Name:              pulumi.String("example-capacity-reservation-group"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
		})
		if err != nil {
			return err
		}
		_, err = compute.NewCapacityReservation(ctx, "example", &compute.CapacityReservationArgs{
			Name:                       pulumi.String("example-capacity-reservation"),
			CapacityReservationGroupId: exampleCapacityReservationGroup.ID(),
			Sku: &compute.CapacityReservationSkuArgs{
				Name:     pulumi.String("Standard_D2s_v3"),
				Capacity: pulumi.Int(1),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-rg",
        Location = "West Europe",
    });

    var exampleCapacityReservationGroup = new Azure.Compute.CapacityReservationGroup("example", new()
    {
        Name = "example-capacity-reservation-group",
        ResourceGroupName = example.Name,
        Location = example.Location,
    });

    var exampleCapacityReservation = new Azure.Compute.CapacityReservation("example", new()
    {
        Name = "example-capacity-reservation",
        CapacityReservationGroupId = exampleCapacityReservationGroup.Id,
        Sku = new Azure.Compute.Inputs.CapacityReservationSkuArgs
        {
            Name = "Standard_D2s_v3",
            Capacity = 1,
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.compute.CapacityReservationGroup;
import com.pulumi.azure.compute.CapacityReservationGroupArgs;
import com.pulumi.azure.compute.CapacityReservation;
import com.pulumi.azure.compute.CapacityReservationArgs;
import com.pulumi.azure.compute.inputs.CapacityReservationSkuArgs;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-rg")
            .location("West Europe")
            .build());

        var exampleCapacityReservationGroup = new CapacityReservationGroup("exampleCapacityReservationGroup", CapacityReservationGroupArgs.builder()
            .name("example-capacity-reservation-group")
            .resourceGroupName(example.name())
            .location(example.location())
            .build());

        var exampleCapacityReservation = new CapacityReservation("exampleCapacityReservation", CapacityReservationArgs.builder()
            .name("example-capacity-reservation")
            .capacityReservationGroupId(exampleCapacityReservationGroup.id())
            .sku(CapacityReservationSkuArgs.builder()
                .name("Standard_D2s_v3")
                .capacity(1)
                .build())
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-rg
      location: West Europe
  exampleCapacityReservationGroup:
    type: azure:compute:CapacityReservationGroup
    name: example
    properties:
      name: example-capacity-reservation-group
      resourceGroupName: ${example.name}
      location: ${example.location}
  exampleCapacityReservation:
    type: azure:compute:CapacityReservation
    name: example
    properties:
      name: example-capacity-reservation
      capacityReservationGroupId: ${exampleCapacityReservationGroup.id}
      sku:
        name: Standard_D2s_v3
        capacity: 1

    Create CapacityReservation Resource

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

    Constructor syntax

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

@overload
def CapacityReservation(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        capacity_reservation_group_id: Optional[str] = None,
                        sku: Optional[CapacityReservationSkuArgs] = None,
                        name: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None,
                        zone: Optional[str] = None)
    func NewCapacityReservation(ctx *Context, name string, args CapacityReservationArgs, opts ...ResourceOption) (*CapacityReservation, error)
    public CapacityReservation(string name, CapacityReservationArgs args, CustomResourceOptions? opts = null)
    public CapacityReservation(String name, CapacityReservationArgs args)
public CapacityReservation(String name, CapacityReservationArgs args, CustomResourceOptions options)

    type: azure:compute:CapacityReservation
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args CapacityReservationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args CapacityReservationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args CapacityReservationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CapacityReservationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CapacityReservationArgs
    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 capacityReservationResource = new Azure.Compute.CapacityReservation("capacityReservationResource", new()
{
    CapacityReservationGroupId = "string",
    Sku = new Azure.Compute.Inputs.CapacityReservationSkuArgs
    {
        Capacity = 0,
        Name = "string",
    },
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Zone = "string",
});

    example, err := compute.NewCapacityReservation(ctx, "capacityReservationResource", &compute.CapacityReservationArgs{
	CapacityReservationGroupId: pulumi.String("string"),
	Sku: &compute.CapacityReservationSkuArgs{
		Capacity: pulumi.Int(0),
		Name:     pulumi.String("string"),
	},
	Name: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Zone: pulumi.String("string"),
})

    var capacityReservationResource = new CapacityReservation("capacityReservationResource", CapacityReservationArgs.builder()
    .capacityReservationGroupId("string")
    .sku(CapacityReservationSkuArgs.builder()
        .capacity(0)
        .name("string")
        .build())
    .name("string")
    .tags(Map.of("string", "string"))
    .zone("string")
    .build());

    capacity_reservation_resource = azure.compute.CapacityReservation("capacityReservationResource",
    capacity_reservation_group_id="string",
    sku={
        "capacity": 0,
        "name": "string",
    },
    name="string",
    tags={
        "string": "string",
    },
    zone="string")

    const capacityReservationResource = new azure.compute.CapacityReservation("capacityReservationResource", {
    capacityReservationGroupId: "string",
    sku: {
        capacity: 0,
        name: "string",
    },
    name: "string",
    tags: {
        string: "string",
    },
    zone: "string",
});

    type: azure:compute:CapacityReservation
properties:
    capacityReservationGroupId: string
    name: string
    sku:
        capacity: 0
        name: string
    tags:
        string: string
    zone: string

    CapacityReservation 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 CapacityReservation resource accepts the following input properties:

    CapacityReservationGroupId string
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    Sku CapacityReservationSku
    A sku block as defined below.
    Name string
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Zone string
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.
    CapacityReservationGroupId string
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    Sku CapacityReservationSkuArgs
    A sku block as defined below.
    Name string
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    Zone string
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.
    capacityReservationGroupId String
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    sku CapacityReservationSku
    A sku block as defined below.
    name String
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    zone String
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.
    capacityReservationGroupId string
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    sku CapacityReservationSku
    A sku block as defined below.
    name string
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    zone string
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.
    capacity_reservation_group_id str
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    sku CapacityReservationSkuArgs
    A sku block as defined below.
    name str
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    zone str
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.
    capacityReservationGroupId String
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    sku Property Map
    A sku block as defined below.
    name String
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.
    zone String
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing CapacityReservation Resource

    Get an existing CapacityReservation resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: CapacityReservationState, opts?: CustomResourceOptions): CapacityReservation
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        capacity_reservation_group_id: Optional[str] = None,
        name: Optional[str] = None,
        sku: Optional[CapacityReservationSkuArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        zone: Optional[str] = None) -> CapacityReservation
    func GetCapacityReservation(ctx *Context, name string, id IDInput, state *CapacityReservationState, opts ...ResourceOption) (*CapacityReservation, error)
    public static CapacityReservation Get(string name, Input<string> id, CapacityReservationState? state, CustomResourceOptions? opts = null)
    public static CapacityReservation get(String name, Output<String> id, CapacityReservationState state, CustomResourceOptions options)
    resources:  _:    type: azure:compute:CapacityReservation    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CapacityReservationGroupId string
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    Sku CapacityReservationSku
    A sku block as defined below.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Zone string
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.
    CapacityReservationGroupId string
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    Sku CapacityReservationSkuArgs
    A sku block as defined below.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    Zone string
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.
    capacityReservationGroupId String
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    sku CapacityReservationSku
    A sku block as defined below.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    zone String
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.
    capacityReservationGroupId string
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    sku CapacityReservationSku
    A sku block as defined below.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    zone string
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.
    capacity_reservation_group_id str
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    sku CapacityReservationSkuArgs
    A sku block as defined below.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    zone str
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.
    capacityReservationGroupId String
    The ID of the Capacity Reservation Group where the Capacity Reservation exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of this Capacity Reservation. Changing this forces a new resource to be created.
    sku Property Map
    A sku block as defined below.
    tags Map<String>
    A mapping of tags to assign to the resource.
    zone String
    Specifies the Availability Zone for this Capacity Reservation. Changing this forces a new resource to be created.

    Supporting Types

    CapacityReservationSku, CapacityReservationSkuArgs

    Capacity int
    Specifies the number of instances to be reserved. It must be greater than or equal to 0 and not exceed the quota in the subscription.
    Name string
    Name of the sku, such as Standard_F2. Changing this forces a new resource to be created.
    Capacity int
    Specifies the number of instances to be reserved. It must be greater than or equal to 0 and not exceed the quota in the subscription.
    Name string
    Name of the sku, such as Standard_F2. Changing this forces a new resource to be created.
    capacity Integer
    Specifies the number of instances to be reserved. It must be greater than or equal to 0 and not exceed the quota in the subscription.
    name String
    Name of the sku, such as Standard_F2. Changing this forces a new resource to be created.
    capacity number
    Specifies the number of instances to be reserved. It must be greater than or equal to 0 and not exceed the quota in the subscription.
    name string
    Name of the sku, such as Standard_F2. Changing this forces a new resource to be created.
    capacity int
    Specifies the number of instances to be reserved. It must be greater than or equal to 0 and not exceed the quota in the subscription.
    name str
    Name of the sku, such as Standard_F2. Changing this forces a new resource to be created.
    capacity Number
    Specifies the number of instances to be reserved. It must be greater than or equal to 0 and not exceed the quota in the subscription.
    name String
    Name of the sku, such as Standard_F2. Changing this forces a new resource to be created.

    Import

    Capacity Reservations can be imported using the resource id, e.g.

    $ pulumi import azure:compute/capacityReservation:CapacityReservation example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Compute/capacityReservationGroups/capacityReservationGroup1/capacityReservations/capacityReservation1

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

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure v6.22.1 published on Monday, May 12, 2025 by Pulumi
    pulumi/pulumi-azure