Get Resource Group Data

You can get data on a resource group with the specified ID.

Request

To retrieve information on a specific resource group, send the HTTP GET request to the /cloudInfrastructure/resourceGroups/{resourceGroupId} endpoint. {resourceGroupId} is a system ID assigned to the resource group in the Veeam Backup for Microsoft Azure REST API.

HTTP Request

GET https://<hostname>/api/v2/cloudInfrastructure/resourceGroups/{resourceGroupId}

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a representation of the resource group with the specified ID. The ResourceGroupV2 schema is used for the resource representation.

Get Resource Group DataExample

The following request returns information on a resource group with the ID odtcozwwf5tqu5cgmtt41wwu4g6o8u6hnat7kqohs7njmx85beho.

Request:

GET https://51.11.247.127/api/v2/cloudInfrastructure/resourceGroups/odtcozwwf5tqu5cgmtt41wwu4g6o8u6hnat7kqohs7njmx85beho

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "id": "odtcozwwf5tqu5cgmtt41wwu4g6o8u6hnat7kqohs7njmx85beho",

 "resourceId": "/subscriptions/1142bdc7-8797-42bc-aa23-9f1fc1411946/resourcegroups/09a0415f-306e-4fb5-a4c8-b7025537732f",

 "name": "09a0415f-306e-4fb5-a4c8-b7025537732f",

 "azureEnvironment": "Global",

 "subscriptionId": "1142bdc7-8797-42bc-aa23-9f1fc1411946",

 "regionId": "eastasia",

 "_links": {

   "subscription": {

     "href": "https://51.11.247.127/api/v2/cloudInfrastructure/subscriptions/1142bdc7-8797-42bc-aa23-9f1fc1411946"

   },

   "self": {

     "href": "https://51.11.247.127/api/v2/cloudInfrastructure/resourceGroups/odtcozwwf5tqu5cgmtt41wwu4g6o8u6hnat7kqohs7njmx85beho"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.