Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. resources
  5. getResourceGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.resources.getResourceGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets a resource group. Azure REST API version: 2022-09-01.

Other available API versions: 2023-07-01, 2024-03-01, 2024-07-01, 2024-11-01.

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>
Copy
def get_resource_group(resource_group_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetResourceGroupResult
def get_resource_group_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetResourceGroupResult]
Copy
func LookupResourceGroup(ctx *Context, args *LookupResourceGroupArgs, opts ...InvokeOption) (*LookupResourceGroupResult, error)
func LookupResourceGroupOutput(ctx *Context, args *LookupResourceGroupOutputArgs, opts ...InvokeOption) LookupResourceGroupResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetResourceGroupResult> getResourceGroup(GetResourceGroupArgs args, InvokeOptions options)
public static Output<GetResourceGroupResult> getResourceGroup(GetResourceGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:resources:getResourceGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to get. The name is case insensitive.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to get. The name is case insensitive.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group to get. The name is case insensitive.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group to get. The name is case insensitive.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group to get. The name is case insensitive.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group to get. The name is case insensitive.

getResourceGroup Result

The following output properties are available:

Id string
The ID of the resource group.
Location string
The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations.
Name string
The name of the resource group.
Properties Pulumi.AzureNative.Resources.Outputs.ResourceGroupPropertiesResponse
The resource group properties.
Type string
The type of the resource group.
ManagedBy string
The ID of the resource that manages this resource group.
Tags Dictionary<string, string>
The tags attached to the resource group.
Id string
The ID of the resource group.
Location string
The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations.
Name string
The name of the resource group.
Properties ResourceGroupPropertiesResponse
The resource group properties.
Type string
The type of the resource group.
ManagedBy string
The ID of the resource that manages this resource group.
Tags map[string]string
The tags attached to the resource group.
id String
The ID of the resource group.
location String
The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations.
name String
The name of the resource group.
properties ResourceGroupPropertiesResponse
The resource group properties.
type String
The type of the resource group.
managedBy String
The ID of the resource that manages this resource group.
tags Map<String,String>
The tags attached to the resource group.
id string
The ID of the resource group.
location string
The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations.
name string
The name of the resource group.
properties ResourceGroupPropertiesResponse
The resource group properties.
type string
The type of the resource group.
managedBy string
The ID of the resource that manages this resource group.
tags {[key: string]: string}
The tags attached to the resource group.
id str
The ID of the resource group.
location str
The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations.
name str
The name of the resource group.
properties ResourceGroupPropertiesResponse
The resource group properties.
type str
The type of the resource group.
managed_by str
The ID of the resource that manages this resource group.
tags Mapping[str, str]
The tags attached to the resource group.
id String
The ID of the resource group.
location String
The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations.
name String
The name of the resource group.
properties Property Map
The resource group properties.
type String
The type of the resource group.
managedBy String
The ID of the resource that manages this resource group.
tags Map<String>
The tags attached to the resource group.

Supporting Types

ResourceGroupPropertiesResponse

ProvisioningState This property is required. string
The provisioning state.
ProvisioningState This property is required. string
The provisioning state.
provisioningState This property is required. String
The provisioning state.
provisioningState This property is required. string
The provisioning state.
provisioning_state This property is required. str
The provisioning state.
provisioningState This property is required. String
The provisioning state.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native