cloudPcReports: retrieveCloudPcTroubleshootReports

Article
02/26/2025

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.

Get troubleshooting reports for Cloud PCs. You can get a regional troubleshooting report, a report with troubleshooting details, a report with troubleshooting trends, or a report on the number of troubleshooting issues.

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/reports/retrieveCloudPcTroubleshootReports

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 lists the parameters that you can use with this action.

Parameter	Type	Description
filter	String	OData `$filter` syntax. Supported filters are: `and`, `or`, `gt` ,`ge`, and `eq`. Optional.
orderBy	String collection	Specifies the order by column name. Optional.
reportName	cloudPCTroubleshootReportType	The report name. The possible values are: `troubleshootDetailsReport`, `troubleshootTrendCountReport`, `troubleshootRegionalReport`, `unknownFutureValue`, `troubleshootIssueCountReport`. Use the `Prefer: include-unknown-enum-members` request header to get the following values in this evolvable enum: `troubleshootIssueCountReport`. The default value is `troubleshootDetailsReport`.
search	String	The search string. 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. If not specified, the default limit is 25, with a maximum of 100. Optional.

Response

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

The following table describes the columns in the returned report when you specify troubleshootRegionalReport for the reportName property in your API call.

Member	Description
AvgBandwidthInMbps	The average available bandwidth in Mbps of certain `HostRegion`-`GatewayRegion` pair.
AvgRoundTripTimeInMs	The average round trip time in milliseconds of certain `HostRegion`-`GatewayRegion` pair.
BandwidthIssueCount	The number of Cloud PC instances with available bandwidth issues.
BandwidthStabilityIssueCount	The number of Cloud PC instances with bandwidth stability issues.
ConnectErrorIssueCount	The number of Cloud PC instances with connection error issues.
ConnectionErrorCount	The number of connection errors in certain `HostRegion`-`GatewayRegion` pair.
ConnectionQualityIssueCount	The number of Cloud PC instances with connection quality issues.
GatewayRegion	The region where the gateway is located.
HostRegion	The region where the Cloud PC provision is located.
RTTIssueCount	The number of Cloud PC instances with round-trip time issues.
RTTStabilityIssueCount	The number of Cloud PC instances with round-trip time stability issues.
StabilityIssueCount	The number of Cloud PC instances with stability issues.

The following table describes the columns in the returned report when you specify troubleshootDetailsReport for the reportName property in your API call.

Member	Description
AvailableBandwidthInMbpsAvg	The average available bandwidth in Mbps.
ConnectionErrorCount	The number of connection errors.
CurrentCPU	The current CPU usage of the resource.
CurrentDiskInGB	The current disk usage in GB.
CurrentRamInGB	The current RAM usage in GB.
CurrentSize	The current size of the resource.
HasNetworkIssue	Indicates a network issue.
HasPerformanceIssue	Indicates a performance issue.
HasReliabilityIssue	Indicates a reliability issue.
ProvisionPolicyName	The name of the provision policy.
RecommendedRamInGB	The recommended RAM usage in GB.
RecommendedCPU	The recommended CPU usage for the resource.
RecommendedDiskInGB	The recommended disk usage in GB.
RecommendedSize	The recommended size for the resource.
RoundTripTimeInMsAvg	The average round-trip time in milliseconds.
UsageInsight	Insights on the current usage of the resource.

The following table describes the columns in the returned report when you specify troubleshootTrendCountReport for the reportName property in your API call.

