|
| 1 | +--- |
| 2 | +title: "cloudPcReports: retrieveCloudPcTenantMetricsReport" |
| 3 | +description: "Get a report related to the performance of Cloud PCs." |
| 4 | +author: "YanLemon" |
| 5 | +ms.localizationpriority: medium |
| 6 | +ms.subservice: "cloud-pc" |
| 7 | +doc_type: apiPageType |
| 8 | +ms.date: 1/13/2025 |
| 9 | +--- |
| 10 | + |
| 11 | +# cloudPcReports: retrieveCloudPcTenantMetricsReport |
| 12 | + |
| 13 | +Namespace: microsoft.graph |
| 14 | + |
| 15 | +[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)] |
| 16 | + |
| 17 | +Get a report related to the performance of Cloud PCs. |
| 18 | + |
| 19 | +[!INCLUDE [national-cloud-support](../../includes/global-us.md)] |
| 20 | + |
| 21 | +## Permissions |
| 22 | + |
| 23 | +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](/graph/permissions-overview#best-practices-for-using-microsoft-graph-permissions). For details about delegated and application permissions, see [Permission types](/graph/permissions-overview#permission-types). To learn more about these permissions, see the [permissions reference](/graph/permissions-reference). |
| 24 | + |
| 25 | +<!-- { "blockType": "permissions", "name": "cloudpcreports-retrieveCloudPcTenantMetricsReport" } --> |
| 26 | +[!INCLUDE [permissions-table](../includes/permissions/cloudpcreports-retrievecloudpctenantmetricsreport-permissions.md)] |
| 27 | + |
| 28 | +## HTTP request |
| 29 | + |
| 30 | +<!-- { |
| 31 | + "blockType": "ignored" |
| 32 | +} |
| 33 | +--> |
| 34 | +``` http |
| 35 | +POST /deviceManagement/virtualEndpoint/reports/retrieveCloudPcTenantMetricsReport |
| 36 | +``` |
| 37 | + |
| 38 | +## Request headers |
| 39 | + |
| 40 | +|Name|Description| |
| 41 | +|:---|:---| |
| 42 | +|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).| |
| 43 | +|Content-Type|application/json. Required.| |
| 44 | + |
| 45 | +## Request body |
| 46 | + |
| 47 | +In the request body, supply a JSON representation of the parameters. |
| 48 | + |
| 49 | +The following table shows the parameters that you can use with this method. |
| 50 | + |
| 51 | +| Parameter | Type | Description | |
| 52 | +|:-----------|:-----------------------------|:-----------------------------------------------------------------------------------------------------| |
| 53 | +| filter | String | OData `$filter` syntax. Supported filters are: `and`, `or`, `gt`, and `eq`. | |
| 54 | +| groupBy | String collection | Specifies how to group the reports. If used, must have the same content as the **select** parameter. | |
| 55 | +| orderBy | String collection | Specifies how to sort the reports. | |
| 56 | +| reportName | [cloudPCPerformanceReportName](../resources/cloudpcreports.md#cloudpcperformancereportname-values) | 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](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `cloudPcInsightReport`. | |
| 57 | +| search | String | Specifies a String to search. | |
| 58 | +| select | String collection | OData `$select` syntax. The selected columns of the reports. | |
| 59 | +| skip | Int32 | Number of records to skip. | |
| 60 | +| top | Int32 | Specifies the page size. If not defined, the default is 25, with a maximum value of 100. | |
| 61 | + |
| 62 | +## Response |
| 63 | + |
| 64 | +If successful, this method returns a `200 OK` response code and a Stream object in the response body. |
| 65 | + |
| 66 | +## Examples |
| 67 | + |
| 68 | +### Example 1: Get a performance trend report |
| 69 | + |
| 70 | +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. |
| 71 | + |
| 72 | +#### Request |
| 73 | + |
| 74 | +The following example shows a request. |
| 75 | + |
| 76 | +<!-- { |
| 77 | + "blockType": "request", |
| 78 | + "name": "cloudpcreportsthis.retrieveCloudPcTenantMetricsReport.performanceTrendReport" |
| 79 | +} |
| 80 | +--> |
| 81 | +``` http |
| 82 | +POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveCloudPcTenantMetricsReport |
| 83 | +Content-Type: application/json |
| 84 | +
|
| 85 | +{ |
| 86 | + "reportName": "performanceTrendReport", |
| 87 | + "filter": "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'", |
| 88 | + "select": [ |
| 89 | + "EventDateTime", |
| 90 | + "SlowRoundTripTimeCloudPcCount", |
| 91 | + "LowUdpConnectionPercentageCount", |
| 92 | + "NoActiveTimeConnectedCount", |
| 93 | + "LowActiveTimeConnectedCount" |
| 94 | + ], |
| 95 | + "search": "", |
| 96 | + "skip": 0, |
| 97 | + "top": 50 |
| 98 | +} |
| 99 | +``` |
| 100 | + |
| 101 | +#### Response |
| 102 | + |
| 103 | +The following example shows the response. |
| 104 | + |
| 105 | +>**Note:** The response object shown here might be shortened for readability. |
| 106 | +<!-- { |
| 107 | + "blockType": "response", |
| 108 | + "truncated": true, |
| 109 | + "@odata.type": "Edm.Stream" |
| 110 | +} --> |
| 111 | +``` http |
| 112 | +HTTP/1.1 200 OK |
| 113 | +Content-Type: application/octet-stream |
| 114 | +
|
| 115 | +{ |
| 116 | + "TotalRowCount": 2, |
| 117 | + "Schema": [ |
| 118 | + { |
| 119 | + "Column": "EventDateTime", |
| 120 | + "PropertyType": "DateTime" |
| 121 | + }, |
| 122 | + { |
| 123 | + "Column": "SlowRoundTripTimeCloudPcCount", |
| 124 | + "PropertyType": "Int64" |
| 125 | + }, |
| 126 | + { |
| 127 | + "Column": "LowUdpConnectionPercentageCount", |
| 128 | + "PropertyType": "Int64" |
| 129 | + }, |
| 130 | + { |
| 131 | + "Column": "NoActiveTimeConnectedCount", |
| 132 | + "PropertyType": "Int64" |
| 133 | + }, |
| 134 | + { |
| 135 | + "Column": "LowActiveTimeConnectedCount", |
| 136 | + "PropertyType": "Int64" |
| 137 | + } |
| 138 | + ], |
| 139 | + "Values": [ |
| 140 | + [ |
| 141 | + "2023-10-16T00:00:00Z", |
| 142 | + 3, |
| 143 | + 8, |
| 144 | + 3, |
| 145 | + 92 |
| 146 | + ], |
| 147 | + [ |
| 148 | + "2023-10-15T00:00:00Z", |
| 149 | + 4, |
| 150 | + 6, |
| 151 | + 5, |
| 152 | + 91 |
| 153 | + ] |
| 154 | + ] |
| 155 | +} |
| 156 | +``` |
| 157 | + |
| 158 | +### Example 2: Get a Cloud PC insight report |
| 159 | + |
| 160 | +The following example shows how to get the Cloud PC insight report that provides configuration data and insights at the Cloud PC level. |
| 161 | + |
| 162 | +#### Request |
| 163 | + |
| 164 | +The following example shows a request. |
| 165 | + |
| 166 | +<!-- { |
| 167 | + "blockType": "request", |
| 168 | + "name": "cloudpcreportsthis.retrieveCloudPcTenantMetricsReport.cloudPcInsightReport" |
| 169 | +} |
| 170 | +--> |
| 171 | +``` http |
| 172 | +POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveCloudPcTenantMetricsReport |
| 173 | +
|
| 174 | +{ |
| 175 | + "reportName": "cloudPcInsightReport", |
| 176 | + "filter": "", |
| 177 | + "select": [ |
| 178 | + "ManagedDeviceName", |
| 179 | + "DeviceId", |
| 180 | + "ClientOS", |
| 181 | + "ClientVersion", |
| 182 | + "MultimediaRedirectVersion", |
| 183 | + "TeamsClientVersion", |
| 184 | + "HostOSVersion", |
| 185 | + "HostSxSStackVersion", |
| 186 | + "HostAgentVersion", |
| 187 | + "PolicyName", |
| 188 | + "UserSettingName", |
| 189 | + "HostRegion", |
| 190 | + "AzureNetworkConnectName" |
| 191 | + ], |
| 192 | + "search": "", |
| 193 | + "skip": 0, |
| 194 | + "top": 50 |
| 195 | +} |
| 196 | +``` |
| 197 | + |
| 198 | +#### Response |
| 199 | + |
| 200 | +The following example shows the response. |
| 201 | + |
| 202 | +<!-- { |
| 203 | + "blockType": "response", |
| 204 | + "truncated": true, |
| 205 | + "@odata.type": "Edm.Stream" |
| 206 | +} --> |
| 207 | +``` http |
| 208 | +HTTP/1.1 200 OK |
| 209 | +
|
| 210 | +{ |
| 211 | + "TotalRowCount": 1, |
| 212 | + "Schema": [ |
| 213 | + { |
| 214 | + "Column": "ManagedDeviceName", |
| 215 | + "PropertyType": "String" |
| 216 | + }, |
| 217 | + { |
| 218 | + "Column": "DeviceId", |
| 219 | + "PropertyType": "String" |
| 220 | + }, |
| 221 | + { |
| 222 | + "Column": "ClientOS", |
| 223 | + "PropertyType": "String" |
| 224 | + }, |
| 225 | + { |
| 226 | + "Column": "ClientVersion", |
| 227 | + "PropertyType": "String" |
| 228 | + }, |
| 229 | + { |
| 230 | + "Column": "MultimediaRedirectVersion", |
| 231 | + "PropertyType": "String" |
| 232 | + }, |
| 233 | + { |
| 234 | + "Column": "TeamsClientVersion", |
| 235 | + "PropertyType": "String" |
| 236 | + }, |
| 237 | + { |
| 238 | + "Column": "HostOSVersion", |
| 239 | + "PropertyType": "String" |
| 240 | + }, |
| 241 | + { |
| 242 | + "Column": "HostOSVersion", |
| 243 | + "PropertyType": "String" |
| 244 | + }, |
| 245 | + { |
| 246 | + "Column": "HostSxSStackVersion", |
| 247 | + "PropertyType": "String" |
| 248 | + }, |
| 249 | + { |
| 250 | + "Column": "HostAgentVersion", |
| 251 | + "PropertyType": "String" |
| 252 | + }, |
| 253 | + { |
| 254 | + "Column": "PolicyName", |
| 255 | + "PropertyType": "String" |
| 256 | + }, |
| 257 | + { |
| 258 | + "Column": "UserSettingName", |
| 259 | + "PropertyType": "String" |
| 260 | + }, |
| 261 | + { |
| 262 | + "Column": "HostRegion", |
| 263 | + "PropertyType": "String" |
| 264 | + }, |
| 265 | + { |
| 266 | + "Column": "AzureNetworkConnectName", |
| 267 | + "PropertyType": "String" |
| 268 | + } |
| 269 | + ], |
| 270 | + "Values": [ |
| 271 | + [ |
| 272 | + "CPC_96718d38-74ef-4026-8d54-508d52901763", |
| 273 | + "96718d38-74ef-4026-8d54-508d52901763", |
| 274 | + "Windows 10", |
| 275 | + "2.0.02817.898", |
| 276 | + "1.0.2311.2004", |
| 277 | + "1.7.00.26062", |
| 278 | + "10.0.22631.4169", |
| 279 | + "rdp-sxs240705700", |
| 280 | + "1.0.9742.1900_release", |
| 281 | + "zengyantestPolicy", |
| 282 | + "mingjunTest", |
| 283 | + "eastus", |
| 284 | + "CRUD_TestIntuneAdminWSubReader" |
| 285 | + ] |
| 286 | + ] |
| 287 | +} |
| 288 | +``` |
0 commit comments