Skip to content

Commit 538b87f

Browse files
DanielabomDanielabom
authored
Merge pull request #26746 from microsoftgraph/main
Merge to publish.
2 parents 1cb24de + cf7f086 commit 538b87f

File tree

372 files changed

+6665
-691
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

372 files changed

+6665
-691
lines changed

‎api-reference/beta/api/cloudpcreports-getcloudpcperformancereport.md

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,19 +56,12 @@ The following table shows the parameters that you can use with this method.
5656
| filter | String | OData `$filter` syntax. Supported filters are: `and`, `or`, `gt`, and `eq`. |
5757
| groupBy | String collection | Specifies how to group the reports. If used, must have the same content as the **select** parameter. |
5858
| orderBy | String collection | Specifies how to sort the reports. |
59-
| reportName | cloudPCPerformanceReportName | The report name. The possible values are: `performanceTrendReport`, `unknownFutureValue`. |
59+
| reportName | [cloudPCPerformanceReportName](../resources/cloudpcreports.md#cloudpcperformancereportname-values) | The report name. The possible values are: `performanceTrendReport`, `unknownFutureValue`. |
6060
| search | String | Specifies a String to search. |
6161
| select | String collection | OData `$select` syntax. The selected columns of the reports. |
6262
| skip | Int32 | Number of records to skip. |
6363
| top | Int32 | Specifies the page size. If not defined, the default is 25, with a maximum of 100. |
6464

65-
### cloudPCPerformanceReportName values
66-
67-
| Member | Description |
68-
| :--------------------------- | :---------------- |
69-
| performanceTrendReport | Indicates a daily aggregated report that provides a list of connection quality metrics for Cloud PCs over the past seven days within a tenant. The metrics include `SlowRoundTripTimeCloudPcCount`, `LowUdpConnectionPercentageCount`, `NoTimeConnectedCloudPcCount`, and `LowTimeConnectedCloudPcCount`. Each daily report is an aggregation of the previous 28 days, counted back from the trigger time. |
70-
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
71-
7265
## Response
7366

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

‎api-reference/beta/api/cloudpcreports-getcloudpcrecommendationreports.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "cloudPcReports: getCloudPcRecommendationReports"
2+
title: "cloudPcReports: getCloudPcRecommendationReports (deprecated)"
33
description: "Get the device recommendation reports for Cloud PCs, such as the usage category report."
44
author: "XiaolouT"
55
ms.localizationpriority: medium
@@ -8,14 +8,17 @@ doc_type: apiPageType
88
ms.date: 06/21/2024
99
---
1010

11-
# cloudPcReports: getCloudPcRecommendationReports
11+
# cloudPcReports: getCloudPcRecommendationReports (deprecated)
1212

1313
Namespace: microsoft.graph
1414

1515
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
1616

1717
Get the device recommendation reports for Cloud PCs, such as the usage category report. The usage category report categorizes a Cloud PC as `Undersized`, `Oversized`, `Rightsized`, or `Underutilized`, and also provides the recommended SKU when the Cloud PC isn't `Rightsized`.
1818

19+
>[!CAUTION]
20+
> This API is deprecated and will stop returning data on July 01, 2025. Going forward, use the [retrieveCloudPcRecommendationReports](../api/cloudpcreports-retrievecloudpcrecommendationreports.md) API.
21+
1922
[!INCLUDE [national-cloud-support](../../includes/global-us.md)]
2023

2124
## Permissions

‎api-reference/beta/api/cloudpcreports-retrievecloudpcrecommendationreports.md

Lines changed: 264 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,264 @@
1+
---
2+
title: "cloudPcReports: retrieveCloudPcRecommendationReports"
3+
description: "Get the device recommendation reports for Cloud PCs, such as the usage category report."
4+
author: "Ward1994"
5+
ms.localizationpriority: medium
6+
ms.subservice: "cloud-pc"
7+
doc_type: apiPageType
8+
ms.date: 04/01/2025
9+
---
10+
11+
# cloudPcReports: retrieveCloudPcRecommendationReports
12+
13+
Namespace: microsoft.graph
14+
15+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
16+
17+
Get the device recommendation reports for Cloud PCs, such as the usage category report. The usage category report categorizes a Cloud PC as `Undersized`, `Oversized`, `Rightsized`, or `Underutilized`, and also provides the recommended SKU when the Cloud PC isn't `Rightsized`.
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_retrievecloudpcrecommendationreports" } -->
26+
[!INCLUDE [permissions-table](../includes/permissions/cloudpcreports-retrievecloudpcrecommendationreports-permissions.md)]
27+
28+
## HTTP request
29+
30+
<!-- {
31+
"blockType": "ignored"
32+
}
33+
-->
34+
``` http
35+
POST /deviceManagement/virtualEndpoint/reports/retrieveCloudPcRecommendationReports
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 can be used with this action.
50+
51+
|Parameter|Type|Description|
52+
|:---|:---|:---|
53+
|filter|String|OData `$filter` syntax. Supported filters are: `and`, `or`, `lt`, `le`, `gt`, `ge`, 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|[cloudPcRecommendationReportType](../resources/cloudpcreports.md#cloudpcrecommendationreporttype-values)|The report name. The possible values are: `cloudPcUsageCategoryReports`, `unknownFutureValue`. The default value is `cloudPcUsageCategoryReports`.|
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|The number of top records to return.|
61+
62+
## Response
63+
64+
If successful, this action returns a `200 OK` response code and a Stream in the response body.
65+
66+
## Examples
67+
68+
### Example 1: List the recommendation reports by device
69+
70+
The following example shows how to list the reports of the top 50 devices.
71+
72+
#### Request
73+
74+
The following example shows a request.
75+
76+
``` http
77+
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveCloudPcRecommendationReports
78+
Content-Type: application/json
79+
Content-length: 262
80+
81+
{
82+
"reportName": "cloudPcUsageCategoryReports",
83+
"top": 50,
84+
"skip": 0,
85+
"search": "",
86+
"filter": "",
87+
"select": [
88+
"CloudPcId",
89+
"ManagedDeviceName",
90+
"UserPrincipalName",
91+
"UsageInsight",
92+
"CurrentSize",
93+
"RecommendedSize",
94+
"UsageInHour",
95+
"DevicePerfSummary"
96+
],
97+
"orderBy": [
98+
"ManagedDeviceName"
99+
]
100+
}
101+
```
102+
103+
#### Response
104+
105+
The following example shows the response.
106+
107+
>**Note:** The response object shown here might be shortened for readability.
108+
<!-- {
109+
"blockType": "response",
110+
"truncated": true,
111+
"@odata.type": "Edm.Stream"
112+
}
113+
-->
114+
``` http
115+
HTTP/1.1 200 OK
116+
Content-Type: application/octet-stream
117+
118+
{
119+
"TotalRowCount": 489,
120+
"Schema": [
121+
{
122+
"Column": "CloudPcId",
123+
"PropertyType": "String"
124+
},
125+
{
126+
"Column": "ManagedDeviceName",
127+
"PropertyType": "String"
128+
},
129+
{
130+
"Column": "UserPrincipalName",
131+
"PropertyType": "String"
132+
},
133+
{
134+
"Column": "UsageInsight",
135+
"PropertyType": "String"
136+
},
137+
{
138+
"Column": "CurrentSize",
139+
"PropertyType": "Json"
140+
},
141+
{
142+
"Column": "RecommendedSize",
143+
"PropertyType": "Json"
144+
},
145+
{
146+
"Column": "UsageInHour",
147+
"PropertyType": "Double"
148+
},
149+
{
150+
"Column": "DevicePerfSummary",
151+
"PropertyType": "Json"
152+
}
153+
],
154+
"Values": [
155+
[
156+
"4db3619f-be92-42a7-8c74-43fab185da6f",
157+
"1MoveHost",
158+
"connie_1@contoso.com",
159+
"Rightsized",
160+
{
161+
"NumvCPUs": 2,
162+
"RamInGB": 8,
163+
"OsDiskSizeInGB": 128
164+
},
165+
null,
166+
0,
167+
{
168+
"CPUUsagePercentageP90": 0.3,
169+
"RAMUsagePercentageP90": 0.4
170+
}
171+
],
172+
[
173+
"f2ee066c-f63e-4acd-a41e-e348db71cb4d",
174+
"AXFBF",
175+
"connie_2@contoso.com",
176+
"Rightsized",
177+
{
178+
"NumvCPUs": 2,
179+
"RamInGB": 8,
180+
"OsDiskSizeInGB": 128
181+
},
182+
null,
183+
0,
184+
{
185+
"CPUUsagePercentageP90": 0.2,
186+
"RAMUsagePercentageP90": 0.3
187+
}
188+
]
189+
]
190+
}
191+
```
192+
193+
### Example 2: Get summary reports by usage insight
194+
195+
The following example shows how to summarize the report by usage insight.
196+
197+
#### Request
198+
199+
The following example shows a request.
200+
201+
``` http
202+
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveCloudPcRecommendationReports
203+
Content-Type: application/json
204+
Content-length: 262
205+
206+
{
207+
"reportName": "cloudPcUsageCategoryReports",
208+
"select": [
209+
"UsageInsight"
210+
],
211+
"groupBy": [
212+
"UsageInsight"
213+
],
214+
"filter": ""
215+
}
216+
```
217+
218+
#### Response
219+
220+
The following example shows the response.
221+
222+
>**Note:** The response object shown here might be shortened for readability.
223+
<!-- {
224+
"blockType": "response",
225+
"truncated": true,
226+
"@odata.type": "Edm.Stream"
227+
}
228+
-->
229+
``` http
230+
HTTP/1.1 200 OK
231+
Content-Type: application/octet-stream
232+
233+
{
234+
"TotalRowCount": 4,
235+
"Schema": [
236+
{
237+
"Column": "__Count",
238+
"PropertyType": "Int32"
239+
},
240+
{
241+
"Column": "UsageInsight",
242+
"PropertyType": "String"
243+
}
244+
],
245+
"Values": [
246+
[
247+
200,
248+
"Rightsized"
249+
],
250+
[
251+
50,
252+
"Undersized"
253+
],
254+
[
255+
30,
256+
"Oversized"
257+
],
258+
[
259+
40,
260+
"Underutilized"
261+
]
262+
]
263+
}
264+
```

0 commit comments

Comments
 (0)