Member	Description
CpuIssueCloudPcCount	The number of Cloud PC instances with CPU issues.
CpuIssueTrend	The trend in the weekly number of Cloud PC instances with CPU issues.
ConnectionQualityIssueCloudPcCount	The number of Cloud PC instances with connection quality issues.
ConnectionQualityIssueTrend	The trend in the weekly number of Cloud PC instances with connection quality issues.
MemoryIssueCloudPcCount	The number of Cloud PC instances with memory issues.
MemoryIssueTrend	The trend in the weekly number of Cloud PC instances with memory issues.
NetworkIssueCount	The number of network issues.
PerformanceIssueCount	The number of performance issues.
ReliabilityIssueCount	The number of reliability issues.
RTTIssueCloudPcCount	The number of Cloud PC instances with round-trip time issues.
RTTIssueTrend	The trend in the weekly number of Cloud PC instances with round-trip time issues.
StabilityIssueCloudPcCount	The number of Cloud PC instances with stability issues.
StabilityIssueTrend	The trend in the weekly number of Cloud PC instances with stability issues.
TotalImpactedCloudPcCount	The total count of impacted Cloud PCs.

The following table describes the columns in the returned report when you specify troubleshootIssueCountReport for the reportName property in your API call.

Member	Description
AsofDate	The date and time of when the data was recorded.
ConnectionQualityIssueCount	The number of connection quality issues.
CpuIssueCount	The number of CPU issues.
MemoryIssueCount	The number of memory issues.
NetworkIssueCount	The number of network issues.
PerformanceIssueCount	The number of performance issues.
ReliabilityIssueCount	The number of reliability issues.
RTTIssueCount	The number of round-trip time issues.
StabilityIssueCount	The number of stability issues.

Examples

Request

The following example shows a request.

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

