Skip to content

Commit 037feca

Browse files
LauragraLauragra
authored
Merge pull request #25270 from microsoftgraph/jiajyang/addBulkActionRety
[2409][CloudPC] Add retrieveBulkActionStatusReport API
2 parents d52c841 + 56f1250 commit 037feca

File tree

6 files changed

+254
-43
lines changed

6 files changed

+254
-43
lines changed

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

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
---
2+
title: "cloudPcReports: retrieveBulkActionStatusReport"
3+
description: "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."
4+
author: "AshleyYangSZ"
5+
ms.localizationpriority: medium
6+
ms.subservice: "cloud-pc"
7+
doc_type: apiPageType
8+
---
9+
10+
# cloudPcReports: retrieveBulkActionStatusReport
11+
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get the bulk remote action status report, including data such as the bulk action ID, bulk action display name, initiating user's principal name, action type, and action state.
17+
18+
[!INCLUDE [national-cloud-support](../../includes/global-only.md)]
19+
20+
## Permissions
21+
22+
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).
23+
24+
<!-- { "blockType": "permissions", "name": "cloudpcreports_retrieveBulkActionStatusReport" } -->
25+
[!INCLUDE [permissions-table](../includes/permissions/cloudpcreports-retrievebulkactionstatusreport-permissions.md)]
26+
27+
28+
## HTTP request
29+
30+
<!-- {
31+
"blockType": "ignored"
32+
}
33+
-->
34+
``` http
35+
POST /deviceManagement/virtualEndpoint/reports/retrieveBulkActionStatusReport
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 method.
50+
51+
| Parameter | Type | Description |
52+
|:----------|:------------------|:-------------------------------------------------------------------------------------------------------|
53+
| filter | String | OData `$filter` syntax. Supported filters are: `and`, `or`, `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 the order by columns name. The default **orderBy** column is `RequestDateTime`. |
56+
| search | String | Specifies a string to search for. |
57+
| select | String collection | OData `$select` syntax. The selected columns of the reports. |
58+
| skip | Int32 | Number of records to skip. |
59+
| top | Int32 | The number of top records to return. If not specified, the default limit is 25, with a maximum of 100. |
60+
61+
## Response
62+
63+
If successful, this method returns a `200 OK` response code and a stream object in the response body.
64+
65+
## Examples
66+
67+
### Request
68+
69+
The following example shows a request.
70+
71+
<!-- {
72+
"blockType": "request",
73+
"name": "cloudpcreports.retrieveBulkActionStatusReport"
74+
}
75+
-->
76+
``` http
77+
POST https://graph.microsoft.com/beta/deviceManagement/virtualEndpoint/reports/retrieveBulkActionStatusReport
78+
Content-Type: application/octet-stream
79+
80+
{
81+
"filter": "RequestDateTime ge datetime'2024-08-30'",
82+
"select": [
83+
"BulkActionId",
84+
"BulkActionDisplayName",
85+
"Action",
86+
"BulkActionStatus",
87+
"InitiatedByUserPrincipalName",
88+
"RequestDateTime",
89+
"SucceedCount",
90+
"FailedCount",
91+
"InprogressCount",
92+
"TotalCount",
93+
"Completion"
94+
],
95+
"skip": 0,
96+
"top": 50
97+
}
98+
```
99+
100+
### Response
101+
102+
The following example shows the response.
103+
104+
>**Note:** The response object shown here might be shortened for readability.
105+
106+
<!-- {
107+
"blockType": "response",
108+
"truncated": true,
109+
"@odata.type": "Edm.Stream"
110+
}
111+
-->
112+
``` http
113+
HTTP/1.1 200 OK
114+
Content-Type: application/octet-stream
115+
116+
{
117+
"TotalRowCount": 1,
118+
"Schema": [
119+
{
120+
"Column": "BulkActionId",
121+
"PropertyType": "String"
122+
},
123+
{
124+
"Column": "BulkActionDisplayName",
125+
"PropertyType": "String"
126+
},
127+
{
128+
"Column": "Action",
129+
"PropertyType": "String"
130+
},
131+
{
132+
"Column": "BulkActionStatus",
133+
"PropertyType": "String"
134+
},
135+
{
136+
"Column": "RequestDateTime",
137+
"PropertyType": "DateTime"
138+
},
139+
{
140+
"Column": "SucceedCount",
141+
"PropertyType": "Int64"
142+
},
143+
{
144+
"Column": "FailedCount",
145+
"PropertyType": "Int64"
146+
},
147+
{
148+
"Column": "InprogressCount",
149+
"PropertyType": "Int64"
150+
},
151+
{
152+
"Column": "TotalCount",
153+
"PropertyType": "Int64"
154+
}
155+
],
156+
"Values": [
157+
[
158+
"63792ef5-db62-437f-8d7e-7b3b695abb48",
159+
"BulkRestart on 2024-8-22 17:26:52 GMT+0800 (China Standard Time)",
160+
"Restart",
161+
"",
162+
"2024-08-22T09:26:54",
163+
1,
164+
0,
165+
0,
166+
1
167+
]
168+
]
169+
}
170+
```

