This is an archive version of the document. To get the most up-to-date information, see the current version.Getting License Usage
This section explains how to get a list of VMs that consume the license.
Request
GET https://<hostname>/api/v1/license/resources |
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 | Contains the result object. | |
_links | Dictionary of string [key] and Object [value] | Links to related resources (navigation property). |
Property | Type | Description |
|---|---|---|
id | string | Shows the identification number of the VM that consumes the license. Required to revoke the license as described in Revoking Licenses. |
name | string | Shows the name of the VM that consumes the license. |
resourceType | string | Shows the resource type. |
licensedState | string | Shows the state. |
lastBackupTime | string | Shows the last time the VM has been backed-up. |
cost | integer | Shows the cost. |
_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/license/resources
Request Header: Authorization: Bearer <Access-Token>
Response: 200 OK
Response Body: { "offset": 0, "limit": 30, "totalCount": 1, "results": [ { "id": 1, "name": "TW-VM2", "resourceType": "Virtual Machine", "licensedState": "Licensed", "lastBackupTime": "2020-02-04T19:02:30.328869Z", "cost": 1 }], "_links": {"self": {"href": "https://abc.ukwest.cloudapp.azure.com:443/api/v1/license/resources?offset=0&limit=30"}} } |