Share via

Resource Groups - Get

  • Reference
Service:
Resource Management
API Version:
2021-04-01

Gets a resource group.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}?api-version=2021-04-01

URI Parameters

Name In Required Type Description
resourceGroupName
 path True

string

The name of the resource group to get. The name is case insensitive.

Regex pattern: ^[-\w\._\(\)]+$
subscriptionId
 path True

string

The Microsoft Azure subscription ID.
api-version
 query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

ResourceGroup

OK - Returns information about the resource group.
Other Status Codes

CloudError

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Definitions

Name Description
CloudError

An error response for a resource management request.
ErrorAdditionalInfo

The resource management error additional info.
ErrorResponse

Error Response
ResourceGroup

Resource group information.
ResourceGroupProperties

The resource group properties.

CloudError

An error response for a resource management request.

Name Type Description
error

ErrorResponse

Error Response
Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.)

ErrorAdditionalInfo

The resource management error additional info.

Name Type Description
info

object

The additional info.
type

string

The additional info type.

ErrorResponse

Error Response

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

The error additional info.
code

string

The error code.
details

ErrorResponse[]

The error details.
message

string

The error message.
target

string

The error target.

ResourceGroup

Resource group information.

Name Type Description
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.
managedBy

string

The ID of the resource that manages this resource group.
name

string

The name of the resource group.
properties

ResourceGroupProperties

The resource group properties.
tags

object

The tags attached to the resource group.
type

string

The type of the resource group.

ResourceGroupProperties

The resource group properties.

Name Type Description
provisioningState

string

The provisioning state.