Skip to content

Commit b054e2c

Browse files
authored
Merge pull request MicrosoftDocs#6183 from MicrosoftDocs/ReportingUpdates-chrisda
ReportingUpdates-chrisda to Master
2 parents 98f1027 + 4094440 commit b054e2c

File tree

6 files changed

+93
-37
lines changed

6 files changed

+93
-37
lines changed

exchange/exchange-ps/exchange/Get-DlpDetectionsReport.md

Lines changed: 7 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -35,22 +35,13 @@ Get-DlpDetectionsReport [-Action <MultiValuedProperty>] [-AggregateBy <String>]
3535
The Get-DlpDetectionsReport cmdlet returns general DLP detection data that's aggregated per day. The properties returned include:
3636

3737
- Date
38-
39-
- DlpPolicy
40-
41-
- TransportRule
42-
43-
- Action
44-
45-
- EventType
46-
47-
- MessageCount
48-
38+
- DLP Policy
39+
- DLP Compliance Rule
40+
- Event Type
4941
- Source
42+
- Message Count
5043

51-
- StartDate
52-
53-
- EndDate
44+
To see all of these columns (width issues), write the output to a file. For example, `Get-DlpDetectionsReport | Out-String -Width 4096 | Out-File "C:\Users\admin\Desktop\DLP Detections Report.txt"`.
5445

5546
To see detailed information about each DLP rule match, use the Get-DlpDetailReport cmdlet.
5647

@@ -282,17 +273,13 @@ Accept wildcard characters: False
282273
### -SummarizeBy
283274
The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report.
284275
285-
For the Get-DLPDetectionsReport cmdlet, the SummarizeBy parameter accepts the following values:
286-
287-
- Action
276+
Valid values are:
288277
289278
- DLPPolicy
290-
291279
- Domain
292-
293280
- EventType
294281
295-
You can specify multiple values separated by commas.
282+
You can specify multiple values separated by commas. The values that you specify for this parameter are not displayed in the results (the values in the corresponding columns are blank).
296283
297284
```yaml
298285
Type: MultiValuedProperty

exchange/exchange-ps/exchange/Get-MailTrafficATPReport.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,20 @@ For information about the parameter sets in the Syntax section below, see [Excha
2424
## SYNTAX
2525

2626
```
27-
Get-MailTrafficATPReport [-Action <MultiValuedProperty>] [-AggregateBy <String>]
28-
[-Direction <MultiValuedProperty>] [-Domain <MultiValuedProperty>] [-EndDate <DateTime>]
29-
[-EventType <MultiValuedProperty>] [-Expression <Expression>] [-Page <Int32>] [-PageSize <Int32>]
30-
[-ProbeTag <String>] [-StartDate <DateTime>] [-SummarizeBy <MultiValuedProperty>] [<CommonParameters>]
27+
Get-MailTrafficATPReport
28+
[-Action <MultiValuedProperty>]
29+
[-AggregateBy <String>]
30+
[-Direction <MultiValuedProperty>]
31+
[-Domain <MultiValuedProperty>]
32+
[-EndDate <DateTime>]
33+
[-EventType <MultiValuedProperty>]
34+
[-Expression <Expression>]
35+
[-Page <Int32>]
36+
[-PageSize <Int32>]
37+
[-ProbeTag <String>]
38+
[-StartDate <DateTime>]
39+
[-SummarizeBy <MultiValuedProperty>]
40+
[<CommonParameters>]
3141
```
3242

3343
## DESCRIPTION
@@ -38,17 +48,18 @@ Safe Links is a feature in Advanced Threat Protection that checks links in email
3848
For the reporting period you specify, the cmdlet returns the following information:
3949

4050
- Domain
41-
4251
- Date
43-
4452
- Event Type
45-
4653
- Direction
47-
4854
- Action
49-
55+
- SubType
56+
- Policy Source
57+
- Verdict Source
58+
- Delivery Status
5059
- Message Count
5160

61+
To see all of these columns (width issues), write the output to a file. For example, `Get-MailTrafficATPReport | Out-String -Width 4096 | Out-File "C:\Users\admin\Desktop\Mail Traffic ATP Report.txt"`.
62+
5263
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
5364

5465
## EXAMPLES
@@ -307,7 +318,14 @@ Accept wildcard characters: False
307318
### -SummarizeBy
308319
The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report.
309320
310-
For the Get-MailTrafficATPReport cmdlet, valid values are Action, Direction, Domain, and EventType. You can specify multiple values separated by commas.
321+
Valid values are:
322+
323+
- Action
324+
- Direction
325+
- Domain
326+
- EventType
327+
328+
You can specify multiple values separated by commas. When you specify the values Action or Domain, the value is not displayed in the results (the values in the corresponding columns are blank).
311329
312330
```yaml
313331
Type: MultiValuedProperty

