1. Packages
  2. Azure Classic
  3. API Docs
  4. compute
  5. CapacityReservationGroup

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

azure.compute.CapacityReservationGroup

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi

    Manages 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,
    });
    
    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)
    
    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 {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-rg"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		_, 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
    		}
    		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,
        });
    
    });
    
    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 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());
    
        }
    }
    
    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}
    

    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,
                                 location: Optional[str] = None,
                                 name: 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:compute:CapacityReservationGroup
    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 CapacityReservationGroupArgs
    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 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 string
    The unique name of the resource.
    args CapacityReservationGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CapacityReservationGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CapacityReservationGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var capacityReservationGroupResource = new Azure.Compute.CapacityReservationGroup("capacityReservationGroupResource", new()
    {
        ResourceGroupName = "string",
        Location = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Zones = new[]
        {
            "string",
        },
    });
    
    example, err := compute.NewCapacityReservationGroup(ctx, "capacityReservationGroupResource", &compute.CapacityReservationGroupArgs{
    	ResourceGroupName: pulumi.String("string"),
    	Location:          pulumi.String("string"),
    	Name:              pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Zones: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var capacityReservationGroupResource = new CapacityReservationGroup("capacityReservationGroupResource", CapacityReservationGroupArgs.builder()        
        .resourceGroupName("string")
        .location("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .zones("string")
        .build());
    
    capacity_reservation_group_resource = azure.compute.CapacityReservationGroup("capacityReservationGroupResource",
        resource_group_name="string",
        location="string",
        name="string",
        tags={
            "string": "string",
        },
        zones=["string"])
    
    const capacityReservationGroupResource = new azure.compute.CapacityReservationGroup("capacityReservationGroupResource", {
        resourceGroupName: "string",
        location: "string",
        name: "string",
        tags: {
            string: "string",
        },
        zones: ["string"],
    });
    
    type: azure:compute:CapacityReservationGroup
    properties:
        location: string
        name: string
        resourceGroupName: string
        tags:
            string: string
        zones:
            - string
    

    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

    The CapacityReservationGroup resource accepts the following input properties:

    ResourceGroupName string
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    Location string
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Zones List<string>
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.
    ResourceGroupName string
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    Location string
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    Zones []string
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.
    resourceGroupName String
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    location String
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    zones List<String>
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.
    resourceGroupName string
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    location string
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    zones string[]
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.
    resource_group_name str
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    location str
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    zones Sequence[str]
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.
    resourceGroupName String
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    location String
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.
    zones List<String>
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the CapacityReservationGroup 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 CapacityReservationGroup Resource

    Get an existing CapacityReservationGroup 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?: CapacityReservationGroupState, opts?: CustomResourceOptions): CapacityReservationGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            location: Optional[str] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            zones: Optional[Sequence[str]] = None) -> CapacityReservationGroup
    func GetCapacityReservationGroup(ctx *Context, name string, id IDInput, state *CapacityReservationGroupState, opts ...ResourceOption) (*CapacityReservationGroup, error)
    public static CapacityReservationGroup Get(string name, Input<string> id, CapacityReservationGroupState? state, CustomResourceOptions? opts = null)
    public static CapacityReservationGroup get(String name, Output<String> id, CapacityReservationGroupState 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:
    Location string
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    ResourceGroupName string
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    Tags Dictionary<string, string>
    A mapping of tags to assign to the resource.
    Zones List<string>
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.
    Location string
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    Name string
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    ResourceGroupName string
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    Tags map[string]string
    A mapping of tags to assign to the resource.
    Zones []string
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.
    location String
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    resourceGroupName String
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    tags Map<String,String>
    A mapping of tags to assign to the resource.
    zones List<String>
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.
    location string
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    name string
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    resourceGroupName string
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    tags {[key: string]: string}
    A mapping of tags to assign to the resource.
    zones string[]
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.
    location str
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    name str
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    resource_group_name str
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    tags Mapping[str, str]
    A mapping of tags to assign to the resource.
    zones Sequence[str]
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.
    location String
    The Azure location where the Capacity Reservation Group exists. Changing this forces a new resource to be created.
    name String
    Specifies the name of this Capacity Reservation Group. Changing this forces a new resource to be created.
    resourceGroupName String
    Specifies the name of the resource group the Capacity Reservation Group is located in. Changing this forces a new resource to be created.
    tags Map<String>
    A mapping of tags to assign to the resource.
    zones List<String>
    Specifies a list of Availability Zones for this Capacity Reservation Group. Changing this forces a new resource to be created.

    Import

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

    $ pulumi import azure:compute/capacityReservationGroup:CapacityReservationGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Compute/capacityReservationGroups/capacityReservationGroup1
    

    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 Classic v5.72.0 published on Monday, Apr 15, 2024 by Pulumi