Skip to content

Commit a69a61a

Browse files
FaithOmbongiFaithOmbongi
authored
Merge pull request #23035 from microsoftgraph/gph/add-cloudpcPerformanceReport-and-inaccesibleReportname
[Cloud PC] add getCloudPCPerformanceReport and add inaccessible cloudpc report name
2 parents 76e8742 + 3b55361 commit a69a61a

10 files changed

+272
-11
lines changed

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

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
---
2+
title: "cloudPcReports: getCloudPCPerformanceReport"
3+
description: "Get a report related to the performance of Cloud PCs."
4+
author: "Gutentag0004"
5+
ms.localizationpriority: medium
6+
ms.subservice: "cloud-pc"
7+
doc_type: apiPageType
8+
ms.date: 11/30/2024
9+
---
10+
11+
# cloudPcReports: getCloudPCPerformanceReport
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+
## Permissions
20+
21+
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).
22+
23+
<!-- { "blockType": "permissions", "name": "cloudpcreports-getcloudpcperformancereport" } -->
24+
[!INCLUDE [permissions-table](../includes/permissions/cloudpcreports-getcloudpcperformancereport-permissions.md)]
25+
26+
## HTTP request
27+
28+
<!-- {
29+
"blockType": "ignored"
30+
}
31+
-->
32+
``` http
33+
POST /deviceManagement/virtualEndpoint/reports/getCloudPCPerformanceReport
34+
```
35+
36+
## Request headers
37+
38+
|Name|Description|
39+
|:---|:---|
40+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
41+
|Content-Type|application/json. Required.|
42+
43+
## Request body
44+
45+
In the request body, supply a JSON representation of the parameters.
46+
47+
The following table shows the parameters that you can use with this method.
48+
49+
| Parameter | Type | Description |
50+
|:-----------|:-----------------------------|:-----------------------------------------------------------------------------------------------------|
51+
| filter | String | OData `$filter` syntax. Supported filters are: `and`, `or`, `gt`, and `eq`. |
52+
| groupBy | String collection | Specifies how to group the reports. If used, must have the same content as the **select** parameter. |
53+
| orderBy | String collection | Specifies how to sort the reports. |
54+
| reportName | cloudPCPerformanceReportName | The report name. The possible values are: `performanceTrendReport`, `unknownFutureValue`. |
55+
| search | String | Specifies a String to search. |
56+
| select | String collection | OData `$select` syntax. The selected columns of the reports. |
57+
| skip | Int32 | Number of records to skip. |
58+
| top | Int32 | Specifies the page size. If not defined, the default is 25, with a maximum of 100. |
59+
60+
### cloudPCPerformanceReportName values
61+
62+
| Member | Description |
63+
| :--------------------------- | :---------------- |
64+
| 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. |
65+
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
66+
67+
## Response
68+
69+
If successful, this method returns a `200 OK` response code and a Stream object in the response body.
70+
71+
## Examples
72+
73+
### Request
74+
75+
The following example shows a request.
76+
77+
<!-- {
78+
"blockType": "request",
79+
"name": "cloudpcreportsthis.getcloudpcperformancereport"
80+
}
81+
-->
82+
``` http
83+
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/getCloudPcPerformanceReport
84+
Content-Type: application/json
85+
86+
{
87+
"reportName": "performanceTrendReport",
88+
"filter": "EventDateTime gt datetime'2023-10-13T00:00:00.000Z'",
89+
"select": [
90+
"EventDateTime",
91+
"SlowRoundTripTimeCloudPcCount",
92+
"LowUdpConnectionPercentageCount",
93+
"NoActiveTimeConnectedCount",
94+
"LowActiveTimeConnectedCount"
95+
],
96+
"search": "",
97+
"skip": 0,
98+
"top": 50
99+
}
100+
```
101+
102+
### Response
103+
104+
The following example shows the response.
105+
106+
>**Note:** The response object shown here might be shortened for readability.
107+
<!-- {
108+
"blockType": "response",
109+
"truncated": true,
110+
"@odata.type": "Edm.Stream"
111+
} -->
112+
``` http
113+
HTTP/1.1 200 OK
114+
Content-Type: application/octet-stream
115+
116+
{
117+
"TotalRowCount": 2,
118+
"Schema": [
119+
{
120+
"Column": "EventDateTime",
121+
"PropertyType": "DateTime"
122+
},
123+
{
124+
"Column": "SlowRoundTripTimeCloudPcCount",
125+
"PropertyType": "Int64"
126+
},
127+
{
128+
"Column": "LowUdpConnectionPercentageCount",
129+
"PropertyType": "Int64"
130+
},
131+
{
132+
"Column": "NoActiveTimeConnectedCount",
133+
"PropertyType": "Int64"
134+
},
135+
{
136+
"Column": "LowActiveTimeConnectedCount",
137+
"PropertyType": "Int64"
138+
}
139+
],
140+
"Values": [
141+
[
142+
"2023-10-16T00:00:00Z",
143+
3,
144+
8,
145+
3,
146+
92
147+
],
148+
[
149+
"2023-10-15T00:00:00Z",
150+
4,
151+
6,
152+
5,
153+
91
154+
]
155+
]
156+
}
157+
```
158+

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

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,18 +46,27 @@ POST /deviceManagement/virtualEndpoint/reports/getInaccessibleCloudPcReports
4646

