Edit

Share via

cloudPcReport: retrieveCloudPcClientAppUsageReport

Namespace: microsoft.graph

Important

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.

Retrieve related reports on Cloud PC usage, including the client application used by users to sign in to the Cloud PC device.

The Remote Desktop client standalone installer (MSI) for Windows will reach end of support on March 27, 2026. Before that date, IT administrators should migrate users to Windows App to ensure continued access to remote resources through Azure Virtual Desktop, Windows 365, and Microsoft Dev Box. Learn more about preparing for the Remote Desktop Client for Windows end of support.

This API enables IT administrators to check the migration status by confirming whether users are still using the legacy Remote Desktop client and identifying their last sign-in dates, thereby helping monitor progress and ensure compliance with migration requirements.

This API is available in the following national cloud deployments.

Global service US Government L4 US Government L5 (DOD) China operated by 21Vianet
✅ ✅ ✅ ❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type Least privileged permissions Higher privileged permissions
Delegated (work or school account) CloudPC.ReadWrite.All Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application CloudPC.ReadWrite.All Not available.

HTTP request

POST /deviceManagement/virtualEndpoint/report/retrieveCloudPcClientAppUsageReport

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
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 method.

Parameter Type Description
filter String OData $filter syntax. Supported filters are: and, or, lt, le, gt, ge, and eq. Optional.
groupBy String collection Specifies how to group the reports. If used, must have the same content as the select parameter. Optional.
orderBy String collection Specifies how to sort the reports. Optional.
reportType cloudPcClientAppUsageReportType The report type. The supported value is microsoftRemoteDesktopClientUsageReport. Required.
search String Specifies a String to search. Optional.
select String collection OData $select syntax. The selected columns of the reports. Optional.
skip Int32 Number of records to skip. Optional.
top Int32 The number of top records to return. Optional.

Response

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

The following table explains the schema in the response.

Column Type Description
UPN String The user principal name.
LastSignOn String The date when the user last signed in using the legacy Remote Desktop client. The format is YYYY-MM-DD and always in UTC time.
DaysWithUsage String The total number of days the user signed in through the legacy Remote Desktop client in the last 28 days, calculated using UTC time.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/report/retrieveCloudPcClientAppUsageReport
Content-Type: application/json

{
    "filter": "",
    "reportType":"microsoftRemoteDesktopClientUsageReport",
    "select": ["UPN", "LastSignOn", "DaysWithUsage"],
    "search": "",
    "skip": 0,
    "top": 50
}

Response

The following example shows the response.

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

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

{
    "TotalRowCount": 3,
    "Schema": [
        {
            "Column": "UPN",
            "PropertyType": "String"
        },
        {
            "Column": "LastSignOn",
            "PropertyType": "String"
        },
        {
            "Column": "DaysWithUsage",
            "PropertyType": "Int64"
        }
    ],
    "Values" :[
        ["test001@contoso.onmicrosoft.com", "2025-10-28", 10],
        ["test002@contoso.onmicrosoft.com", "2025-10-30",  5],
        ["test003@contoso.onmicrosoft.com", "2025-10-31", 19]
    ]
}
  • Last updated on