This is an archive version of the document. To get the most up-to-date information, see the current version.

Getting Subscription Properties by Subscription ID

This section explains how to get a list with properties for the specified Azure subscription.

Request

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

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be posted as URL.

Parameter

Description

subscriptionId

The identification numbers of the Azure subscription. Can be obtained as described in Getting Subscriptions.

Request Body

None.

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 HTTPS headers.

Header

Description

Content-length

The length of the response body.

Content-type

The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

Property

Type

Description

id

string

Shows the identification number of the Azure subscription.

environment

string

Shows the Azure environment.

tenantId

string

Shows the identification number of the tenant.

name

string

Shows the name of the Azure subscription.

status

string

Shows the status of the Azure subscription.

_links

Dictionary of string [key] and Object [value]

Links to related resources (navigation property).

Example

Request:

GET https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/subscriptions/d55989e4-f37f-429a-98f3-14787540673f

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

  "id": "d55989e4-f37f-429a-98f3-14787540673f",

  "environment": "Global",

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

  "name": "Enterprise - R&D - Azure Lighthouse",

  "status": "Active",

  "_links":    {

     "self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/subscriptions/d55989e4-f37f-429a-98f3-14787540673f"},

     "expiringConnection": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/accounts/1"}

  }

}

I want to report a typo

There is a misspelling right here:

 

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