4747
In the request body, supply a JSON representation of the parameters.
4848

49-
The following table shows the parameters that can be used with this method.
49+
The following table shows the parameters that you can use with this method.
5050

5151
| Parameter | Type | Description |
5252
|:----------|:------------------|:-------------------------------------------------------------------------------------------|
5353
| filter | String | OData `$filter` syntax. Only `and`, `or`, `gt` ,`ge` and `eq` are currently supported. |
54-
| select | String collection | OData `$select` syntax. Represents the selected columns of the reports. |
55-
| search | String | Specifies a String to search for. |
5654
| groupBy | String collection | Specifies how to group the reports. If used, must have the same content as the select parameter.|
5755
| orderBy | String collection | Specifies how to sort the reports. |
56+
| reportName | cloudPCInaccessibleReportName | The report name. The possible values are: `inaccessibleCloudPcReports`, `inaccessibleCloudPcTrendReport`, `unknownFutureValue`. The default value is `inaccessibleCloudPcReports` if the **reportName** is empty. |
57+
| search | String | Specifies a String to search for. |
58+
| select | String collection | OData `$select` syntax. Represents the selected columns of the reports. |
5859
| skip | Int32 | Number of records to skip. |
5960
| top | Int32 | The number of top records to return. |
6061

62+
### cloudPCInaccessibleReportName values
63+
64+
| Member | Description |
65+
| :------------------------------ | :------------------------ |
66+
| inaccessibleCloudPcReports | Indicates a report that contains details of Cloud PCs that are inaccessible, including those with consecutive connection failures or in an unavailable state. |
67+
| inaccessibleCloudPcTrendReport| Indicates a daily aggregated report for a specified period that contains details of Cloud PCs that are inaccessible, including those with consecutive connection failures or in an unavailable state. |
68+
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
69+
6170
## Response
6271

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

