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

Getting Subscriptions

This section explains how to get a list of Azure subscriptions.

Request

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

Request Headers

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

Request Parameters

None.

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
offset	integer	Shows the offset value.
limit	integer	Shows the offset limit.
totalCount	integer	Shows the number of records in the results array.
results	AzureSubscription Object	Contains the result object.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

AzureSubscription Object

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

Request Header:

Authorization: Bearer <Access-Token>

Response:

200 OK

Response Body:

{

"offset": 0,

"limit": 30,

"totalCount": 2,

"results": [

{

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

}

{

"id": "3a9a8330-7bbc-4b03-9c68-15d674fbc809",

"environment": "Global",

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

"name": "Visual Studio Premium MSDN",

"status": "Active",

"_links": {

"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/subscriptions/3a9a8330-7bbc-4b03-9c68-15d674fbc809"},

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

}

"_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/cloudInfrastructure/subscriptions?offset=0&limit=30"}}

}