Skip to content

Commit 20b6ef8

Browse files
committed
Update exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-ComplianceSearchAction.md
Added Purge/PurgeType info per Issue #2077
1 parent ab90298 commit 20b6ef8

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

exchange/exchange-ps/exchange/policy-and-compliance-content-search/New-ComplianceSearchAction.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,12 @@ New-ComplianceSearchAction [-SearchName] <String[]> [-Export]
2424
[-ArchiveFormat <ComplianceExportArchiveFormat>]
2525
[-Confirm]
2626
[-FileTypeExclusionsForUnindexedItems <String[]>]
27-
[-EnableDedupe <Boolean>]
27+
[-EnableDedupe <$true | $false>]
2828
[-ExchangeArchiveFormat <ComplianceExportArchiveFormat>]
2929
[-Force]
3030
[-Format <ComplianceDataTransferFormat>]
3131
[-IncludeCredential]
32-
[-IncludeSharePointDocumentVersions <Boolean>]
32+
[-IncludeSharePointDocumentVersions <$true | $false>]
3333
[-JobOptions <Int32>]
3434
[-NotifyEmail <String>]
3535
[-NotifyEmailCC <String>]
@@ -65,14 +65,13 @@ New-ComplianceSearchAction [-SearchName] <String[]> [-Preview]
6565

6666
### Purge
6767
```
68-
New-ComplianceSearchAction [-SearchName] <String[]> [-Purge]
68+
New-ComplianceSearchAction [-SearchName] <String[]> [-Purge] [-PurgeType <ComplianceDestroyType>]
6969
[-ActionName <String>]
7070
[-Confirm]
7171
[-Force]
7272
[-Format <ComplianceDataTransferFormat>]
7373
[-IncludeCredential]
7474
[-JobOptions <Int32>]
75-
[-PurgeType <ComplianceDestroyType>]
7675
[-Region <String>]
7776
[-ReferenceActionName <String>]
7877
[-RetryOnError]
@@ -208,7 +207,7 @@ The EnableDedupe parameter eliminates duplication of messages when you export co
208207
- $false: Export all copies of a message if the same message exists in multiple folders or mailboxes. This is the default value.
209208
210209
```yaml
211-
Type: Boolean
210+
Type: $true | $false
212211
Parameter Sets: Export
213212
Aliases:
214213
Applicable: Office 365 Security & Compliance Center
@@ -310,9 +309,9 @@ The Format parameter specifies the format of the search results when you use the
310309
311310
- FxStream: Export to PST files. This is the only option that's available when you export search results from the Security & Compliance Center.
312311
313-
- Mime: Export to .eml messsage files. This the default value when you use cmdlets to export the search results.
312+
- Mime: Export to .eml message files. This the default value when you use cmdlets to export the search results.
314313
315-
- Message: Export to .msg messsage files.
314+
- Message: Export to .msg message files.
316315
317316
- BodyText: Export to .txt files.
318317
@@ -353,7 +352,7 @@ The IncludeSharePointDocumentVersions parameter specifies whether to export prev
353352
- $false: Export only the current published version of the topic. This is the default value.
354353
355354
```yaml
356-
Type: Boolean
355+
Type: $true | $false
357356
Parameter Sets: Export
358357
Aliases:
359358
Applicable: Office 365 Security & Compliance Center
@@ -420,7 +419,7 @@ Accept wildcard characters: False
420419
### -Preview
421420
The Preview switch specifies the action for the content search is to preview the results that match the search criteria. You don't need to specify a value with this switch.
422421
423-
In the Security & Compliance Center, this parameter requires the Preivew role. By default, the Preview role is assigned only to the eDiscovery Manager role group.
422+
In the Security & Compliance Center, this parameter requires the Preview role. By default, the Preview role is assigned only to the eDiscovery Manager role group.
424423
425424
```yaml
426425
Type: SwitchParameter
@@ -437,9 +436,13 @@ Accept wildcard characters: False
437436
### -Purge
438437
The Purge switch specifies the action for the content search is to remove items that match the search criteria. You don't need to specify a value with this switch.
439438
440-
Note that a maximum of 10 items per mailbox can be removed at one time. Because the capability to search for and remove messages is intended to be an incident-response tool, this limit helps ensure that messages are quickly removed from mailboxes. This action isn't intended to clean up user mailboxes.
439+
Notes:
441440
442-
Additionally, unindexed items aren't removed from mailboxes when you use this switch.
441+
- A maximum of 10 items per mailbox can be removed at one time. Because the capability to search for and remove messages is intended to be an incident-response tool, this limit helps ensure that messages are quickly removed from mailboxes. This action isn't intended to clean up user mailboxes.
442+
443+
- Unindexed items aren't removed from mailboxes when you use this switch.
444+
445+
- The value of the PurgeType parameter controls how the items are removed.
443446
444447
```yaml
445448
Type: SwitchParameter
@@ -458,6 +461,8 @@ The PurgeType parameter specifies how to remove items when the action is Purge.
458461
459462
The valid value for this parameter is SoftDelete, which means the purged items are recoverable by users until the deleted items retention period expires.
460463
464+
Note: To hard delete items, use the Search-Mailbox cmdlet with the DeleteContent switch. For more information, see Search for and delete messages (https://docs.microsoft.com/office365/SecurityCompliance/search-for-and-delete-messagesadmin-help).
465+
461466
```yaml
462467
Type: ComplianceDestroyType
463468
Parameter Sets: Purge
@@ -552,7 +557,7 @@ Accept wildcard characters: False
552557
```
553558
554559
### -Scenario
555-
In the Security & Compliance Center, this parameter requires the Preivew role. By default, the Preview role is assigned only to the eDiscovery Manager role group.
560+
In the Security & Compliance Center, this parameter requires the Preview role. By default, the Preview role is assigned only to the eDiscovery Manager role group.
556561
557562
The Scenario parameter specifies the scenario type when you use the Export switch. Valid values are:
558563
@@ -625,7 +630,7 @@ Accept wildcard characters: False
625630
### -SearchNames
626631
This parameter is available only in the cloud-based service.
627632
628-
The SearchNames parameter specifies the names of the existing content searches to associate with the content search action. You separate the content searche names by commas.
633+
The SearchNames parameter specifies the names of the existing content searches to associate with the content search action. You separate the content search names by commas.
629634
630635
You can find content search names by running the command Get-ComplianceSearch | Format-Table -Auto Name,Status.
631636

0 commit comments

Comments
 (0)