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 report related to the performance of Cloud PCs.
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.Read.All
CloudPC.ReadWrite.All
Delegated (personal Microsoft account)
Not supported.
Not supported.
Application
CloudPC.Read.All
CloudPC.ReadWrite.All
HTTP request
POST /deviceManagement/virtualEndpoint/reports/retrieveCloudPcTenantMetricsReport
The report name. The possible values are: performanceTrendReport, unknownFutureValue, cloudPcInsightReport. Use the Prefer: include-unknown-enum-members request header to get the following value in this evolvable enum: cloudPcInsightReport.
search
String
Specifies a String to search.
select
String collection
OData $select syntax. The selected columns of the reports.
skip
Int32
Number of records to skip.
top
Int32
Specifies the page size. If not defined, the default is 25, with a maximum value of 100.
Response
If successful, this method returns a 200 OK response code and a Stream object in the response body.
Examples
Example 1: Get a performance trend report
The following example shows how to get the performance trend report with daily aggregated data that provides a list of connection quality metrics for Cloud PCs over the past seven days within a tenant.
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.DeviceManagement.VirtualEndpoint.Reports.RetrieveCloudPcTenantMetricsReport;
using Microsoft.Graph.Beta.Models;
var requestBody = new RetrieveCloudPcTenantMetricsReportPostRequestBody
{
ReportName = CloudPCPerformanceReportName.PerformanceTrendReport,
Filter = "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'",
Select = new List<string>
{
"EventDateTime",
"SlowRoundTripTimeCloudPcCount",
"LowUdpConnectionPercentageCount",
"NoActiveTimeConnectedCount",
"LowActiveTimeConnectedCount",
},
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.RetrieveCloudPcTenantMetricsReport.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.
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.
// 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.NewRetrieveCloudPcTenantMetricsReportPostRequestBody()
reportName := graphmodels.PERFORMANCETRENDREPORT_CLOUDPCPERFORMANCEREPORTNAME
requestBody.SetReportName(&reportName)
filter := "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'"
requestBody.SetFilter(&filter)
select := []string {
"EventDateTime",
"SlowRoundTripTimeCloudPcCount",
"LowUdpConnectionPercentageCount",
"NoActiveTimeConnectedCount",
"LowActiveTimeConnectedCount",
}
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().RetrieveCloudPcTenantMetricsReport().Post(context.Background(), requestBody, nil)
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.
// 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.retrievecloudpctenantmetricsreport.RetrieveCloudPcTenantMetricsReportPostRequestBody retrieveCloudPcTenantMetricsReportPostRequestBody = new com.microsoft.graph.beta.devicemanagement.virtualendpoint.reports.retrievecloudpctenantmetricsreport.RetrieveCloudPcTenantMetricsReportPostRequestBody();
retrieveCloudPcTenantMetricsReportPostRequestBody.setReportName(CloudPCPerformanceReportName.PerformanceTrendReport);
retrieveCloudPcTenantMetricsReportPostRequestBody.setFilter("EventDateTime gt datetime'2023-10-13T00:00:00.000Z'");
LinkedList<String> select = new LinkedList<String>();
select.add("EventDateTime");
select.add("SlowRoundTripTimeCloudPcCount");
select.add("LowUdpConnectionPercentageCount");
select.add("NoActiveTimeConnectedCount");
select.add("LowActiveTimeConnectedCount");
retrieveCloudPcTenantMetricsReportPostRequestBody.setSelect(select);
retrieveCloudPcTenantMetricsReportPostRequestBody.setSearch("");
retrieveCloudPcTenantMetricsReportPostRequestBody.setSkip(0);
retrieveCloudPcTenantMetricsReportPostRequestBody.setTop(50);
graphClient.deviceManagement().virtualEndpoint().reports().retrieveCloudPcTenantMetricsReport().post(retrieveCloudPcTenantMetricsReportPostRequestBody);
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.
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.
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\Reports\RetrieveCloudPcTenantMetricsReport\RetrieveCloudPcTenantMetricsReportPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\CloudPCPerformanceReportName;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new RetrieveCloudPcTenantMetricsReportPostRequestBody();
$requestBody->setReportName(new CloudPCPerformanceReportName('performanceTrendReport'));
$requestBody->setFilter('EventDateTime gt datetime\'2023-10-13T00:00:00.000Z\'');
$requestBody->setSelect(['EventDateTime', 'SlowRoundTripTimeCloudPcCount', 'LowUdpConnectionPercentageCount', 'NoActiveTimeConnectedCount', 'LowActiveTimeConnectedCount', ]);
$requestBody->setSearch('');
$requestBody->setSkip(0);
$requestBody->setTop(50);
$graphServiceClient->deviceManagement()->virtualEndpoint()->reports()->retrieveCloudPcTenantMetricsReport()->post($requestBody)->wait();
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.
# 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_tenant_metrics_report.retrieve_cloud_pc_tenant_metrics_report_post_request_body import RetrieveCloudPcTenantMetricsReportPostRequestBody
from msgraph_beta.generated.models.cloud_p_c_performance_report_name import CloudPCPerformanceReportName
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = RetrieveCloudPcTenantMetricsReportPostRequestBody(
report_name = CloudPCPerformanceReportName.PerformanceTrendReport,
filter = "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'",
select = [
"EventDateTime",
"SlowRoundTripTimeCloudPcCount",
"LowUdpConnectionPercentageCount",
"NoActiveTimeConnectedCount",
"LowActiveTimeConnectedCount",
],
search = "",
skip = 0,
top = 50,
)
await graph_client.device_management.virtual_endpoint.reports.retrieve_cloud_pc_tenant_metrics_report.post(request_body)
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.
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.DeviceManagement.VirtualEndpoint.Reports.RetrieveCloudPcTenantMetricsReport;
using Microsoft.Graph.Beta.Models;
var requestBody = new RetrieveCloudPcTenantMetricsReportPostRequestBody
{
ReportName = CloudPCPerformanceReportName.CloudPcInsightReport,
Filter = "",
Select = new List<string>
{
"ManagedDeviceName",
"DeviceId",
"ClientOS",
"ClientVersion",
"MultimediaRedirectVersion",
"TeamsClientVersion",
"HostOSVersion",
"HostSxSStackVersion",
"HostAgentVersion",
"PolicyName",
"UserSettingName",
"HostRegion",
"AzureNetworkConnectName",
},
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.RetrieveCloudPcTenantMetricsReport.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.
mgc-beta device-management virtual-endpoint reports retrieve-cloud-pc-tenant-metrics-report post
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.
// 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.NewRetrieveCloudPcTenantMetricsReportPostRequestBody()
reportName := graphmodels.CLOUDPCINSIGHTREPORT_CLOUDPCPERFORMANCEREPORTNAME
requestBody.SetReportName(&reportName)
filter := ""
requestBody.SetFilter(&filter)
select := []string {
"ManagedDeviceName",
"DeviceId",
"ClientOS",
"ClientVersion",
"MultimediaRedirectVersion",
"TeamsClientVersion",
"HostOSVersion",
"HostSxSStackVersion",
"HostAgentVersion",
"PolicyName",
"UserSettingName",
"HostRegion",
"AzureNetworkConnectName",
}
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().RetrieveCloudPcTenantMetricsReport().Post(context.Background(), requestBody, nil)
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.
// 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.retrievecloudpctenantmetricsreport.RetrieveCloudPcTenantMetricsReportPostRequestBody retrieveCloudPcTenantMetricsReportPostRequestBody = new com.microsoft.graph.beta.devicemanagement.virtualendpoint.reports.retrievecloudpctenantmetricsreport.RetrieveCloudPcTenantMetricsReportPostRequestBody();
retrieveCloudPcTenantMetricsReportPostRequestBody.setReportName(CloudPCPerformanceReportName.CloudPcInsightReport);
retrieveCloudPcTenantMetricsReportPostRequestBody.setFilter("");
LinkedList<String> select = new LinkedList<String>();
select.add("ManagedDeviceName");
select.add("DeviceId");
select.add("ClientOS");
select.add("ClientVersion");
select.add("MultimediaRedirectVersion");
select.add("TeamsClientVersion");
select.add("HostOSVersion");
select.add("HostSxSStackVersion");
select.add("HostAgentVersion");
select.add("PolicyName");
select.add("UserSettingName");
select.add("HostRegion");
select.add("AzureNetworkConnectName");
retrieveCloudPcTenantMetricsReportPostRequestBody.setSelect(select);
retrieveCloudPcTenantMetricsReportPostRequestBody.setSearch("");
retrieveCloudPcTenantMetricsReportPostRequestBody.setSkip(0);
retrieveCloudPcTenantMetricsReportPostRequestBody.setTop(50);
graphClient.deviceManagement().virtualEndpoint().reports().retrieveCloudPcTenantMetricsReport().post(retrieveCloudPcTenantMetricsReportPostRequestBody);
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.
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.
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\DeviceManagement\VirtualEndpoint\Reports\RetrieveCloudPcTenantMetricsReport\RetrieveCloudPcTenantMetricsReportPostRequestBody;
use Microsoft\Graph\Beta\Generated\Models\CloudPCPerformanceReportName;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new RetrieveCloudPcTenantMetricsReportPostRequestBody();
$requestBody->setReportName(new CloudPCPerformanceReportName('cloudPcInsightReport'));
$requestBody->setFilter('');
$requestBody->setSelect(['ManagedDeviceName', 'DeviceId', 'ClientOS', 'ClientVersion', 'MultimediaRedirectVersion', 'TeamsClientVersion', 'HostOSVersion', 'HostSxSStackVersion', 'HostAgentVersion', 'PolicyName', 'UserSettingName', 'HostRegion', 'AzureNetworkConnectName', ]);
$requestBody->setSearch('');
$requestBody->setSkip(0);
$requestBody->setTop(50);
$graphServiceClient->deviceManagement()->virtualEndpoint()->reports()->retrieveCloudPcTenantMetricsReport()->post($requestBody)->wait();
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.
# 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_tenant_metrics_report.retrieve_cloud_pc_tenant_metrics_report_post_request_body import RetrieveCloudPcTenantMetricsReportPostRequestBody
from msgraph_beta.generated.models.cloud_p_c_performance_report_name import CloudPCPerformanceReportName
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = RetrieveCloudPcTenantMetricsReportPostRequestBody(
report_name = CloudPCPerformanceReportName.CloudPcInsightReport,
filter = "",
select = [
"ManagedDeviceName",
"DeviceId",
"ClientOS",
"ClientVersion",
"MultimediaRedirectVersion",
"TeamsClientVersion",
"HostOSVersion",
"HostSxSStackVersion",
"HostAgentVersion",
"PolicyName",
"UserSettingName",
"HostRegion",
"AzureNetworkConnectName",
],
search = "",
skip = 0,
top = 50,
)
await graph_client.device_management.virtual_endpoint.reports.retrieve_cloud_pc_tenant_metrics_report.post(request_body)
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.