Get Collection of Resource Groups

You can get a list of all resource groups available for Veeam Backup for Microsoft Azure.

Request

To retrieve a representation of a collection of resource groups, send the HTTP GET request to the /cloudInfrastructure/resourceGroups endpoint.

HTTP Request

GET https://<hostname>/api/v2/cloudInfrastructure/resourceGroups

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit, SearchPattern and the following query parameters:

Query Parameter

Value

Description

SubscriptionId

string($uuid)

Returns only resource groups that belong to the subscription with the specified ID. For more information, see Filter Parameters.

TenantId

string($uuid)

Returns only resource groups available for a tenant with the specified ID. For more information, see Filter Parameters.

RegionIds

array[string]

Returns only resource groups that belong to an Azure regions with the specified ID. For more information, see Filter Parameters.

Sync

boolean

Defines whether Veeam Backup for Microsoft Azure database is synchronized with Azure resources.

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 /resourceGroups collection. The ResourceGroupV2 schema is used for the collection representation.

Get Collection of Resource GroupsExample

The following request returns a full list of resource groups to which Azure accounts added to the Veeam Backup for Microsoft Azure configuration database have permissions.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "offset": 0,

 "limit": 200,

 "totalCount": 231,

 "results": [

   {

     "id": "xx8zn8iisef6ytpcgif199gm45ip8xybbw6refruekg9ursfbg5y",

     "resourceId": "/subscriptions/1142bdc7-8797-42bc-aa23-9f1fc1411946/resourcegroups/0367e3ec-cd6d-474b-9fff-8bde635d996c",

     "name": "0367e3ec-cd6d-474b-9fff-8bde635d996c",

     "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/xx8zn8iisef6ytpcgif199gm45ip8xybbw6refruekg9ursfbg5y"

       }

     }

   },

   {

     "id": "p8w4655botxhqr4w33pubrqpq9g14fiw7qqrhb1yjq8mqqpp8jzo",

     "resourceId": "/subscriptions/1142bdc7-8797-42bc-aa23-9f1fc1411946/resourcegroups/087ef592-b159-4629-99c7-e262b6385b20",

     "name": "087ef592-b159-4629-99c7-e262b6385b20",

     "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/p8w4655botxhqr4w33pubrqpq9g14fiw7qqrhb1yjq8mqqpp8jzo"

       }

     }

   },

...

I want to report a typo

There is a misspelling right here:

 

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