Get Microsoft Azure Subscription Data

You can get data on an Azure subscription with the specified ID.

Request

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

HTTP Request

GET https://<hostname>/api/v2/cloudInfrastructure/subscriptions/{subscriptionId}

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 Azure subscription with the specified ID. The AzureSubscriptionV2 schema is used for the resource representation.

Get Microsoft Azure Subscription DataExample

The following request returns information on an Azure subscription with the ID 1142bdc7-8797-42bc-aa23-9f1fc1411946.

Request:

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

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

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

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

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