Skip to content

Commit 12d1381

Browse files
committed
onboard regionalInaccessibleCloudPcTrendReport
1 parent 0c723d4 commit 12d1381

File tree

4 files changed

+148
-6
lines changed

4 files changed

+148
-6
lines changed

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

Lines changed: 118 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The following table shows the parameters that you can use with this method.
5353
| filter | String | OData `$filter` syntax. Only `and`, `or`, `gt` ,`ge` and `eq` are currently supported. |
5454
| groupBy | String collection | Specifies how to group the reports. If used, must have the same content as the select parameter.|
5555
| 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. |
56+
| reportName | cloudPCInaccessibleReportName | The report name. The possible values are: `inaccessibleCloudPcReports`, `inaccessibleCloudPcTrendReport`, `unknownFutureValue`, `regionalInaccessibleCloudPcTrendReport`. The default value is `inaccessibleCloudPcReports` if the **reportName** is empty. |
5757
| search | String | Specifies a String to search for. |
5858
| select | String collection | OData `$select` syntax. Represents the selected columns of the reports. |
5959
| skip | Int32 | Number of records to skip. |
@@ -66,14 +66,17 @@ The following table shows the parameters that you can use with this method.
6666
| inaccessibleCloudPcReports | Indicates a report that contains details of Cloud PCs that are inaccessible, including those with consecutive connection failures or in an unavailable state. |
6767
| 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. |
6868
| unknownFutureValue | Evolvable enumeration sentinel value. Don't use. |
69+
| regionalInaccessibleCloudPcTrendReport | Indicates a weekly regional aggregated report of inaccessible Cloud PC trends. |
6970

7071
## Response
7172

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

7475
## Examples
7576

76-
### Request
77+
### Example 1: Get inaccessible Cloud PC reports in a specific region
78+
79+
#### Request
7780

7881
The following example shows a request.
7982

@@ -146,7 +149,7 @@ Content-length: 199
146149

147150
---
148151

149-
### Response
152+
#### Response
150153

151154
The following example shows the response.
152155
<!-- {
@@ -244,3 +247,115 @@ Content-Type: application/octet-stream
244247
}
245248
```
246249

250+
### Example 2: Get the weekly regional aggregated report of inaccessible cloud PC trend
251+
252+
#### Request
253+
254+
The following example shows a request.
255+
256+
# [HTTP](#tab/http)
257+
<!-- {
258+
"blockType": "request",
259+
"name": "cloudpcreports.getInaccessibleCloudPcReports_regionalTrend"
260+
}
261+
-->
262+
``` http
263+
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/getInaccessibleCloudPcReports
264+
Content-Type: application/json
265+
Content-length: 199
266+
267+
{
268+
"reportName":"regionalInaccessibleCloudPcTrendReport",
269+
"filter": "",
270+
"select": [
271+
"HostRegionName",
272+
"CloudPcCount",
273+
"WeeklyPeakInaccessibleCloudPcCount",
274+
"Last24hPeakInaccessibleCloudPcCount",
275+
"WeeklyInaccessibleTrend"
276+
],
277+
"search": "",
278+
"skip": 0,
279+
"top": 50
280+
}
281+
```
282+
283+
# [C#](#tab/csharp)
284+
[!INCLUDE [sample-code](../includes/snippets/csharp/cloudpcreportsgetinaccessiblecloudpcreports-csharp-snippets.md)]
285+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
286+
287+
# [CLI](#tab/cli)
288+
[!INCLUDE [sample-code](../includes/snippets/cli/cloudpcreportsgetinaccessiblecloudpcreports-cli-snippets.md)]
289+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
290+
291+
# [Go](#tab/go)
292+
[!INCLUDE [sample-code](../includes/snippets/go/cloudpcreportsgetinaccessiblecloudpcreports-go-snippets.md)]
293+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
294+
295+
# [Java](#tab/java)
296+
[!INCLUDE [sample-code](../includes/snippets/java/cloudpcreportsgetinaccessiblecloudpcreports-java-snippets.md)]
297+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
298+
299+
# [JavaScript](#tab/javascript)
300+
[!INCLUDE [sample-code](../includes/snippets/javascript/cloudpcreportsgetinaccessiblecloudpcreports-javascript-snippets.md)]
301+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
302+
303+
# [PHP](#tab/php)
304+
[!INCLUDE [sample-code](../includes/snippets/php/cloudpcreportsgetinaccessiblecloudpcreports-php-snippets.md)]
305+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
306+
307+
# [PowerShell](#tab/powershell)
308+
[!INCLUDE [sample-code](../includes/snippets/powershell/cloudpcreportsgetinaccessiblecloudpcreports-powershell-snippets.md)]
309+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
310+
311+
# [Python](#tab/python)
312+
[!INCLUDE [sample-code](../includes/snippets/python/cloudpcreportsgetinaccessiblecloudpcreports-python-snippets.md)]
313+
[!INCLUDE [sdk-documentation](../includes/snippets/snippets-sdk-documentation-link.md)]
314+
315+
---
316+
317+
#### Response
318+
319+
The following example shows the response.
320+
<!-- {
321+
"blockType": "response",
322+
"truncated": true,
323+
"@odata.type": "Edm.Stream"
324+
}
325+
-->
326+
``` http
327+
HTTP/1.1 200 OK
328+
Content-Type: application/octet-stream
329+
330+
HTTP/1.1 200 OK
331+
{
332+
"TotalRowCount": 2,
333+
"Schema": [
334+
{
335+
"Column": "HostRegionName",
336+
"PropertyType": "String"
337+
},
338+
{
339+
"Column": "CloudPcCount",
340+
"PropertyType": "Int"
341+
},
342+
{
343+
"Column": "WeeklyPeakInaccessibleCloudPcCount",
344+
"PropertyType": "Int"
345+
},
346+
{
347+
"Column": "Last24hPeakInaccessibleCloudPcCount",
348+
"PropertyType": "Int"
349+
},
350+
{
351+
"Column": "WeeklyInaccessibleTrend",
352+
"PropertyType": "String"
353+
}
354+
],
355+
"Values": [
356+
[ "Japan East", 46, 10, 5, "Increasing" ],
357+
[ "East US", 1, 0, 0, "Decreasing" ]
358+
]
359+
}
360+
```
361+

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`. 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`.|
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`, `regionalInaccessibleCloudPcTrendReport`. 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`, `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`. 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`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `crossRegionDisasterRecoveryReport`.|
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`, `regionalInaccessibleCloudPcTrendReport`. 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`, `rawRemoteConnectionReports`, `cloudPcUsageCategoryReports`, `crossRegionDisasterRecoveryReport`.|
3737
| requestDateTime | DateTimeOffset | The date and time when the export job was requested. |
3838
| select | String collection | The selected columns of the report. |
3939

