Skip to content

Commit af74cde

Browse files
authored
Merge pull request #25912 from microsoftgraph/yuxiang/onboard-regionalInaccessibleCloudPcTrendReport
Onboard regionalInaccessibleCloudPcTrendReport report name
2 parents 9c6a24f + a418c43 commit af74cde

File tree

6 files changed

+123
-9
lines changed

6 files changed

+123
-9
lines changed

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

Lines changed: 84 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ POST /deviceManagement/virtualEndpoint/reports/getInaccessibleCloudPcReports
4141
|:---|:---|
4242
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
4343
|Content-Type|application/json. Required.|
44+
| Prefer: include-unknown-enum-members | Enables evolvable enum values beyond the sentinel value. For more information, see [Best practices for working with Microsoft Graph](/graph/best-practices-concept#handling-future-members-in-evolvable-enumerations). Optional. |
4445

4546
## Request body
4647

@@ -53,7 +54,7 @@ The following table shows the parameters that you can use with this method.
5354
| filter | String | OData `$filter` syntax. Only `and`, `or`, `gt` ,`ge` and `eq` are currently supported. |
5455
| groupBy | String collection | Specifies how to group the reports. If used, must have the same content as the select parameter.|
5556
| 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+
| reportName | cloudPCInaccessibleReportName | The report name. The possible values are: `inaccessibleCloudPcReports`, `inaccessibleCloudPcTrendReport`, `unknownFutureValue`, `regionalInaccessibleCloudPcTrendReport`. The default value is `inaccessibleCloudPcReports` if the **reportName** is empty. You must 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): `regionalInaccessibleCloudPcTrendReport`. |
5758
| search | String | Specifies a String to search for. |
5859
| select | String collection | OData `$select` syntax. Represents the selected columns of the reports. |
5960
| skip | Int32 | Number of records to skip. |
@@ -66,14 +67,19 @@ The following table shows the parameters that you can use with this method.
6667
| inaccessibleCloudPcReports | Indicates a report that contains details of Cloud PCs that are inaccessible, including those with consecutive connection failures or in an unavailable state. |
6768
| 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. |
6869
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
70+
| regionalInaccessibleCloudPcTrendReport | Indicates the weekly regional aggregated report of inaccessible Cloud PC trends. |
6971

7072
## Response
7173

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

7476
## Examples
7577

76-
### Request
78+
### Example 1: Get reports of inaccessible Cloud PCs in a specific region
79+
80+
The following example shows how to get reports of inaccessible Cloud PCs in a specific region.
81+
82+
#### Request
7783

7884
The following example shows a request.
7985

@@ -142,7 +148,7 @@ Content-length: 199
142148

143149
---
144150

145-
### Response
151+
#### Response
146152