‎api-reference/beta/includes/permissions/cloudpcreports-retrievebulkactionstatusreport-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: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Represents the export job for downloading a specified Cloud PC report.
3232
| filter | String | The filter applied on the report. |
3333
| format | String | The format of the exported report. |
3434
| id | String | The unique identifier for the report. Read-only. |
35-
| 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`. 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`.|
35+
| 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`.|
3636
| requestDateTime | DateTimeOffset | The date and time when the export job was requested. |
3737
| select | String collection | The selected columns of the report. |
3838

@@ -68,6 +68,7 @@ Represents the export job for downloading a specified Cloud PC report.
6868
| regionalConnectionQualityTrendReport | The regional connection quality trend reports of Cloud PCs. |
6969
| regionalConnectionQualityInsightsReport | The regional connection quality insights reports of Cloud PCs. |
7070
| remoteConnectionQualityReport | The overall connection quality reports for all devices under a tenant. |
71+
| bulkActionStatusReport | The details of Cloud PC bulk actions, including bulk action status, name, type, state, completion state, and request date time. |
7172
## Relationships
7273

7374
None.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Use a method in the [Methods](#methods) section to get the corresponding report
2121
|Method|Return type|Description|
2222
|:---|:---|:---|
2323
|[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.|
24+
|[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.|
2425
|[Get Cloud PC recommendation reports](../api/cloudpcreports-getcloudpcrecommendationreports.md)|Stream|Get the device recommendation reports for Cloud PCs, such as the usage category report.|
2526
|[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.|
2627
|[Get inaccessible Cloud PC reports](../api/cloudpcreports-getinaccessiblecloudpcreports.md)|Stream|Get inaccessible Cloud PCs with details, including the latest health state, failed connection count, failed health check count, and system status.|

‎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: Retrieve bulk action status reports
280+
href: ../../api/cloudpcreports-retrievebulkactionstatusreport.md
279281
- name: Get Cloud PC recommendation reports
280282
href: ../../api/cloudpcreports-getcloudpcrecommendationreports.md
281283
- name: Get frontline report

‎changelog/Microsoft.CloudManagedDesktop.json

Lines changed: 68 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,31 @@
11
{
22
"changelog": [
3+
{
4+
"ChangeList": [
5+
{
6+
"Id": "88f029ef-58a7-4c7c-8b43-b7dfd5ef13e0",
7+
"ApiChange": "Member",
8+
"ChangedApiName": "bulkActionStatusReport",
9+
"ChangeType": "Addition",
10+
"Description": "Added the **bulkActionStatusReport** member to the **cloudPcReportName** enumeration.",
11+
"Target": "cloudPcReportName"
12+
},
13+
{
14+
"Id": "88f029ef-58a7-4c7c-8b43-b7dfd5ef13e0",
15+
"ApiChange": "Method",
16+
"ChangedApiName": "retrieveBulkActionStatusReport",
17+
"ChangeType": "Addition",
18+
"Description": "Added the `retrieveBulkActionStatusReport` method to the [cloudPcReports](https://learn.microsoft.com/en-us/graph/api/resources/cloudpcreports?view=graph-rest-beta) resource.",
19+
"Target": "cloudPcReports"
20+
}
21+
],
22+
"Id": "88f029ef-58a7-4c7c-8b43-b7dfd5ef13e0",
23+
"Cloud": "Prod",
24+
"Version": "beta",
25+
"CreatedDateTime": "2024-10-21T10:25:21.3434973Z",
26+
"WorkloadArea": "Device and app management",
27+
"SubArea": "Cloud PC"
28+
},
329
{
430
"ChangeList": [
531
{
@@ -436,7 +462,7 @@
436462
},
437463
{
438464
"ChangeList": [
439-
{
465+
{
440466
"Id": "ea968c7d-abd9-22b5-d562-6ac4ccf3c43a",
441467
"ApiChange": "Resource",
442468
"ChangedApiName": "cloudPcBulkDisasterRecoveryFailback",
@@ -590,46 +616,46 @@
590616
},
591617
{
592618
"ChangeList": [
593-
{
594-
"Id": "9cbdf346-f050-4ca6-bb06-64ceb8146547",
595-
"ApiChange": "Property",
596-
"ChangedApiName": "crossRegionDisasterRecoverySetting",
597-
"ChangeType": "Addition",
598-
"Description": "Added the **crossRegionDisasterRecoverySetting** property to the [cloudPcUserSetting](https://learn.microsoft.com/en-us/graph/api/resources/cloudpcusersetting?view=graph-rest-beta) resource.",
599-
"Target": "cloudPcUserSetting"
600-
},
601-
{
602-
"Id": "9cbdf346-f050-4ca6-bb06-64ceb8146547",
603-
"ApiChange": "Resource",
604-
"ChangedApiName": "cloudPcCrossRegionDisasterRecoverySetting",
605-
"ChangeType": "Addition",
606-
"Description": "Added the [cloudPcCrossRegionDisasterRecoverySetting](https://learn.microsoft.com/en-us/graph/api/resources/cloudPcCrossRegionDisasterRecoverySetting?view=graph-rest-beta) resource type.",
607-
"Target": "cloudPcCrossRegionDisasterRecoverySetting"
608-
},
609-
{
610-
"Id": "9cbdf346-f050-4ca6-bb06-64ceb8146547",
611-
"ApiChange": "Resource",
612-
"ChangedApiName": "cloudPcDisasterRecoveryAzureConnectionSetting",
613-
"ChangeType": "Addition",
614-
"Description": "Added the [cloudPcDisasterRecoveryAzureConnectionSetting](https://learn.microsoft.com/en-us/graph/api/resources/cloudPcDisasterRecoveryAzureConnectionSetting?view=graph-rest-beta) resource type.",
615-
"Target": "cloudPcDisasterRecoveryAzureConnectionSetting"
616-
},
617-
{
618-
"Id": "9cbdf346-f050-4ca6-bb06-64ceb8146547",
619-
"ApiChange": "Resource",
620-
"ChangedApiName": "cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting",
621-
"ChangeType": "Addition",
622-
"Description": "Added the [cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting](https://learn.microsoft.com/en-us/graph/api/resources/cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting?view=graph-rest-beta) resource type.",
623-
"Target": "cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting"
624-
},
625-
{
626-
"Id": "9cbdf346-f050-4ca6-bb06-64ceb8146547",
627-
"ApiChange": "Resource",
628-
"ChangedApiName": "cloudPcDisasterRecoveryNetworkSetting",
629-
"ChangeType": "Addition",
630-
"Description": "Added the [cloudPcDisasterRecoveryNetworkSetting](https://learn.microsoft.com/en-us/graph/api/resources/cloudPcDisasterRecoveryNetworkSetting?view=graph-rest-beta) resource type.",
631-
"Target": "cloudPcDisasterRecoveryNetworkSetting"
632-
}
619+
{
620+
"Id": "9cbdf346-f050-4ca6-bb06-64ceb8146547",
621+
"ApiChange": "Property",
622+
"ChangedApiName": "crossRegionDisasterRecoverySetting",
623+
"ChangeType": "Addition",
624+
"Description": "Added the **crossRegionDisasterRecoverySetting** property to the [cloudPcUserSetting](https://learn.microsoft.com/en-us/graph/api/resources/cloudpcusersetting?view=graph-rest-beta) resource.",
625+
"Target": "cloudPcUserSetting"
626+
},
627+
{
628+
"Id": "9cbdf346-f050-4ca6-bb06-64ceb8146547",
629+
"ApiChange": "Resource",
630+
"ChangedApiName": "cloudPcCrossRegionDisasterRecoverySetting",
631+
"ChangeType": "Addition",
632+
"Description": "Added the [cloudPcCrossRegionDisasterRecoverySetting](https://learn.microsoft.com/en-us/graph/api/resources/cloudPcCrossRegionDisasterRecoverySetting?view=graph-rest-beta) resource type.",
633+
"Target": "cloudPcCrossRegionDisasterRecoverySetting"
634+
},
635+
{
636+
"Id": "9cbdf346-f050-4ca6-bb06-64ceb8146547",
637+
"ApiChange": "Resource",
638+
"ChangedApiName": "cloudPcDisasterRecoveryAzureConnectionSetting",
639+
"ChangeType": "Addition",
640+
"Description": "Added the [cloudPcDisasterRecoveryAzureConnectionSetting](https://learn.microsoft.com/en-us/graph/api/resources/cloudPcDisasterRecoveryAzureConnectionSetting?view=graph-rest-beta) resource type.",
641+
"Target": "cloudPcDisasterRecoveryAzureConnectionSetting"
642+
},
643+
{
644+
"Id": "9cbdf346-f050-4ca6-bb06-64ceb8146547",
645+
"ApiChange": "Resource",
646+
"ChangedApiName": "cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting",
647+
"ChangeType": "Addition",
648+
"Description": "Added the [cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting](https://learn.microsoft.com/en-us/graph/api/resources/cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting?view=graph-rest-beta) resource type.",
649+
"Target": "cloudPcDisasterRecoveryMicrosoftHostedNetworkSetting"
650+
},
651+
{
652+
"Id": "9cbdf346-f050-4ca6-bb06-64ceb8146547",
653+
"ApiChange": "Resource",
654+
"ChangedApiName": "cloudPcDisasterRecoveryNetworkSetting",
655+
"ChangeType": "Addition",
656+
"Description": "Added the [cloudPcDisasterRecoveryNetworkSetting](https://learn.microsoft.com/en-us/graph/api/resources/cloudPcDisasterRecoveryNetworkSetting?view=graph-rest-beta) resource type.",
657+
"Target": "cloudPcDisasterRecoveryNetworkSetting"
658+
}
633659
],
634660
"Id": "9cbdf346-f050-4ca6-bb06-64ceb8146547",
635661
"Cloud": "Prod",
@@ -5874,7 +5900,7 @@
58745900
},
58755901
{
58765902
"ChangeList": [
5877-
{
5903+
{
58785904
"Id": "42d14f15-8f2c-46b6-9486-10291763aba0",
58795905
"ApiChange": "Member",
58805906
"ChangedApiName": "noLicensesAvailable",

0 commit comments

Comments
 (0)