Skip to content

Commit 5e56e0d

Browse files
committed
Merge branch 'main' into Grace-chrisda
2 parents 4cc546e + d504cda commit 5e56e0d

File tree

2 files changed

+71
-77
lines changed

2 files changed

+71
-77
lines changed

exchange/exchange-ps/exchange/Export-ActivityExplorerData.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,18 @@ This example exports up to 100 records for the specified date range in Json form
5353

5454
### Example 3
5555
```powershell
56-
Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -OutputFormat Json -PageCookie 'JZDRkpowAEV%2fZYfn6hIQCr4tCwEdoQWT4OalAyQVJEAKUtRO%2f31ZvM%2fnnjtz%2fyneTVb9HVUNV7bK91frVVM17cXaaputAV7eQuWbEmZFWbU8yham002jkqxqs0Y1V3xgq2lcqWA98eE6Dtq6EN3IMinX2WPs%2bbromllxLPpOiJ07990WAnraG8QvRV5Twfyoe3%2f7itOO00rCNvmJsfiDvOmKBbsyYNeFb7gUwzKsvYX0urPNHKpyLNNEdxxM4DUjyQWJ0mB%2bskMqdJ7KR3ojQ3pSuyk87VGcAoQacCUtxQWCQe6Rmk0LCLP9jsBWxETsKUkTF5%2fYiT3KmHvgB65hEAbFonxfyYPu0JoHSYhg0hUkGnJUlhG0jBRTk7el%2fgQPpe2H6YF8qDGgt%2bhBk7zxjNw9qxglkqCoi%2bOF7P0dl7CBAgOWRb74i5ubSC%2bJ%2bQG6eyxgE7XP7fAC6S9n3kjl7yOQPYb7KdYsIwJ2gC5n4%2bjZzvx2kA0lZ%2fHI%2b%2ft8uK5urM3Gtk1L%2bf8J'
56+
$res = Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -PageSize 5000 -OutputFormat Json
57+
58+
#Run the below steps in loop until all results are fetched
59+
60+
while ($res.LastPage -ne $true)
61+
{
62+
$pageCookie = $res.WaterMark
63+
$res = Export-ActivityExplorerData -StartTime "07/08/2022 07:15 AM" -EndTime "07/08/2022 11:08 AM" -PageSize 5000 -OutputFormat Json -PageCookie $pageCookie
64+
}
5765
```
5866

59-
This example is related to the previous example where more than 100 records were available (the value of the LastPage property from that command was False). We're using the same date range, but this time we're using the value of the Watermark property from the previous command for the PageCookie parameter in this command to get the remaining results.
67+
This example is related to the previous example where more than 100 records were available (the value of the LastPage property from that command was False). We're using the same date range, but this time we're using the value of the Watermark property from the previous command for the PageCookie parameter in this command to get the remaining results in a loop. ResultData from each iteration can be used as needed.
6068

6169
### Example 4
6270
```powershell
@@ -232,7 +240,7 @@ Accept wildcard characters: False
232240
```
233241

234242
### -PageCookie
235-
The PageCookie parameter specifies whether to get more data when the value of the LastPage property in the command output is False. If you don't use the PageSize parameter, a maximum of 100 records are returned. If you use the PageSize parameter, a maximum of 5000 records can be returned. To get more records than what as returned in the current command, use the value of the Watermark property from the output of the current command as the value for the PageCookie parameter in a new command with the same date range and filters.
243+
The PageCookie parameter specifies whether to get more data when the value of the LastPage property in the command output is False. If you don't use the PageSize parameter, a maximum of 100 records are returned. If you use the PageSize parameter, a maximum of 5000 records can be returned. To get more records than what as returned in the current command, use the value of the Watermark property from the output of the current command as the value for the PageCookie parameter in a new command with the same date range and filters. The PageCookie value is valid for 120 seconds to fetch the next set of records for same query.
236244

237245
```yaml
238246
Type: String
@@ -248,7 +256,7 @@ Accept wildcard characters: False
248256
```
249257

250258
### -PageSize
251-
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 100.
259+
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 100. Consider using a smaller PageSize value to avoid PageCookie expiry when exporting large datasets.
252260