{
  "reportName": "troubleshootDetailsReport",
  "select": [
    "CloudPcId",
    "ManagedDeviceName",
    "UserPrincipalName",
    "UsageInsight",
    "CurrentSize",
    "CurrentCPU",
    "CurrentRamInGB",
    "CurrentDiskInGB",
    "RecommendedSize",
    "RecommendedCPU",
    "RecommendedRamInGB",
    "RecommendedDiskInGB",
    "ProvisionPolicyName",
    "RoundTripTimeInMsAvg",
    "AvailableBandwidthInMbpsAvg"
  ],
  "search": "",
  "skip": 0,
  "top": 50
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.DeviceManagement.VirtualEndpoint.Reports.RetrieveCloudPcTroubleshootReports;
using Microsoft.Graph.Beta.Models;

var requestBody = new RetrieveCloudPcTroubleshootReportsPostRequestBody
{
	ReportName = CloudPCTroubleshootReportType.TroubleshootDetailsReport,
	Select = new List<string>
	{
		"CloudPcId",
		"ManagedDeviceName",
		"UserPrincipalName",
		"UsageInsight",
		"CurrentSize",
		"CurrentCPU",
		"CurrentRamInGB",
		"CurrentDiskInGB",
		"RecommendedSize",
		"RecommendedCPU",
		"RecommendedRamInGB",
		"RecommendedDiskInGB",
		"ProvisionPolicyName",
		"RoundTripTimeInMsAvg",
		"AvailableBandwidthInMbpsAvg",
	},
	Search = "",
	Skip = 0,
	Top = 50,
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
await graphClient.DeviceManagement.VirtualEndpoint.Reports.RetrieveCloudPcTroubleshootReports.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



mgc-beta device-management virtual-endpoint reports retrieve-cloud-pc-troubleshoot-reports post --body '{\
  "reportName": "troubleshootDetailsReport",\
  "select": [\
    "CloudPcId",\
    "ManagedDeviceName",\
    "UserPrincipalName",\
    "UsageInsight",\
    "CurrentSize",\
    "CurrentCPU",\
    "CurrentRamInGB",\
    "CurrentDiskInGB",\
    "RecommendedSize",\
    "RecommendedCPU",\
    "RecommendedRamInGB",\
    "RecommendedDiskInGB",\
    "ProvisionPolicyName",\
    "RoundTripTimeInMsAvg",\
    "AvailableBandwidthInMbpsAvg"\
  ],\
  "search": "",\
  "skip": 0,\
  "top": 50\
}\
'

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphdevicemanagement "github.com/microsoftgraph/msgraph-beta-sdk-go/devicemanagement"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphdevicemanagement.NewRetrieveCloudPcTroubleshootReportsPostRequestBody()
reportName := graphmodels.TROUBLESHOOTDETAILSREPORT_CLOUDPCTROUBLESHOOTREPORTTYPE 
requestBody.SetReportName(&reportName) 
select := []string {
	"CloudPcId",
	"ManagedDeviceName",
	"UserPrincipalName",
	"UsageInsight",
	"CurrentSize",
	"CurrentCPU",
	"CurrentRamInGB",
	"CurrentDiskInGB",
	"RecommendedSize",
	"RecommendedCPU",
	"RecommendedRamInGB",
	"RecommendedDiskInGB",
	"ProvisionPolicyName",
	"RoundTripTimeInMsAvg",
	"AvailableBandwidthInMbpsAvg",
}
requestBody.SetSelect(select)
search := ""
requestBody.SetSearch(&search) 
skip := int32(0)
requestBody.SetSkip(&skip) 
top := int32(50)
requestBody.SetTop(&top) 

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
graphClient.DeviceManagement().VirtualEndpoint().Reports().RetrieveCloudPcTroubleshootReports().Post(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.beta.devicemanagement.virtualendpoint.reports.retrievecloudpctroubleshootreports.RetrieveCloudPcTroubleshootReportsPostRequestBody retrieveCloudPcTroubleshootReportsPostRequestBody = new com.microsoft.graph.beta.devicemanagement.virtualendpoint.reports.retrievecloudpctroubleshootreports.RetrieveCloudPcTroubleshootReportsPostRequestBody();
retrieveCloudPcTroubleshootReportsPostRequestBody.setReportName(CloudPCTroubleshootReportType.TroubleshootDetailsReport);
LinkedList<String> select = new LinkedList<String>();
select.add("CloudPcId");
select.add("ManagedDeviceName");
select.add("UserPrincipalName");
select.add("UsageInsight");
select.add("CurrentSize");
select.add("CurrentCPU");
select.add("CurrentRamInGB");
select.add("CurrentDiskInGB");
select.add("RecommendedSize");
select.add("RecommendedCPU");
select.add("RecommendedRamInGB");
select.add("RecommendedDiskInGB");
select.add("ProvisionPolicyName");
select.add("RoundTripTimeInMsAvg");
select.add("AvailableBandwidthInMbpsAvg");
retrieveCloudPcTroubleshootReportsPostRequestBody.setSelect(select);
retrieveCloudPcTroubleshootReportsPostRequestBody.setSearch("");
retrieveCloudPcTroubleshootReportsPostRequestBody.setSkip(0);
retrieveCloudPcTroubleshootReportsPostRequestBody.setTop(50);
graphClient.deviceManagement().virtualEndpoint().reports().retrieveCloudPcTroubleshootReports().post(retrieveCloudPcTroubleshootReportsPostRequestBody);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const stream = {
  reportName: 'troubleshootDetailsReport',
  select: [
    'CloudPcId',
    'ManagedDeviceName',
    'UserPrincipalName',
    'UsageInsight',
    'CurrentSize',
    'CurrentCPU',
    'CurrentRamInGB',
    'CurrentDiskInGB',
    'RecommendedSize',
    'RecommendedCPU',
    'RecommendedRamInGB',
    'RecommendedDiskInGB',
    'ProvisionPolicyName',
    'RoundTripTimeInMsAvg',
    'AvailableBandwidthInMbpsAvg'
  ],
  search: '',
  skip: 0,
  top: 50
};

await client.api('/deviceManagement/virtualEndpoint/reports/retrieveCloudPcTroubleshootReports')
	.version('beta')
	.post(stream);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\Reports\RetrieveCloudPcTroubleshootReports\RetrieveCloudPcTroubleshootReportsPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\CloudPCTroubleshootReportType;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new RetrieveCloudPcTroubleshootReportsPostRequestBody();
$requestBody->setReportName(new CloudPCTroubleshootReportType('troubleshootDetailsReport'));
$requestBody->setSelect(['CloudPcId', 'ManagedDeviceName', 'UserPrincipalName', 'UsageInsight', 'CurrentSize', 'CurrentCPU', 'CurrentRamInGB', 'CurrentDiskInGB', 'RecommendedSize', 'RecommendedCPU', 'RecommendedRamInGB', 'RecommendedDiskInGB', 'ProvisionPolicyName', 'RoundTripTimeInMsAvg', 'AvailableBandwidthInMbpsAvg', 	]);
$requestBody->setSearch('');
$requestBody->setSkip(0);
$requestBody->setTop(50);

$graphServiceClient->deviceManagement()->virtualEndpoint()->reports()->retrieveCloudPcTroubleshootReports()->post($requestBody)->wait();

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.devicemanagement.virtualendpoint.reports.retrieve_cloud_pc_troubleshoot_reports.retrieve_cloud_pc_troubleshoot_reports_post_request_body import RetrieveCloudPcTroubleshootReportsPostRequestBody
from msgraph_beta.generated.models.cloud_p_c_troubleshoot_report_type import CloudPCTroubleshootReportType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = RetrieveCloudPcTroubleshootReportsPostRequestBody(
	report_name = CloudPCTroubleshootReportType.TroubleshootDetailsReport,
	select = [
		"CloudPcId",
		"ManagedDeviceName",
		"UserPrincipalName",
		"UsageInsight",
		"CurrentSize",
		"CurrentCPU",
		"CurrentRamInGB",
		"CurrentDiskInGB",
		"RecommendedSize",
		"RecommendedCPU",
		"RecommendedRamInGB",
		"RecommendedDiskInGB",
		"ProvisionPolicyName",
		"RoundTripTimeInMsAvg",
		"AvailableBandwidthInMbpsAvg",
	],
	search = "",
	skip = 0,
	top = 50,
)

await graph_client.device_management.virtual_endpoint.reports.retrieve_cloud_pc_troubleshoot_reports.post(request_body)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

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/json

{
  "TotalRowCount": 1,
  "Schema": [
    {
      "Column": "CloudPcId",
      "PropertyType": "String"
    },
    {
      "Column": "ManagedDeviceName",
      "PropertyType": "String"
    },
    {
      "Column": "UserPrincipalName",
      "PropertyType": "String"
    },
    {
      "Column": "UsageInsight",
      "PropertyType": "String"
    },
    {
      "Column": "CurrentSize",
      "PropertyType": "Int"
    },
    {
      "Column": "CurrentCPU",
      "PropertyType": "Int"
    },
    {
      "Column": "CurrentRamInGB",
      "PropertyType": "Int"
    },
    {
      "Column": "CurrentDiskInGB",
      "PropertyType": "Int"
    },
    {
      "Column": "RecommendedSize",
      "PropertyType": "String"
    },
    {
      "Column": "RecommendedCPU",
      "PropertyType": "Int"
    },
    {
      "Column": "RecommendedRamInGB",
      "PropertyType": "Int"
    },
    {
      "Column": "RecommendedDiskInGB",
      "PropertyType": "Int"
    },
    {
      "Column": "ProvisionPolicyName",
      "PropertyType": "String"
    },
    {
      "Column": "RoundTripTimeInMsAvg",
      "PropertyType": "Double"
    },
    {
      "Column": "AvailableBandwidthInMbpsAvg",
      "PropertyType": "Double"
    }
  ],
  "Values": [
    [
      "f5ff445f-7488-40f8-8ab9-ee784a9c1f33",
      "Cloud PC-Ana Bowman",
      "ana@contoso.com",
      "Performance",
      "2",
      "4",
      "64",
      "Undersized",
      "4",
      "8",
      "128",
      "policy1",
      "200.1",
      "50.65"
    ]
  ]
}

Share via

cloudPcReports: retrieveCloudPcTroubleshootReports

Permissions

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources