Get Collection of Microsoft Azure Subscriptions

You can get a list of all Azure subscriptions available to the Azure accounts added to Veeam Backup for Microsoft Azure configuration.

Request

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

HTTP Request

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

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

AccountId

string

Returns only subscriptions to which has permission an Azure account with the specified ID. For more information, see Filter Parameters.

TenantId

string($uuid)

Returns only subscriptions that are available for the tenant with the specified ID. For more information, see Filter Parameters.

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 /cloudInfrastructure/subscriptions collection. The AzureSubscriptionV2 schema is used for the collection representation.

Get Collection of Microsoft Azure SubscriptionsExample

The following request returns a full list of subscriptions added to the Veeam Backup for Microsoft Azure configuration database.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "offset": 0,

 "limit": 200,

 "totalCount": 2,

 "results": [

   {

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

     "environment": "Global",

     "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

     "tenantName": "Veeam Software Group GmbH",

     "name": "Integration Tests",

     "status": "Active",

     "_links": {

       "self": {

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

       },

       "expiringConnection": {

         "href": "https://51.11.247.127/api/v2/accounts/azure/service/1"

       }

     }

   },

   {

     "id": "3a9a4930-7bbc-4b83-9c68-15d674fbc803",

     "environment": "Global",

     "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52",

     "tenantName": "Veeam Software Group GmbH",

     "name": "Visual Studio Premium MSDN",

     "status": "Active",

     "_links": {

       "self": {

         "href": "https://51.11.247.127/api/v2/cloudInfrastructure/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803"

       },

       "expiringConnection": {

         "href": "https://51.11.247.127/api/v2/accounts/azure/service/1"

       }

     }

   }

 ],

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/cloudInfrastructure/subscriptions?offset=0&limit=200"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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