253261
```yaml
254262
Type: Int32

exchange/exchange-ps/exchange/Start-ManagedFolderAssistant.md

Lines changed: 59 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ For information about the parameter sets in the Syntax section below, see [Excha
2020

2121
## SYNTAX
2222

23-
### Default
23+
### Identity (Default)
2424
```
2525
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-HoldCleanup]
2626
[-AggMailboxCleanup]
@@ -30,9 +30,9 @@ Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-HoldCl
3030
[<CommonParameters>]
3131
```
3232

33-
### HoldCleanup
33+
### ComplianceBoundaryAssistantParameterSet
3434
```
35-
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> -HoldCleanup
35+
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-AdaptiveScope]
3636
[-AggMailboxCleanup]
3737
[-Confirm]
3838
[-FullCrawl]
@@ -41,9 +41,9 @@ Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> -HoldCle
4141
[<CommonParameters>]
4242
```
4343

44-
### StopHoldCleanup
44+
### ComplianceJobAssistantParameterSet
4545
```
46-
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-StopHoldCleanup]
46+
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-ComplianceJob]
4747
[-AggMailboxCleanup]
4848
[-Confirm]
4949
[-FullCrawl]
@@ -52,10 +52,9 @@ Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-StopHo
5252
[<CommonParameters>]
5353
```
5454

55-
### ComplianceBoundaryAssistant
55+
### DataGovernanceAssistantParameterSet
5656
```
57-
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter>
58-
[-AdaptiveScope]
57+
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-DataGovernance]
5958
[-AggMailboxCleanup]
6059
[-Confirm]
6160
[-FullCrawl]
@@ -64,7 +63,7 @@ Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter>
6463
[<CommonParameters>]
6564
```
6665

67-
### ElcB2DumpsterArchiverAssistant
66+
### ElcB2DumpsterArchiverAssistantParameterSet
6867
```
6968
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-B2DumpsterArchiver]
7069
[-AggMailboxCleanup]
@@ -75,7 +74,7 @@ Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-B2Dump
7574
[<CommonParameters>]
7675
```
7776

78-
### ElcB2IPMArchiverAssistant
77+
### ElcB2IPMArchiverAssistantParameterSet
7978
```
8079
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-B2IPMArchiver]
8180
[-AggMailboxCleanup]
@@ -86,9 +85,9 @@ Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-B2IPMA
8685
[<CommonParameters>]
8786
```
8887

89-
### ComplianceJobAssistant
88+
### HoldCleanupParameterSet
9089
```
91-
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-ComplianceJob]
90+
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-HoldCleanup]
9291
[-AggMailboxCleanup]
9392
[-Confirm]
9493
[-FullCrawl]
@@ -97,9 +96,9 @@ Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-Compli
9796
[<CommonParameters>]
9897
```
9998

100-
### DataGovernanceAssistant
99+
### StopHoldCleanupParameterSet
101100
```
102-
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-DataGovernance]
101+
Start-ManagedFolderAssistant [-Identity] <MailboxOrMailUserIdParameter> [-StopHoldCleanup]
103102
[-AggMailboxCleanup]
104103
[-Confirm]
105104
[-FullCrawl]
@@ -166,65 +165,14 @@ Accept pipeline input: True
166165
Accept wildcard characters: False
167166
```
168167
169-
### -HoldCleanup
170-
The HoldCleanup switch instructs the Managed Folder Assistant to clean up duplicate versions of items in the Recoverable Items folder that may have been created when a mailbox is on In-Place Hold, Litigation Hold, or has Single Item Recovery enabled. You don't need to specify a value with this switch.
171-
172-
Removing duplicate items from the Recoverable Items folder reduces the folder size and may help prevent reaching Recoverable Items quota limits. For more details about Recoverable Items quota limits, see [Recoverable Items folder in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder).
173-
174-
```yaml
175-
Type: SwitchParameter
176-
Parameter Sets: HoldCleanup
177-
Aliases:
178-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
179-
180-
Required: True
181-
Position: Named
182-
Default value: None
183-
Accept pipeline input: False
184-
Accept wildcard characters: False
185-
```
186-
187-
```yaml
188-
Type: SwitchParameter
189-
Parameter Sets: Default
190-
Aliases:
191-
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
192-
193-
Required: False
194-
Position: Named
195-
Default value: None
196-
Accept pipeline input: False
197-
Accept wildcard characters: False
198-
```
199-
200-
### -StopHoldCleanup
201-
This parameter is available only in the cloud-based service.
202-
203-
The StopHoldCleanup switch stops a previous hold clean-up command that was issued on the mailbox. You don't need to specify a value with this switch.
204-
205-
A hold clean-up command will run until it completely scans the Recoverable Items folder for duplicate versions of items (it even continues after an interruption). In some cases, the hold clean-up command gets stuck, which can block other regular MRM tasks on the mailbox (for example, expiring items). The StopHoldCleanup switch tells MRM to abandon the stuck hold clean-up task so that regular tasks can continue.
206-
207-
```yaml
208-
Type: SwitchParameter
209-
Parameter Sets: StopHoldCleanup
210-
Aliases:
211-
Applicable: Exchange Online
212-
213-
Required: True
214-
Position: Named
215-
Default value: None
216-
Accept pipeline input: False
217-
Accept wildcard characters: False
218-
```
219-
220168
### -AdaptiveScope
221169
This parameter is available only in the cloud-based service.
222170
223171
{{ Fill AdaptiveScope Description }}
224172
225173
```yaml
226174
Type: SwitchParameter
227-
Parameter Sets: ComplianceBoundaryAssistant
175+
Parameter Sets: ComplianceBoundaryAssistantParameterSet
228176
Aliases:
229177
Applicable: Exchange Online
230178

