1. Packages
  2. Azure Classic
  3. API Docs
  4. core
  5. ResourceGroup

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

azure.core.ResourceGroup

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.84.0 published on Tuesday, Jul 16, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example",
        location: "West Europe",
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example",
        location="West Europe")
    
    package main
    
    import (
    	"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 {
    		_, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example"),
    			Location: pulumi.String("West Europe"),
    		})
    		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",
            Location = "West Europe",
        });
    
    });
    
    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 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")
                .location("West Europe")
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example
          location: West Europe
    

    Create ResourceGroup Resource

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

    Constructor syntax

    new ResourceGroup(name: string, args?: ResourceGroupArgs, opts?: CustomResourceOptions);
    @overload
    def ResourceGroup(resource_name: str,
                      args: Optional[ResourceGroupArgs] = None,
                      opts: Optional[ResourceOptions] = None)
    
    @overload
    def ResourceGroup(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      location: Optional[str] = None,
                      managed_by: Optional[str] = None,
                      name: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None)
    func NewResourceGroup(ctx *Context, name string, args *ResourceGroupArgs, opts ...ResourceOption) (*ResourceGroup, error)
    public ResourceGroup(string name, ResourceGroupArgs? args = null, CustomResourceOptions? opts = null)
    public ResourceGroup(String name, ResourceGroupArgs args)
    public ResourceGroup(String name, ResourceGroupArgs args, CustomResourceOptions options)
    
    type: azure:core:ResourceGroup
    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 ResourceGroupArgs
    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 ResourceGroupArgs
    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 ResourceGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ResourceGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ResourceGroupArgs
    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 resourceGroupResource = new Azure.Core.ResourceGroup("resourceGroupResource", new()
    {
        Location = "string",
        ManagedBy = "string",
        Name = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := core.NewResourceGroup(ctx, "resourceGroupResource", &core.ResourceGroupArgs{
    	Location:  pulumi.String("string"),
    	ManagedBy: pulumi.String("string"),
    	Name:      pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var resourceGroupResource = new ResourceGroup("resourceGroupResource", ResourceGroupArgs.builder()
        .location("string")
        .managedBy("string")
        .name("string")
        .tags(Map.of("string", "string"))
        .build());
    
    resource_group_resource = azure.core.ResourceGroup("resourceGroupResource",
        location="string",
        managed_by="string",
        name="string",
        tags={
            "string": "string",
        })
    
    const resourceGroupResource = new azure.core.ResourceGroup("resourceGroupResource", {
        location: "string",
        managedBy: "string",
        name: "string",
        tags: {
            string: "string",
        },
    });
    
    type: azure:core:ResourceGroup
    properties:
        location: string
        managedBy: string
        name: string
        tags:
            string: string
    

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

    Location string
    The Azure Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    ManagedBy string
    The ID of the resource or application that manages this Resource Group.
    Name string
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Resource Group.
    Location string
    The Azure Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    ManagedBy string
    The ID of the resource or application that manages this Resource Group.
    Name string
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Resource Group.
    location String
    The Azure Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    managedBy String
    The ID of the resource or application that manages this Resource Group.
    name String
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Resource Group.
    location string
    The Azure Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    managedBy string
    The ID of the resource or application that manages this Resource Group.
    name string
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Resource Group.
    location str
    The Azure Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    managed_by str
    The ID of the resource or application that manages this Resource Group.
    name str
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Resource Group.
    location String
    The Azure Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    managedBy String
    The ID of the resource or application that manages this Resource Group.
    name String
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Resource Group.

    Outputs

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

    Get an existing ResourceGroup 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?: ResourceGroupState, opts?: CustomResourceOptions): ResourceGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            location: Optional[str] = None,
            managed_by: Optional[str] = None,
            name: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None) -> ResourceGroup
    func GetResourceGroup(ctx *Context, name string, id IDInput, state *ResourceGroupState, opts ...ResourceOption) (*ResourceGroup, error)
    public static ResourceGroup Get(string name, Input<string> id, ResourceGroupState? state, CustomResourceOptions? opts = null)
    public static ResourceGroup get(String name, Output<String> id, ResourceGroupState 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 Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    ManagedBy string
    The ID of the resource or application that manages this Resource Group.
    Name string
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Resource Group.
    Location string
    The Azure Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    ManagedBy string
    The ID of the resource or application that manages this Resource Group.
    Name string
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Resource Group.
    location String
    The Azure Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    managedBy String
    The ID of the resource or application that manages this Resource Group.
    name String
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Resource Group.
    location string
    The Azure Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    managedBy string
    The ID of the resource or application that manages this Resource Group.
    name string
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Resource Group.
    location str
    The Azure Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    managed_by str
    The ID of the resource or application that manages this Resource Group.
    name str
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Resource Group.
    location String
    The Azure Region where the Resource Group should exist. Changing this forces a new Resource Group to be created.
    managedBy String
    The ID of the resource or application that manages this Resource Group.
    name String
    The Name which should be used for this Resource Group. Changing this forces a new Resource Group to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Resource Group.

    Import

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

    $ pulumi import azure:core/resourceGroup:ResourceGroup example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1
    

    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.84.0 published on Tuesday, Jul 16, 2024 by Pulumi