azure-native.resources.getResourceGroup
Explore with Pulumi AI
Gets a resource group.
Uses Azure REST API version 2024-03-01.
Other available API versions: 2020-10-01, 2021-01-01, 2021-04-01, 2022-09-01, 2023-07-01, 2024-07-01, 2024-11-01, 2025-03-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native resources [ApiVersion]. See the version guide for details.
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(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]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)
public static Output<GetResourceGroupResult> getResourceGroup(GetResourceGroupArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:resources:getResourceGroup
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Resource
Group stringName  - The name of the resource group to get. The name is case insensitive.
 
- Resource
Group stringName  - The name of the resource group to get. The name is case insensitive.
 
- resource
Group StringName  - The name of the resource group to get. The name is case insensitive.
 
- resource
Group stringName  - The name of the resource group to get. The name is case insensitive.
 
- resource_
group_ strname  - The name of the resource group to get. The name is case insensitive.
 
- resource
Group StringName  - The name of the resource group to get. The name is case insensitive.
 
getResourceGroup Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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.
Azure Native. Resources. Outputs. Resource Group Properties Response  - The resource group properties.
 - Type string
 - The type of the resource group.
 - Managed
By string - The ID of the resource that manages this resource group.
 - Dictionary<string, string>
 - The tags attached to the resource group.
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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
Resource
Group Properties Response  - The resource group properties.
 - Type string
 - The type of the resource group.
 - Managed
By string - The ID of the resource that manages this resource group.
 - map[string]string
 - The tags attached to the resource group.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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
Resource
Group Properties Response  - The resource group properties.
 - type String
 - The type of the resource group.
 - managed
By String - The ID of the resource that manages this resource group.
 - Map<String,String>
 - The tags attached to the resource group.
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - 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
Resource
Group Properties Response  - The resource group properties.
 - type string
 - The type of the resource group.
 - managed
By string - The ID of the resource that manages this resource group.
 - {[key: string]: string}
 - The tags attached to the resource group.
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - 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
Resource
Group Properties Response  - 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.
 - Mapping[str, str]
 - The tags attached to the resource group.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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.
 - managed
By String - The ID of the resource that manages this resource group.
 - Map<String>
 - The tags attached to the resource group.
 
Supporting Types
ResourceGroupPropertiesResponse   
- Provisioning
State string - The provisioning state.
 
- Provisioning
State string - The provisioning state.
 
- provisioning
State String - The provisioning state.
 
- provisioning
State string - The provisioning state.
 
- provisioning_
state str - The provisioning state.
 
- provisioning
State String - The provisioning state.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0