@@ -258,7 +206,7 @@ This parameter is available only in the cloud-based service.
258206
259207
```yaml
260208
Type: SwitchParameter
261-
Parameter Sets: ElcB2DumpsterArchiverAssistant
209+
Parameter Sets: ElcB2DumpsterArchiverAssistantParameterSet
262210
Aliases:
263211
Applicable: Exchange Online
264212

@@ -276,7 +224,7 @@ This parameter is available only in the cloud-based service.
276224
277225
```yaml
278226
Type: SwitchParameter
279-
Parameter Sets: ElcB2IPMArchiverAssistant
227+
Parameter Sets: ElcB2IPMArchiverAssistantParameterSet
280228
Aliases:
281229
Applicable: Exchange Online
282230

@@ -294,7 +242,7 @@ This parameter is reserved for internal Microsoft use.
294242
295243
```yaml
296244
Type: SwitchParameter
297-
Parameter Sets: ComplianceJobAssistant
245+
Parameter Sets: ComplianceJobAssistantParameterSet
298246
Aliases:
299247
Applicable: Exchange Online
300248

@@ -331,7 +279,7 @@ This parameter is reserved for internal Microsoft use.
331279

332280
```yaml
333281
Type: SwitchParameter
334-
Parameter Sets: DataGovernanceAssistant
282+
Parameter Sets: DataGovernanceAssistantParameterSet
335283
Aliases:
336284
Applicable: Exchange Online
337285
@@ -349,7 +297,7 @@ The DomainController parameter specifies the domain controller that's used by th
349297

350298
```yaml
351299
Type: Fqdn
352-
Parameter Sets: Default
300+
Parameter Sets: Identity
353301
Aliases:
354302
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019
355303
@@ -367,7 +315,7 @@ The FullCrawl switch recalculates the application of tags across the whole mailb
367315

368316
```yaml
369317
Type: SwitchParameter
370-
Parameter Sets: ComplianceBoundaryAssistant, ComplianceJobAssistant, DataGovernanceAssistant, HoldCleanup, StopHoldCleanup
318+
Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet
371319
Aliases:
372320
Applicable: Exchange Online
373321
@@ -378,6 +326,24 @@ Accept pipeline input: False
378326
Accept wildcard characters: False
379327
```
380328

329+
### -HoldCleanup
330+
The HoldCleanup switch instructs the Managed Folder Assistant to clean up duplicate versions of items in the Recoverable Items folder that may have been created when a mailbox is on In-Place Hold, Litigation Hold, or has Single Item Recovery enabled. You don't need to specify a value with this switch.
331+
332+
Removing duplicate items from the Recoverable Items folder reduces the folder size and may help prevent reaching Recoverable Items quota limits. For more details about Recoverable Items quota limits, see [Recoverable Items folder in Exchange Server](https://learn.microsoft.com/Exchange/policy-and-compliance/recoverable-items-folder/recoverable-items-folder).
333+
334+
```yaml
335+
Type: SwitchParameter
336+
Parameter Sets: Identity, HoldCleanupParameterSet
337+
Aliases:
338+
Applicable: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online
339+
340+
Required: False
341+
Position: Named
342+
Default value: None
343+
Accept pipeline input: False
344+
Accept wildcard characters: False
345+
```
346+
381347
### -InactiveMailbox
382348
This parameter is available only in the cloud-based service.
383349

@@ -389,7 +355,27 @@ When you use this switch, items aren't moved from the inactive mailbox to the ar
389355

390356
```yaml
391357
Type: SwitchParameter
392-
Parameter Sets: ComplianceBoundaryAssistant, ComplianceJobAssistant, DataGovernanceAssistant, ElcB2DumpsterArchiverAssistant, ElcB2IPMArchiverAssistant, HoldCleanup, StopHoldCleanup
358+
Parameter Sets: ComplianceBoundaryAssistantParameterSet, ComplianceJobAssistantParameterSet, DataGovernanceAssistantParameterSet, ElcB2DumpsterArchiverAssistantParameterSet, ElcB2IPMArchiverAssistantParameterSet, HoldCleanupParameterSet, StopHoldCleanupParameterSet
359+
Aliases:
360+
Applicable: Exchange Online
361+
362+
Required: False
363+
Position: Named
364+
Default value: None
365+
Accept pipeline input: False
366+
Accept wildcard characters: False
367+
```
368+
369+
### -StopHoldCleanup
370+
This parameter is available only in the cloud-based service.
371+
372+
The StopHoldCleanup switch stops a previous hold clean-up command that was issued on the mailbox. You don't need to specify a value with this switch.
373+
374+
A hold clean-up command will run until it completely scans the Recoverable Items folder for duplicate versions of items (it even continues after an interruption). In some cases, the hold clean-up command gets stuck, which can block other regular MRM tasks on the mailbox (for example, expiring items). The StopHoldCleanup switch tells MRM to abandon the stuck hold clean-up task so that regular tasks can continue.
375+
376+
```yaml
377+
Type: SwitchParameter
378+
Parameter Sets: StopHoldCleanupParameterSet
393379
Aliases:
394380
Applicable: Exchange Online
395381

0 commit comments

Comments
 (0)