Azure Classic

Pulumi Official
Package maintained by Pulumi
v5.10.0 published on Friday, Jun 10, 2022 by Pulumi

CapacityReservation

Manages a Capacity Reservation within a Capacity Reservation Group.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
    public MyStack()
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
        {
            Location = "West Europe",
        });
        var exampleCapacityReservationGroup = new Azure.Compute.CapacityReservationGroup("exampleCapacityReservationGroup", new Azure.Compute.CapacityReservationGroupArgs
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.Location,
        });
        var exampleCapacityReservation = new Azure.Compute.CapacityReservation("exampleCapacityReservation", new Azure.Compute.CapacityReservationArgs
        {
            CapacityReservationGroupId = exampleCapacityReservationGroup.Id,
            Sku = new Azure.Compute.Inputs.CapacityReservationSkuArgs
            {
                Name = "Standard_D2s_v3",
                Capacity = 1,
            },
        });
    }

}
package main

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

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

import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;

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

    public static void stack(Context ctx) {
        var exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
            .location("West Europe")
            .build());

        var exampleCapacityReservationGroup = new CapacityReservationGroup("exampleCapacityReservationGroup", CapacityReservationGroupArgs.builder()        
            .resourceGroupName(exampleResourceGroup.name())
            .location(exampleResourceGroup.location())
            .build());

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

    }
}
import pulumi
import pulumi_azure as azure

example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_capacity_reservation_group = azure.compute.CapacityReservationGroup("exampleCapacityReservationGroup",
    resource_group_name=example_resource_group.name,
    location=example_resource_group.location)
example_capacity_reservation = azure.compute.CapacityReservation("exampleCapacityReservation",
    capacity_reservation_group_id=example_capacity_reservation_group.id,
    sku=azure.compute.CapacityReservationSkuArgs(
        name="Standard_D2s_v3",
        capacity=1,
    ))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleCapacityReservationGroup = new azure.compute.CapacityReservationGroup("exampleCapacityReservationGroup", {
    resourceGroupName: exampleResourceGroup.name,
    location: exampleResourceGroup.location,
});
const exampleCapacityReservation = new azure.compute.CapacityReservation("exampleCapacityReservation", {
    capacityReservationGroupId: exampleCapacityReservationGroup.id,
    sku: {
        name: "Standard_D2s_v3",
        capacity: 1,
    },
});
resources:
  exampleResourceGroup:
    type: azure:core:ResourceGroup
    properties:
      location: West Europe
  exampleCapacityReservationGroup:
    type: azure:compute:CapacityReservationGroup
    properties:
      resourceGroupName: ${exampleResourceGroup.name}
      location: ${exampleResourceGroup.location}
  exampleCapacityReservation:
    type: azure:compute:CapacityReservation
    properties:
      capacityReservationGroupId: ${exampleCapacityReservationGroup.id}
      sku:
        name: Standard_D2s_v3
        capacity: 1

Create a CapacityReservation Resource

new CapacityReservation(name: string, args: CapacityReservationArgs, opts?: CustomResourceOptions);
@overload
def CapacityReservation(resource_name: 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)
@overload
def CapacityReservation(resource_name: str,
                        args: CapacityReservationArgs,
                        opts: Optional[ResourceOptions] = 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.

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.

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

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 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 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 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 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 {[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 an 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)
Resource lookup is not supported in YAML
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 CapacityReservationSkuArgs

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 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 CapacityReservationSkuArgs

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

Capacity int

Specifies the number of instances to be reserved. It must be a positive integer 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 a positive integer 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 a positive integer 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 a positive integer 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 a positive integer 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 a positive integer 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

Package Details

Repository
https://github.com/pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.