Skip to content

Commit cec459c

Browse files
chrisdachrisda
authored
Merge pull request #11125 from MicrosoftDocs/ZApReport-chrisda
ZAP report cmdlets
2 parents 95109d7 + c629ffd commit cec459c

File tree

5 files changed

+299
-2
lines changed

5 files changed

+299
-2
lines changed

‎exchange/exchange-ps/exchange/Get-AggregateZapReport.md

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
---
2+
external help file: Microsoft.Exchange.ServerStatus-Help.xml
3+
online version: https://learn.microsoft.com/powershell/module/exchange/get-aggregatezapreport
4+
applicable: Exchange Online
5+
title: Get-AggregateZapReport
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Get-AggregateZapReport
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the Get-AggregateZapReport cmdlet to view aggregate information about zero-hour auto purge (ZAP) activity. By default, the cmdlet shows the last three days of activity, but you can specify up to ten days.
18+
19+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
20+
21+
## SYNTAX
22+
23+
```
24+
Get-AggregateZapReport
25+
[[-EndDate] <System.DateTime>]
26+
[[-Page] <Int32>]
27+
[[-PageSize] <Int32>]
28+
[[-StartDate] <System.DateTime>]
29+
[<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
For the reporting period you specify, the cmdlet returns the following information:
34+
35+
- Date
36+
- EventType
37+
- ZapActionCount
38+
39+
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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
40+
41+
## EXAMPLES
42+
43+
### Example 1
44+
```powershell
45+
Get-AggregateZapReport
46+
```
47+
48+
This example retrieves information for the last 3 days.
49+
50+
### Example 2
51+
```powershell
52+
Get-AggregateZapReport -StartDate 7/1/2023 -EndDate 7/9/2023
53+
```
54+
55+
This example retrieves information for the specified date range.
56+
57+
## PARAMETERS
58+
59+
### -EndDate
60+
The EndDate parameter specifies the end date of the date range.
61+
62+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018".
63+
64+
If you use the EndDate parameter, you also need to use the StartDate parameter.
65+
66+
```yaml
67+
Type: System.DateTime
68+
Parameter Sets: (All)
69+
Aliases:
70+
Applicable: Exchange Online
71+
72+
Required: False
73+
Position: 1
74+
Default value: None
75+
Accept pipeline input: True (ByPropertyName)
76+
Accept wildcard characters: False
77+
```
78+
79+
### -Page
80+
The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1.
81+
82+
```yaml
83+
Type: Int32
84+
Parameter Sets: (All)
85+
Aliases:
86+
Applicable: Exchange Online
87+
88+
Required: False
89+
Position: 2
90+
Default value: 0
91+
Accept pipeline input: False
92+
Accept wildcard characters: False
93+
```
94+
95+
### -PageSize
96+
The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000.
97+
98+
```yaml
99+
Type: Int32
100+
Parameter Sets: (All)
101+
Aliases:
102+
Applicable: Exchange Online
103+
104+
Required: False
105+
Position: 3
106+
Default value: 0
107+
Accept pipeline input: False
108+
Accept wildcard characters: False
109+
```
110+
111+
### -StartDate
112+
The StartDate parameter specifies the start date of the date range.
113+
114+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018".
115+
116+
If you use this parameter, you also need to use the StartDate parameter.
117+
118+
```yaml
119+
Type: System.DateTime
120+
Parameter Sets: (All)
121+
Aliases:
122+
Applicable: Exchange Online
123+
124+
Required: False
125+
Position: 4
126+
Default value: None
127+
Accept pipeline input: True (ByPropertyName)
128+
Accept wildcard characters: False
129+
```
130+
131+
### CommonParameters
132+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
133+
134+
## INPUTS
135+
136+
## OUTPUTS
137+
138+
## NOTES
139+
140+
## RELATED LINKS

‎exchange/exchange-ps/exchange/Get-DetailZapReport.md

Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
---
2+
external help file: Microsoft.Exchange.ServerStatus-Help.xml
3+
online version: https://learn.microsoft.com/powershell/module/exchange/get-detailzapreport
4+
applicable: Exchange Online
5+
title: Get-DetailZapReport
6+
schema: 2.0.0
7+
author: chrisda
8+
ms.author: chrisda
9+
ms.reviewer:
10+
---
11+
12+
# Get-DetailZapReport
13+
14+
## SYNOPSIS
15+
This cmdlet is available only in the cloud-based service.
16+
17+
Use the Get-DetailZapReport cmdlet to view details about zero-hour auto purge (ZAP) activity. By default, the cmdlet shows the last three days of activity, but you can specify up to ten days.
18+
19+
For information about the parameter sets in the Syntax section below, see [Exchange cmdlet syntax](https://learn.microsoft.com/powershell/exchange/exchange-cmdlet-syntax).
20+
21+
## SYNTAX
22+
23+
```
24+
Get-DetailZapReport
25+
[[-EndDate] <System.DateTime>]
26+
[[-Page] <Int32>]
27+
[[-PageSize] <Int32>]
28+
[[-StartDate] <System.DateTime>]
29+
[<CommonParameters>]
30+
```
31+
32+
## DESCRIPTION
33+
For the reporting period you specify, the cmdlet returns the following default information:
34+
35+
- Subject
36+
- Received Time
37+
- Sender
38+
39+
If you append the command with ` | Format-List`, the following additional information is returned for each entry:
40+
41+
- Recipient
42+
- ZAP Time
43+
- Original Threat
44+
- Original Location
45+
- Updated Threat
46+
- Updated Delivery Location
47+
- Delivery Status
48+
- Detection Technology
49+
50+
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://learn.microsoft.com/powershell/exchange/find-exchange-cmdlet-permissions).
51+
52+
## EXAMPLES
53+
54+
### Example 1
55+
```powershell
56+
Get-DetailZapReport
57+
```
58+
59+
This example retrieves information for the last 3 days.
60+
61+
### Example 2
62+
```powershell
63+
Get-DetailZapReport -StartDate 7/1/2023 -EndDate 7/9/2023
64+
```
65+
66+
This example retrieves information for the specified date range.
67+
68+
## PARAMETERS
69+
70+
### -EndDate
71+
The EndDate parameter specifies the end date of the date range.
72+
73+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only. If you enter the date, enclose the value in quotation marks ("), for example, "09/01/2018".
74+
75+
If you use this parameter, you also need to use the StartDate parameter.
76+
77+
```yaml
78+
Type: System.DateTime
79+
Parameter Sets: (All)
80+
Aliases:
81+
Applicable: Exchange Online
82+
83+
Required: False
84+
Position: 1
85+
Default value: None
86+
Accept pipeline input: True (ByPropertyName)
87+
Accept wildcard characters: False
88+
```
89+
90+
### -Page
91+
The Page parameter specifies the page number of the results you want to view. Valid input for this parameter is an integer between 1 and 1000. The default value is 1.
92+
93+
```yaml
94+
Type: Int32
95+
Parameter Sets: (All)
96+
Aliases:
97+
Applicable: Exchange Online
98+
99+
Required: False
100+
Position: 2
101+
Default value: 0
102+
Accept pipeline input: False
103+
Accept wildcard characters: False
104+
```
105+
106+
### -PageSize
107+
The PageSize parameter specifies the maximum number of entries per page. Valid input for this parameter is an integer between 1 and 5000. The default value is 1000.
108+
109+
```yaml
110+
Type: Int32
111+
Parameter Sets: (All)
112+
Aliases:
113+
Applicable: Exchange Online
114+
115+
Required: False
116+
Position: 3
117+
Default value: 0
118+
Accept pipeline input: False
119+
Accept wildcard characters: False
120+
```
121+
122+
### -StartDate
123+
The StartDate parameter specifies the start date of the date range.
124+
125+
Use the short date format that's defined in the Regional Options settings on the computer where you're running the command. For example, if the computer is configured to use the short date format mm/dd/yyyy, enter 09/01/2018 to specify September 1, 2018. You can enter the date only, or you can enter the date and time of day. If you enter the date and time of day, enclose the value in quotation marks ("), for example, "09/01/2018".
126+
127+
If you use this parameter, you also need to use the StartDate parameter.
128+
129+
```yaml
130+
Type: System.DateTime
131+
Parameter Sets: (All)
132+
Aliases:
133+
Applicable: Exchange Online
134+
135+
Required: False
136+
Position: 4
137+
Default value: None
138+
Accept pipeline input: True (ByPropertyName)
139+
Accept wildcard characters: False
140+
```
141+
142+
### CommonParameters
143+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/p/?LinkID=113216).
144+
145+
## INPUTS
146+
147+
## OUTPUTS
148+
149+
## NOTES
150+
151+
## RELATED LINKS

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ To specify a date/time value for this parameter, use either of the following opt
151151
- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z".
152152
- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date).
153153

154-
If you use the EndDate parameter, you must also use the StartDate parameter.
154+
If you use this parameter, you also need to use the StartDate parameter.
155155

156156
```yaml
157157
Type: DateTime
@@ -295,7 +295,7 @@ To specify a date/time value for this parameter, use either of the following opt
295295
- Specify the date/time value in UTC: For example, "2021-05-06 14:30:00z".
296296
- Specify the date/time value as a formula that converts the date/time in your local time zone to UTC: For example, `(Get-Date "5/6/2021 9:30 AM").ToUniversalTime()`. For more information, see [Get-Date](https://learn.microsoft.com/powershell/module/Microsoft.PowerShell.Utility/Get-Date).
297297

298-
If you use the StartDate parameter, you must also use the EndDate parameter.
298+
If you use this parameter, you also need to use the EndDate parameter.
299299

300300
```yaml
301301
Type: DateTime

‎exchange/exchange-ps/exchange/exchange.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -202,6 +202,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow
202202

203203
### [Get-AgentLog](Get-AgentLog.md)
204204

205+
### [Get-AggregateZapReport](Get-AggregateZapReport.md)
206+
205207
### [Get-AttachmentFilterEntry](Get-AttachmentFilterEntry.md)
206208

207209
### [Get-AttachmentFilterListConfig](Get-AttachmentFilterListConfig.md)
@@ -216,6 +218,8 @@ Exchange PowerShell is built on Windows PowerShell technology and provides a pow
216218

217219
### [Get-ContentFilterPhrase](Get-ContentFilterPhrase.md)
218220

221+
### [Get-DetailZapReport](Get-DetailZapReport.md)
222+
219223
### [Get-DkimSigningConfig](Get-DkimSigningConfig.md)
220224

221225
### [Get-EOPProtectionPolicyRule](Get-EOPProtectionPolicyRule.md)

‎exchange/mapping/serviceMapping.json

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@
8888
"Export-QuarantineMessage": "antispam-antimalware",
8989
"Enable-ReportSubmissionRule": "antispam-antimalware",
9090
"Get-AgentLog": "antispam-antimalware",
91+
"Get-AggregateZapReport": "antispam-antimalware",
9192
"Get-AttachmentFilterEntry": "antispam-antimalware",
9293
"Get-AttachmentFilterListConfig": "antispam-antimalware",
9394
"Get-BlockedConnector": "antispam-antimalware",
@@ -96,6 +97,7 @@
9697
"Get-ContentFilterConfig": "antispam-antimalware",
9798
"Get-ContentFilterPhrase": "antispam-antimalware",
9899
"Get-CustomizedUserSubmission": "antispam-antimalware",
100+
"Get-DetailZapReport": "antispam-antimalware",
99101
"Get-DkimSigningConfig": "antispam-antimalware",
100102
"Get-EOPProtectionPolicyRule": "antispam-antimalware",
101103
"Get-HostedConnectionFilterPolicy": "antispam-antimalware",

0 commit comments

Comments
 (0)