Get Collection of Azure Regions

You can get a list of all Azure regions available in the Azure account.

Request

To retrieve a representation of a collection of regions, send the HTTP GET request to the /regions endpoint.

HTTP Request

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

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 regions available for the specified subscription. For more information, see Filter Parameters.

TenantId

string($uuid)

Returns only regions available for specified tenants. 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 /regions collection. The RegionV2 schema is used for the collection representation.

Get Collection of Azure RegionsExample

The following request returns a full list of available regions.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "offset": 0,

 "limit": 5,

 "totalCount": 39,

 "results": [

   {

     "id": "australiaeast",

     "name": "Australia East"

   },

   {

     "id": "australiasoutheast",

     "name": "Australia Southeast"

   },

   {

     "id": "brazilsouth",

     "name": "Brazil South"

   },

   {

     "id": "brazilsoutheast",

     "name": "Brazil Southeast"

   },

   {

     "id": "canadacentral",

     "name": "Canada Central"

   }

 ],

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/cloudInfrastructure/regions?offset=0&limit=5&expand=None"

   },

   "next": {

     "href": "https://51.11.247.127/api/v2/cloudInfrastructure/regions?offset=5&limit=5&expand=None"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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