cloudPcReports: getSharedUseLicenseUsageReport

Namespace: microsoft.graph


APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Get a usage report on shared-use licenses, such as servicePlanId, licenseCount, and claimedLicenseCount, for real-time, 7 days, or 28 days trend.


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) CloudPC.Read.All, CloudPC.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application CloudPC.Read.All, CloudPC.ReadWrite.All

HTTP request

POST /deviceManagement/virtualEndpoint/reports/getSharedUseLicenseUsageReport

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the parameters.

The following table shows the parameters that can be used with this action.

Parameter Type Description
reportName String Specifies the report name.
filter String OData filter syntax. Supported filters include and, or, lt, le, gt, ge, and eq.
select String collection OData select syntax. Represents the selected columns of the reports.
search String Specifies a string to search.
groupBy String collection Specifies how to group the reports. If used, must have the same content as the select parameter.
orderBy String collection Specifies how to sort the reports.
skip Int32 The number of records to skip.
top Int32 The number of top records to return.


If successful, this action returns a 200 OK response code and a Stream in the response body.



The following is an example of a request.

Content-Type: application/json
Content-length: 199

    "reportName": "SharedUseLicenseUsageReport",
    "filter": "ServicePlanId eq '2d1d344e-d10c-41bb-953b-b3a47521dca0' and DateTimeUTC gt datetime'2022-11-30'",
    "select":["ServicePlanId", "LicenseCount", "ClaimedLicenseCount", "DateTimeUTC"],
    "skip": 0,
    "top": 100


The following is an example of the response

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/octet-stream

  "TotalRowCount": 2,
  "Schema": [
      "name": "ServicePlanId",
      "type": "String"
      "name": "LicenseCount",
      "type": "Int32"
      "name": "ClaimedLicenseCount",
      "type": "Int32"
      "name": "DateTimeUTC",
      "type": "DateTime"
  "Values": [
      "2d1d344e-d10c-41bb-953b-b3a47521dca0", 100, 10, "2022-12-02T00:00:00"
      "2d1d344e-d10c-41bb-953b-b3a47521dca0", 100, 11, "2022-12-01T00:00:00"