@@ -72,6 +72,7 @@ Represents the export job for downloading a specified Cloud PC report.
7272
| regionalConnectionQualityInsightsReport | The regional connection quality insights reports of Cloud PCs. |
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. |
75+
| regionalInaccessibleCloudPcTrendReport | the weekly regional aggregated report of inaccessible Cloud PC trends |
7576
## Relationships
7677

7778
None.

changelog/Microsoft.CloudManagedDesktop.json

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
11
{
22
"changelog": [
3-
{
3+
{
4+
"ChangeList": [
5+
{
6+
"Id": "2e32a5b5-133e-45f4-9978-53c81843ca6d",
7+
"ApiChange": "Member",
8+
"ChangedApiName": "regionalInaccessibleCloudPcTrendReport",
9+
"ChangeType": "Addition",
10+
"Description": "Added the `regionalInaccessibleCloudPcTrendReport` member to the **cloudPCInaccessibleReportName** enumeration.",
11+
"Target": "cloudPCInaccessibleReportName"
12+
},
13+
{
14+
"Id": "2e32a5b5-133e-45f4-9978-53c81843ca6d",
15+
"ApiChange": "Member",
16+
"ChangedApiName": "regionalInaccessibleCloudPcTrendReport",
17+
"ChangeType": "Addition",
18+
"Description": "Added the `regionalInaccessibleCloudPcTrendReport` member to the **cloudPcReportName** enumeration.",
19+
"Target": "cloudPcReportName"
20+
}
21+
],
22+
"Id": "2e32a5b5-133e-45f4-9978-53c81843ca6d",
23+
"Cloud": "Prod",
24+
"Version": "beta",
25+
"CreatedDateTime": "2024-11-22T20:16:26.0746374Z",
26+
"WorkloadArea": "Devices and apps",
27+
"SubArea": "Cloud PC"
28+
},
29+
{
430
"ChangeList": [
531
{
632
"Id": "d2fbdff0-4da3-4e94-829b-fcee62ccbb58",

0 commit comments

Comments
 (0)