Skip to content

Commit ee8df17

Browse files
LauragraLauragra
authored
Merge branch 'main' into JarbasHorst-patch-9
2 parents 88afd36 + 137e167 commit ee8df17

File tree

63 files changed

+3197
-207
lines changed

Some content is hidden

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

63 files changed

+3197
-207
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/api/security-ediscoverysearch-purgedata.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ Namespace: microsoft.graph.security
1515

1616
Delete Exchange mailbox items or Microsoft Teams messages contained in an [eDiscovery search](../resources/security-ediscoverysearch.md).
1717

18-
>**Note:** This request purges a maximum of 100 items per location only.
19-
2018
You can collect and purge the following categories of Teams content:
2119
- **Teams 1:1 chats** - Chat messages, posts, and attachments shared in a Teams conversation between two people. Teams 1:1 chats are also called *conversations*.
2220
- **Teams group chats** - Chat messages, posts, and attachments shared in a Teams conversation between three or more people. Also called *1:N* chats or *group conversations*.
2321
- **Teams channels** - Chat messages, posts, replies, and attachments shared in a standard Teams channel.
2422
- **Private channels** - Message posts, replies, and attachments shared in a private Teams channel.
2523
- **Shared channels** - Message posts, replies, and attachments shared in a shared Teams channel.
2624

25+
>**Note:** This request purges a maximum of 100 items per location only. When **purgeType** is set to either `recoverable` or `permanentlyDelete` and **purgeAreas** is set to `teamsMessages`, the Teams messages are permanently deleted.
26+
2727
For more information about purging Teams messages, see:
2828
- [eDiscovery solution series: Data spillage scenario - Search and purge](/microsoft-365/compliance/data-spillage-scenariosearch-and-purge)
2929
- [eDiscovery (Premium) workflow for content in Microsoft Teams](/microsoft-365/compliance/teams-workflow-in-advanced-ediscovery)

‎api-reference/beta/api/serviceactivity-getactiveusermetricsfordesktopmailbyreademail.md

Lines changed: 98 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
---
2+
title: "serviceActivity: getActiveUserMetricsForDesktopMailByReadEmail"
3+
description: "Get all the active usage based on the number of users who successfully read emails using desktop mail apps."
4+
author: "mkuninty"
5+
ms.localizationpriority: medium
6+
ms.subservice: "m365-monitoring-service"
7+
doc_type: apiPageType
8+
ms.date: 12/02/2024
9+
---
10+
11+
# serviceActivity: getActiveUserMetricsForDesktopMailByReadEmail
12+
Namespace: microsoft.graph
13+
14+
[!INCLUDE [beta-disclaimer](../../includes/beta-disclaimer.md)]
15+
16+
Get all the active usage based on the number of users who successfully read emails using desktop mail apps.
17+
18+
## Permissions
19+
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).
20+
21+
|Permission type|Least privileged permissions|Higher privileged permissions|
22+
|:---|:---|:---|
23+
|Delegated (work or school account)|ServiceActivity-Exchange.Read.All|Not available.|
24+
|Delegated (personal Microsoft account)|Not supported.|Not supported.|
25+
|Application|ServiceActivity-Exchange.Read.All|Not available.|
26+
27+
## HTTP request
28+
29+
<!-- {
30+
"blockType": "ignored"
31+
}
32+
-->
33+
``` http
34+
GET /reports/serviceActivity/getActiveUserMetricsForDesktopMailByReadEmail
35+
```
36+
37+
## Function parameters
38+
In the request URL, provide the following query parameters with values.
39+
40+
|Parameter|Type|Description|
41+
|:---|:---|:---|
42+
|aggregationIntervalInMinutes|Int32|Aggregation interval in minutes. The default value is `15`, which sets the data to be aggregated into 15-minute sets. Allowed values are `5`, `10`, `15`, and `30`. Optional.|
43+
|exclusiveIntervalEndDateTime|DateTimeOffset|The ending date and time in UTC. Required.|
44+
|inclusiveIntervalStartDateTime|DateTimeOffset|The starting date and time in UTC. The earliest start time allowed is 30 days in the past. Required.|
45+
46+
## Request headers
47+
|Name|Description|
48+
|:---|:---|
49+
|Authorization|Bearer {token}. Required. Learn more about [authentication and authorization](/graph/auth/auth-concepts).|
50+
51+
## Request body
52+
Don't supply a request body for this method.
53+
54+
## Response
55+
56+
If successful, this function returns a `200 OK` response code and a [serviceActivityValueMetric](../resources/serviceactivityvaluemetric.md) collection in the response body.
57+
58+
## Examples
59+
60+
### Request
61+
The following example shows a request.
62+
63+
<!-- {
64+
"blockType": "request",
65+
"name": "serviceactivitythis.getactiveusermetricsfordesktopmailbyreademail"
66+
}
67+
-->
68+
``` http
69+
GET https://graph.microsoft.com/beta/reports/serviceActivity/getActiveUserMetricsForDesktopMailByReadEmail(inclusiveIntervalStartDateTime=2024-10-02T10:30:00Z,exclusiveIntervalEndDateTime=2024-10-02T10:59:59Z,aggregationIntervalInMinutes=10)
70+
```
71+
72+
### Response
73+
The following example shows the response.
74+
>**Note:** The response object shown here might be shortened for readability.
75+
<!-- {
76+
"blockType": "response",
77+
"truncated": true,
78+
"@odata.type": "Collection(microsoft.graph.serviceActivityValueMetric)"
79+
}
80+
-->
81+
``` http
82+
HTTP/1.1 200 OK
83+
Content-Type: application/json
84+
85+
{
86+
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(microsoft.graph.serviceActivityValueMetric)",
87+
"value": [
88+
{
89+
"intervalStartDateTime": "2024-10-02T10:30:00Z",
90+
"value": 6880
91+
},
92+
{
93+
"intervalStartDateTime": "2024-10-02T10:40:00Z",
94+
"value": 6480
95+
}
96+
]
97+
}
98+
```

0 commit comments

Comments
 (0)