147153
The following example shows the response.
148154
<!-- {
@@ -240,3 +246,78 @@ Content-Type: application/octet-stream
240246
}
241247
```
242248

249+
### Example 2: Get the weekly regional aggregated report of inaccessible Cloud PC trends
250+
251+
The following example shows how to get the weekly regional aggregated report of inaccessible Cloud PC trends.
252+
253+
#### Request
254+
255+
The following example shows a request.
256+
257+
``` http
258+
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/getInaccessibleCloudPcReports
259+
Content-Type: application/json
260+
Prefer: include-unknown-enum-members
261+
262+
{
263+
"reportName": "regionalInaccessibleCloudPcTrendReport",
264+
"filter": "",
265+
"select": [
266+
"HostRegionName",
267+
"CloudPcCount",
268+
"WeeklyPeakInaccessibleCloudPcCount",
269+
"Last24hPeakInaccessibleCloudPcCount",
270+
"WeeklyInaccessibleTrend"
271+
],
272+
"search": "",
273+
"skip": 0,
274+
"top": 50
275+
}
276+
```
277+
278+
#### Response
279+
280+
The following example shows the response.
281+
282+
>**Note:** The response object shown here might be shortened for readability.
283+
<!-- {
284+
"blockType": "response",
285+
"truncated": true,
286+
"@odata.type": "Edm.Stream"
287+
}
288+
-->
289+
``` http
290+
HTTP/1.1 200 OK
291+
Content-Type: application/octet-stream
292+
293+
{
294+
"TotalRowCount": 2,
295+
"Schema": [
296+
{
297+
"Column": "HostRegionName",
298+
"PropertyType": "String"
299+
},
300+
{
301+
"Column": "CloudPcCount",
302+
"PropertyType": "Int64"
303+
},
304+
{
305+
"Column": "WeeklyPeakInaccessibleCloudPcCount",
306+
"PropertyType": "Int64"
307+
},
308+
{
309+
"Column": "Last24hPeakInaccessibleCloudPcCount",
310+
"PropertyType": "Int64"
311+
},
312+
{
313+
"Column": "WeeklyInaccessibleTrend",
314+
"PropertyType": "String"
315+
}
316+
],
317+
"Values": [
318+
[ "Japan East", 46, 10, 5, "Increasing" ],
319+
[ "East US", 1, 0, 0, "Decreasing" ]
320+
]
321+
}
322+
```
323+

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ You can specify the following properties when you create a **cloudPcExportJob**.
5050
|:---|:---|:---|
5151
|filter|String|The filter applied on the report. Optional.|
5252
|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`, `cloudPcInsightReport`. 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`, `cloudPcInsightReport`.|
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`, `cloudPcInsightReport`, `regionalInaccessibleCloudPcTrendReport`. 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`, `cloudPcInsightReport`, `regionalInaccessibleCloudPcTrendReport`.|
5454
|select|String collection|The selected columns of the report. Optional.|
5555

5656
## Response

api-reference/beta/resources/cloudpcexportjob.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Represents the export job for downloading a specified Cloud PC report.
3333
| filter | String | The filter applied on the report. |
3434
| format | String | The format of the exported report. |
3535
| id | String | The unique identifier for the report. Read-only. |
36-
| reportName | [cloudPcReportName](#cloudpcreportname-values) | The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `actionStatusReport`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `crossRegionDisasterRecoveryReport`, `regionalConnectionQualityTrendReport`, `regionalConnectionQualityInsightsReport`, `remoteConnectionQualityReport`, `bulkActionStatusReport`, `cloudPcInsightReport`. 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`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `crossRegionDisasterRecoveryReport`, `cloudPcInsightReport`.|
36+
| reportName | [cloudPcReportName](#cloudpcreportname-values) | The report name. The possible values are: `remoteConnectionHistoricalReports`, `dailyAggregatedRemoteConnectionReports`, `totalAggregatedRemoteConnectionReports`, `sharedUseLicenseUsageReport`, `sharedUseLicenseUsageRealTimeReport`, `unknownFutureValue`, `noLicenseAvailableConnectivityFailureReport`, `frontlineLicenseUsageReport`, `frontlineLicenseUsageRealTimeReport`, `remoteConnectionQualityReports`, `inaccessibleCloudPcReports`, `actionStatusReport`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `crossRegionDisasterRecoveryReport`, `regionalConnectionQualityTrendReport`, `regionalConnectionQualityInsightsReport`, `remoteConnectionQualityReport`, `bulkActionStatusReport`, `cloudPcInsightReport`, `regionalInaccessibleCloudPcTrendReport`. 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`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `crossRegionDisasterRecoveryReport`, `cloudPcInsightReport`, `regionalInaccessibleCloudPcTrendReport`.|
3737
| requestDateTime | DateTimeOffset | The date and time when the export job was requested. |
3838
| select | String collection | The selected columns of the report. |
3939

@@ -73,6 +73,7 @@ Represents the export job for downloading a specified Cloud PC report.
7373
| remoteConnectionQualityReport | The overall connection quality reports for all devices under a tenant. |
7474
| bulkActionStatusReport | The details of Cloud PC bulk actions, including bulk action status, name, type, state, completion state, and request date time. |
7575
| cloudPcInsightReport | Indicates Cloud PC-level configuration data and troubleshooting data with insights, including client version, client operating system, host region, Teams media, error source, error code symbolic, and error message. |
76+
| regionalInaccessibleCloudPcTrendReport | The weekly regional aggregated report of inaccessible Cloud PC trends. |
7677

7778
## Relationships
7879

api-reference/beta/resources/enums.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5000,6 +5000,7 @@ Possible values for user account types (group membership), per Windows definitio
50005000
| inaccessibleCloudPcReports |
50015001
| inaccessibleCloudPcTrendReport |
50025002
| unknownFutureValue |
5003+
| regionalInaccessibleCloudPcTrendReport |
50035004

50045005
### nonAdminSetting values
50055006

changelog/Microsoft.CloudManagedDesktop.json

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,32 @@
5858
"WorkloadArea": "Device and app management",
5959
"SubArea": "Cloud PC"
6060
},
61+
{
62+
"ChangeList": [
63+
{
64+
"Id": "2e32a5b5-133e-45f4-9978-53c81843ca6d",
65+
"ApiChange": "Member",
66+
"ChangedApiName": "regionalInaccessibleCloudPcTrendReport",
67+
"ChangeType": "Addition",
68+
"Description": "Added the `regionalInaccessibleCloudPcTrendReport` member to the **cloudPCInaccessibleReportName** enumeration.",
69+
"Target": "cloudPCInaccessibleReportName"
70+
},
71+
{
72+
"Id": "2e32a5b5-133e-45f4-9978-53c81843ca6d",
73+
"ApiChange": "Member",
74+
"ChangedApiName": "regionalInaccessibleCloudPcTrendReport",
75+
"ChangeType": "Addition",
76+
"Description": "Added the `regionalInaccessibleCloudPcTrendReport` member to the **cloudPcReportName** enumeration.",
77+
"Target": "cloudPcReportName"
78+
}
79+
],
80+
"Id": "2e32a5b5-133e-45f4-9978-53c81843ca6d",
81+
"Cloud": "Prod",
82+
"Version": "beta",
83+
"CreatedDateTime": "2025-02-14T20:16:26.0746374Z",
84+
"WorkloadArea": "Device and app management",
85+
"SubArea": "Cloud PC"
86+
},
6187
{
6288
"ChangeList": [
6389
{
@@ -787,7 +813,7 @@
787813
"Cloud": "Prod",
788814
"Version": "beta",
789815
"CreatedDateTime": "2024-07-22T07:08:27.3298762Z",
790-
"WorkloadArea": "Devices and apps",
816+
"WorkloadArea": "Device and app management",
791817
"SubArea": "Cloud PC"
792818
},
793819
{
@@ -5715,7 +5741,7 @@
57155741
"Cloud": "Prod",
57165742
"Version": "beta",
57175743
"CreatedDateTime": "2023-12-07T11:14:41.3424906Z",
5718-
"WorkloadArea": "Devices and apps",
5744+
"WorkloadArea": "Device and app management",
57195745
"SubArea": "Cloud PC"
57205746
},
57215747
{
@@ -6361,7 +6387,7 @@
63616387
"Cloud": "Prod",
63626388
"Version": "beta",
63636389
"CreatedDateTime": "2024-10-21T08:35:28.2259205Z",
6364-
"WorkloadArea": "Devices and apps",
6390+
"WorkloadArea": "Device and app management",
63656391
"SubArea": "Cloud PC"
63666392
},
63676393
{
@@ -6379,7 +6405,7 @@
63796405
"Cloud": "Prod",
63806406
"Version": "beta",
63816407
"CreatedDateTime": "2024-11-27T06:03:45.3975846Z",
6382-
"WorkloadArea": "Devices and apps",
6408+
"WorkloadArea": "Device and app management",
63836409
"SubArea": "Cloud PC"
63846410
},
63856411
{

concepts/whats-new-overview.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ Added [teamsMessageEvidence](/graph/api/resources/security-teamsmessageevidence)
4343

4444
Added the **itemsToInclude**, **cloudAttachmentVersion**, **documentVersion**, **additionalDataOptions**, and **statisticsOptions** as supported properties and parameters across various resources and actions of the eDiscovery API.
4545

46+
### Device and app management | Cloud PC
47+
48+
[Get the weekly regional aggregated report of inaccessible Cloud PC trends](/graph/api/cloudpcreports-getinaccessiblecloudpcreports?view=graph-rest-beta&&preserve-view=true#example-2-get-the-weekly-regional-aggregated-report-of-inaccessible-cloud-pc-trends).
49+
4650
### Identity and access | Identity and sign-in
4751

4852
Replaced the following API operations for managing custom authentication extensions:
@@ -105,6 +109,7 @@ Enabled change notifications support to the methods to [list](/graph/api/subscri
105109
- [Retry](/graph/api/cloudpcbulkaction-retry?view=graph-rest-beta&preserve-view=true) a bulk action with selected Cloud PCs.
106110
- Use the **productType** property on [cloudPC](/graph/api/resources/cloudpc?view=graph-rest-beta&preserve-view=true) to get the product type of a Cloud PC or to filter Cloud PCs by product type.
107111
- Deprecated the [getCloudPcPerformanceReport](/graph/api/cloudpcreports-getcloudpcperformancereport?view=graph-rest-beta&preserve-view=true) method of the [cloudPcReports](/graph/api/resources/cloudpcreports?view=graph-rest-beta&preserve-view=true) resource in favor of the [retrieveCloudPcTenantMetricsReport](/graph/api/cloudpcreports-retrievecloudpctenantmetricsreport?view=graph-rest-beta&preserve-view=true) method.
112+
- [Get the weekly regional aggregated report of inaccessible Cloud PC trends](/graph/api/cloudpcreports-getinaccessiblecloudpcreports?view=graph-rest-beta&&preserve-view=true#example-2-get-the-weekly-regional-aggregated-report-of-inaccessible-cloud-pc-trends).
108113

109114
### Files
110115

0 commit comments

Comments
 (0)