‎api-reference/beta/api/cloudpcreports-post-exportjobs.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ You can specify the following properties when you create a **cloudPcExportJob**.
4949
|Property|Type|Description|
5050
|:---|:---|:---|
5151
|filter|String|The filter applied on the report. Optional.|
52-
|reportName|cloudPcReportName|The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `crossRegionDisasterRecoveryReport`, `regionalConnectionQualityTrendReport`, `regionalConnectionQualityInsightsReport`, `remoteConnectionQualityReport`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `crossRegionDisasterRecoveryReport`.|
52+
|format|String|The format of the exported report. Optional.|
53+
|reportName|[cloudPcReportName](../resources/cloudpcexportjob.md#cloudpcreportname-values)|The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `crossRegionDisasterRecoveryReport`, `performanceTrendReport`, `inaccessibleCloudPcTrendReport`, `regionalConnectionQualityTrendReport`, `regionalConnectionQualityInsightsReport`, `remoteConnectionQualityReport`. You must use the `Prefer: include-unknown-enum-members` request header to get the following values in this [evolvable enum](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations): `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `crossRegionDisasterRecoveryReport`, `performanceTrendReport`, `inaccessibleCloudPcTrendReport`, `regionalConnectionQualityTrendReport`, `regionalConnectionQualityInsightsReport`, `remoteConnectionQualityReport`.|
5354
|select|String collection|The selected columns of the report. Optional.|
5455

5556
## Response

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

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
description: "Automatically generated file. DO NOT MODIFY"
3+
ms.topic: include
4+
ms.localizationpriority: medium
5+
---
6+
7+
|Permission type|Least privileged permissions|Higher privileged permissions|
8+
|:---|:---|:---|
9+
|Delegated (work or school account)|CloudPC.Read.All|CloudPC.ReadWrite.All|
10+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
11+
|Application|CloudPC.Read.All|CloudPC.ReadWrite.All|

‎api-reference/beta/resources/cloudpcexportjob.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,18 @@ Represents the export job for downloading a specified Cloud PC report.
5656
| totalAggregatedRemoteConnectionReports | The total aggregated remote connections report. |
5757
| sharedUseLicenseUsageReport | The daily/hourly aggregated shared use license usage report. |
5858
| sharedUseLicenseUsageRealTimeReport | The real-time data for shared use license usage. |
59-
| unknownFutureValue | Evolvable enumeration sentinel value. Do not use. |
59+
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
6060
| noLicenseAvailableConnectivityFailureReport | The Cloud PCs that failed to connect because no licenses were available. |
61-
| frontlineLicenseUsageReport | The daily/hourly aggregated Windows 365 Frontline license usage report. |
62-
| frontlineLicenseUsageRealTimeReport | The real-time data for Windows 365 Frontline license usage. |
63-
| remoteConnectionQualityReports (deprecated) | The overall connection quality report for all devices within a tenant. Starting from December 31, 2024, this member ('remoteConnectionQualityReports') will be deprecated and no longer supported. Please use 'remoteConnectionQualityReport' instead. |
64-
| inaccessibleCloudPcReports | The Cloud PCs that are inaccessible. |
61+
| frontlineLicenseUsageReport | The daily/hourly aggregated Windows 365 Frontline license usage report. |
62+
| frontlineLicenseUsageRealTimeReport | The real-time data for Windows 365 Frontline license usage. |
63+
| remoteConnectionQualityReports (deprecated) | The overall connection quality report for all devices within a tenant. Starting from December 31, 2024, the `remoteConnectionQualityReports` member will be deprecated and no longer supported. Going forward, use the `remoteConnectionQualityReport` member. |
64+
| inaccessibleCloudPcReports | The Cloud PCs that are inaccessible. |
6565
| actionStatusReport | The actions status report for the Cloud PCs. |
66-
| rawRemoteConnectionReports | The raw real-time remote connection report. |
66+
| rawRemoteConnectionReports | The raw real-time remote connection report. |
6767
| cloudPcUsageCategoryReports | The usage category reports of Cloud PCs. |
68-
| crossRegionDisasterRecoveryReport | The cross-region disaster recovery status for Cloud PCs. |
68+
| crossRegionDisasterRecoveryReport | The cross-region disaster recovery status for Cloud PCs. |
69+
| performanceTrendReport | The 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+
| inaccessibleCloudPcTrendReport | The daily aggregated report for a specified period that contains details of Cloud PCs that are inaccessible, including those with consecutive connection failures or in an unavailable state. |
6971
| regionalConnectionQualityTrendReport | The regional connection quality trend reports of Cloud PCs. |
7072
| regionalConnectionQualityInsightsReport | The regional connection quality insights reports of Cloud PCs. |
7173
| remoteConnectionQualityReport | The overall connection quality reports for all devices under a tenant. |

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Use a method in the [Methods](#methods) section to get the corresponding report
2222
|Method|Return type|Description|
2323
|:---|:---|:---|
2424
|[Get action status reports](../api/cloudpcreports-getactionstatusreports.md)|Stream|Get the remote action status reports, including data such as the Cloud PC ID, Cloud PC device display name, initiating user's principal name, device owner's user principal name, action taken, and action state.|
25+
|[Get Cloud PC performance report](../api/cloudpcreports-getcloudpcperformancereport.md)|Stream|Get a report related to the performance of Cloud PCs.|
2526
|[Get bulk action status reports](../api/cloudpcreports-retrievebulkactionstatusreport.md)|Stream|Get the bulk remote action status reports, including data such as the bulk action ID, bulk action display name, initiating user's principal name, action type, and action state.|
2627
|[Get Cloud PC recommendation reports](../api/cloudpcreports-getcloudpcrecommendationreports.md)|Stream|Get the device recommendation reports for Cloud PCs, such as the usage category report.|
2728
|[Get frontline report](../api/cloudpcreports-getfrontlinereport.md)|Stream| Get Frontline Cloud PC license usage reports, such as **servicePlanId**, **licenseCount**, and **claimedLicenseCount**, for real-time, 7 days, or 28 days trend.|

‎api-reference/beta/resources/enums.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ doc_type: enumPageType
55
ms.localizationpriority: medium
66
ms.subservice: "non-product-specific"
77
author: "MSGraphDocsvTeam"
8+
ms.date: 11/30/2024
89
---
910

1011
# Enum values
@@ -4934,6 +4935,21 @@ Possible values for user account types (group membership), per Windows definitio
49344935
| all |
49354936
| unknownFutureValue |
49364937

4938+
### cloudPCPerformanceReportName values
4939+
4940+
| Member |
4941+
| ---------------------- |
4942+
| performanceTrendReport |
4943+
| unknownFutureValue |
4944+
4945+
### cloudPCInaccessibleReportName values
4946+
4947+
| Member |
4948+
| ------------------------------ |
4949+
| inaccessibleCloudPcReports |
4950+
| inaccessibleCloudPcTrendReport |
4951+
| unknownFutureValue |
4952+
49374953
### nonAdminSetting values
49384954

49394955
|Member|

‎api-reference/beta/toc/device-and-app-management/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -276,6 +276,8 @@ items:
276276
href: ../../resources/cloudpcreports.md
277277
- name: Get action status reports
278278
href: ../../api/cloudpcreports-getactionstatusreports.md
279+
- name: Get Cloud PC performance report
280+
href: ../../api/cloudpcreports-getcloudpcperformancereport.md
279281
- name: Get bulk action status reports
280282
href: ../../api/cloudpcreports-retrievebulkactionstatusreport.md
281283
- name: Get Cloud PC recommendation reports

0 commit comments

Comments
 (0)