exchange/exchange-ps/exchange/Get-MailTrafficPolicyReport.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,16 @@ Get-MailTrafficPolicyReport [-Action <MultiValuedProperty>] [-AggregateBy <Strin
3232
```
3333

3434
## DESCRIPTION
35+
For the reporting period you specify, the cmdlet returns the following information:
36+
37+
- Domain
38+
- Date
39+
- DLP Policy
40+
- Transport Rule
41+
- Event Type
42+
- Direction
43+
- Message Count
44+
3545
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
3646

3747
## EXAMPLES
@@ -262,7 +272,16 @@ Accept wildcard characters: False
262272
### -SummarizeBy
263273
The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report.
264274
265-
For the Get-MailTrafficPolicyReport cmdlet, the SummarizeBy parameter accepts the values Action, DLPPolicy, Domain, EventType, and TransportRule. You can specify multiple values separated by commas.
275+
Valid values are:
276+
277+
- Action
278+
- Direction
279+
- DLPPolicy
280+
- Domain
281+
- EventType
282+
- TransportRule
283+
284+
You can specify multiple values separated by commas. When you specify the values DLPPolicy, Domain, EventType, or TransportRule the value is not displayed in the results (the values in the corresponding columns are blank).
266285
267286
```yaml
268287
Type: MultiValuedProperty

exchange/exchange-ps/exchange/Get-MailTrafficReport.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,17 @@ Get-MailTrafficReport
4141
```
4242

4343
## DESCRIPTION
44-
You can use the EventTypes values from the Get-MailTrafficReport cmdlet to analyze what happened to messages when they were filtered by the service. The following list describes the event types for messages.
44+
For the reporting period you specify, the cmdlet returns the following information:
45+
46+
- Domain (note that this value is populated only when you use the Domain parameter)
47+
- Date
48+
- Event Type
49+
- Direction
50+
- Action
51+
- Message Count
52+
- Recipient Count
53+
54+
You can use the EventType values from the Get-MailTrafficReport cmdlet to analyze what happened to messages when they were filtered by the service. The following list describes the event types for messages.
4555

4656
Mail traffic summary
4757

@@ -63,7 +73,7 @@ Mail traffic summary
6373

6474
- TransportRuleHits: Messages that matched a transport rule. If a message matched multiple rules, this event type would show each of the rule matches.
6575

66-
- TransportRuleMessages: Messages that matched a transport rule. If a message matched multiple rules, this event type would show each of the rule matches.
76+
- TransportRuleMessages: Messages that matched a transport rule. If a message matched multiple rules, this event type would show each of the rule matches.
6777

6878
Spam detections
6979

@@ -139,7 +149,7 @@ This example retrieves the statistics for outgoing messages on December 12, 2015
139149

140150
### Example 3
141151
```powershell
142-
Get-MailTrafficReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound -SummarizeBy Domain,EventType | Format-Table Domain,Date,EventType,Action,MessageCount
152+
Get-MailTrafficReport -StartDate 12/12/2015 -EndDate 12/12/2015 -Direction Outbound -SummarizeBy EventType | Format-Table Domain,Date,Action,MessageCount
143153
```
144154

145155
This example is similar to the previous example, but now the results are summarized. Because the EventType is one of the summarized values, the rows in the table now contain the unique values of Action. The total number of rows in the report is reduced, and values of MessageCount are correspondingly larger on each row.
@@ -341,7 +351,13 @@ Accept wildcard characters: False
341351
### -SummarizeBy
342352
The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report, and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report.
343353
344-
For the Get-MailTrafficReport cmdlet, the SummarizeBy parameter accepts the values Action, Domain, and EventType. You can specify multiple values separated by commas.
354+
Valid values are:
355+
356+
- Action
357+
- Domain
358+
- EventType
359+
360+
You can specify multiple values separated by commas. The values that you specify for this parameter are not displayed in the results (the values in the corresponding columns are blank).
345361
346362
```yaml
347363
Type: MultiValuedProperty

exchange/exchange-ps/exchange/Get-MailTrafficTopReport.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,17 @@ Get-MailTrafficTopReport [-Action <MultiValuedProperty>] [-AggregateBy <String>]
3131
```
3232

3333
## DESCRIPTION
34+
For the reporting period you specify, the cmdlet returns the following information:
35+
36+
- Domain
37+
- Date
38+
- Name
39+
- Event Type
40+
- Direction
41+
- Count
42+
43+
To see all of these columns (width issues), write the output to a file. For example, `Get-MailTrafficTopReport | Out-String -Width 4096 | Out-File "C:\Users\admin\Desktop\Mail Traffic Top Report.txt"`.
44+
3445
You need to be assigned permissions before you can run this cmdlet. Although this topic lists all parameters for the cmdlet, you may not have access to some parameters if they're not included in the permissions assigned to you. To find the permissions required to run any cmdlet or parameter in your organization, see [Find the permissions required to run any Exchange cmdlet](https://docs.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
3546

3647
## EXAMPLES
@@ -231,7 +242,12 @@ Accept wildcard characters: False
231242
### -SummarizeBy
232243
The SummarizeBy parameter returns totals based on the values you specify. If your report filters data using any of the values accepted by this parameter, you can use the SummarizeBy parameter to summarize the results based on those values. To decrease the number of rows returned in the report, consider using the SummarizeBy parameter. Summarizing reduces the amount of data that's retrieved for the report and delivers the report faster. For example, instead of seeing each instance of a specific value of EventType on an individual row in the report, you can use the SummarizeBy parameter to see the total number of instances of that value of EventType on one row in the report.
233244
234-
For the Get-MailTopTrafficReport cmdlet, the SummarizeBy parameter accepts the values Domain and EventType. You can specify multiple values separated by commas.
245+
Valid values are:
246+
247+
- Domain
248+
- EventType
249+
250+
You can specify multiple values separated by commas. The values that you specify for this parameter are not displayed in the results (the values in the corresponding columns are blank).
235251
236252
```yaml
237253
Type: MultiValuedProperty

exchange/exchange-ps/exchange/Get-SafeLinksAggregateReport.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Get-SafeLinksAggregateReport
3636
## DESCRIPTION
3737
Safe Links is a feature in Advanced Threat Protection that checks links in email messages to see if they lead to malicious web sites. When a user clicks a link in a message, the URL is temporarily rewritten and checked against a list of known, malicious web sites.
3838

39-
This cmdlet returns the following information:
39+
For the reporting period you specify, the cmdlet returns the following information:
4040

4141
- Action
4242
- App

0 commit comments

Comments
 (0)