This is an archive version of the document. To get the most up-to-date information, see the current version.Getting Account Properties by Account ID
This section explains how to get a list with properties for the specified Azure account.
Request
GET https://<hostname>/api/v1/accounts/{accountId} |
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 |
accountId | The identification numbers of the account. Can be obtained as described in Getting Accounts. |
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 |
|---|---|---|
connectionId | integer | Shows the identification number of the account. |
applicationId | string | Shows the identification number of the application via which to establish and maintain the connection to the account. |
name | string | Shows the name of the account. |
description | string | Shows the description of the account. |
region | string | Shows the Azure region to which the account belongs. |
tenantId | string | Shows the identification number of tenant. |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
connectionType | string | Shows the type of the account. |
expirationDate | string | Shows the date when the connection to the account expires. |
connectionState | string | Shows the state of the account. |
connectionUseType | string | Shows the type of the account. |
Example
Request: GET https://abc.ukwest.cloudapp.azure.com/api/v1/accounts/1
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "connectionId": 1, "applicationId": "70c4e044-31b5-4c16-s84a-89550aaed346", "name": "Azure Connection", "description": "", "region": "Global", "tenantId": "3e924ba9-93bc-40d5-8a47-33f07b239a52", "_links": { "self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/accounts/1"}, "subscriptions": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/cloudInfrastructure/subscriptions?connectionId=1"} }, "connectionType": "Device Authentication", "expirationDate": "2021-01-28T08:15:48.175376Z", "connectionState": "Created", "connectionUseType": "Service" } |