Azure Classic

v5.24.0 published on Wednesday, Nov 9, 2022 by Pulumi

getResourceGroup

Use this data source to access information about an existing Resource Group.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var example = Azure.Core.GetResourceGroup.Invoke(new()
    {
        Name = "existing",
    });

    return new Dictionary<string, object?>
    {
        ["id"] = example.Apply(getBudgetResourceGroupResult => getBudgetResourceGroupResult.Id),
    };
});
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 {
		example, err := core.LookupResourceGroup(ctx, &core.LookupResourceGroupArgs{
			Name: "existing",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("id", example.Id)
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.CoreFunctions;
import com.pulumi.azure.consumption.inputs.GetBudgetResourceGroupArgs;
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) {
        final var example = CoreFunctions.getResourceGroup(GetBudgetResourceGroupArgs.builder()
            .name("existing")
            .build());

        ctx.export("id", example.applyValue(getBudgetResourceGroupResult -> getBudgetResourceGroupResult.id()));
    }
}
import pulumi
import pulumi_azure as azure

example = azure.core.get_resource_group(name="existing")
pulumi.export("id", example.id)
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.core.getResourceGroup({
    name: "existing",
});
export const id = example.then(example => example.id);
variables:
  example:
    Fn::Invoke:
      Function: azure:core:getResourceGroup
      Arguments:
        name: existing
outputs:
  id: ${example.id}

Using getResourceGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getResourceGroup(args: GetResourceGroupArgs, opts?: InvokeOptions): Promise<GetResourceGroupResult>
function getResourceGroupOutput(args: GetResourceGroupOutputArgs, opts?: InvokeOptions): Output<GetResourceGroupResult>
def get_resource_group(name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetResourceGroupResult
def get_resource_group_output(name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetResourceGroupResult]
func LookupResourceGroup(ctx *Context, args *LookupResourceGroupArgs, opts ...InvokeOption) (*LookupResourceGroupResult, error)
func LookupResourceGroupOutput(ctx *Context, args *LookupResourceGroupOutputArgs, opts ...InvokeOption) LookupResourceGroupResultOutput

> Note: This function is named LookupResourceGroup in the Go SDK.

public static class GetResourceGroup 
{
    public static Task<GetResourceGroupResult> InvokeAsync(GetResourceGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetResourceGroupResult> Invoke(GetResourceGroupInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetResourceGroupResult> getResourceGroup(GetResourceGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: azure:core/getResourceGroup:getResourceGroup
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string

The Name of this Resource Group.

Name string

The Name of this Resource Group.

name String

The Name of this Resource Group.

name string

The Name of this Resource Group.

name str

The Name of this Resource Group.

name String

The Name of this Resource Group.

getResourceGroup Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Location string

The Azure Region where the Resource Group exists.

Name string
Tags Dictionary<string, string>

A mapping of tags assigned to the Resource Group.

Id string

The provider-assigned unique ID for this managed resource.

Location string

The Azure Region where the Resource Group exists.

Name string
Tags map[string]string

A mapping of tags assigned to the Resource Group.

id String

The provider-assigned unique ID for this managed resource.

location String

The Azure Region where the Resource Group exists.

name String
tags Map<String,String>

A mapping of tags assigned to the Resource Group.

id string

The provider-assigned unique ID for this managed resource.

location string

The Azure Region where the Resource Group exists.

name string
tags {[key: string]: string}

A mapping of tags assigned to the Resource Group.

id str

The provider-assigned unique ID for this managed resource.

location str

The Azure Region where the Resource Group exists.

name str
tags Mapping[str, str]

A mapping of tags assigned to the Resource Group.

id String

The provider-assigned unique ID for this managed resource.

location String

The Azure Region where the Resource Group exists.

name String
tags Map<String>

A mapping of tags assigned to the Resource Group.

Package Details

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

This Pulumi package is based on the azurerm Terraform Provider.