Skip to content

Commit 5817ea9

Browse files
committed
Minor changes to New-ComplianceSearchAction
And New_Cmdlets topic for new version of platyPS
1 parent 916aa86 commit 5817ea9

File tree

2 files changed

+22
-15
lines changed

2 files changed

+22
-15
lines changed

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -304,6 +304,8 @@ Accept wildcard characters: False
304304
```
305305
306306
### -Format
307+
In the Security & Compliance Center, this parameter requires the Export role. By default, the Export role is assigned only to the eDiscovery Manager role group.
308+
307309
The Format parameter specifies the format of the search results when you use the Export switch. Valid values are:
308310
309311
- FxStream: Export to PST files. This is the only option that's available when you export search results from the Security & Compliance Center.
@@ -314,8 +316,6 @@ The Format parameter specifies the format of the search results when you use the
314316
315317
- BodyText: Export to .txt files.
316318
317-
This parameter requires the Export role in the Security & Compliance Center. By default, the Export role is assigned only to the eDiscovery Manager role group.
318-
319319
```yaml
320320
Type: ComplianceDataTransferFormat
321321
Parameter Sets: (All)
@@ -380,12 +380,12 @@ Accept wildcard characters: False
380380
```
381381
382382
### -NotifyEmail
383+
In the Security & Compliance Center, this parameter requires the Export role. By default, the Export role is assigned only to the eDiscovery Manager role group.
384+
383385
The NotifyEmail parameter specifies the email address target for the search results when you use the Export switch.
384386
385387
The recipient you specify is in the To: field of the message.
386388
387-
In the Security & Compliance Center, this parameter requires the Export role. By default, the Export role is assigned only to the eDiscovery Manager role group.
388-
389389
```yaml
390390
Type: String
391391
Parameter Sets: Export
@@ -399,12 +399,12 @@ Accept wildcard characters: False
399399
```
400400
401401
### -NotifyEmailCC
402+
In the Security & Compliance Center, this parameter requires the Export role. By default, the Export role is assigned only to the eDiscovery Manager role group.
403+
402404
The NotifyEmailCC parameter specifies the email address target for the search results when you use the Export switch.
403405
404406
The recipient you specify is in the Cc: field of the message.
405407
406-
In the Security & Compliance Center, this parameter requires the Export role. By default, the Export role is assigned only to the eDiscovery Manager role group.
407-
408408
```yaml
409409
Type: String
410410
Parameter Sets: Export
@@ -552,6 +552,8 @@ Accept wildcard characters: False
552552
```
553553
554554
### -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.
556+
555557
The Scenario parameter specifies the scenario type when you use the Export switch. Valid values are:
556558
557559
- AnalyzeWithZoom: Prepare the search results for processing in Office 365 Advanced eDiscovery.
@@ -566,8 +568,6 @@ The Scenario parameter specifies the scenario type when you use the Export switc
566568
567569
- TriagePreview:
568570
569-
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.
570-
571571
```yaml
572572
Type: ComplianceSearchActionScenario
573573
Parameter Sets: (All)

repo_docs/NEW_CMDLETS.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Install-Module -Name platyPS -Scope CurrentUser
1212

1313
**Notes**:
1414

15-
- You need platyPS v0.10.2 or later, which was released on or about June 18, 2018. If you have an earlier version of platyPS installed, run the command `Uninstall-Module platyPS` from an elevated Windows PowerShell window, and then reinstall platyPS.
15+
- You need platyPS v0.11.1 or later, released on or about September 13, 2018. If you have an earlier version of platyPS installed, close all open Windows PowerShell windows where the platyPS module is currently loaded (or run the command `Remove-Module platyPS`) and then run `Update-Module platyPS` from an elevated Windows PowerShell window.
1616

1717
- Windows PowerShell 5.x is part of the Windows Management Framework (WMF) and can be [downloaded](http://aka.ms/wmf5download) and installed on these versions of Windows:
1818

@@ -63,6 +63,8 @@ Import-Module platyPS
6363
```
6464

6565
### Step 4: Find your module name
66+
**Note**: This step is required only if you're interested in creaing cmdlet reference topics for **all** available cmdlets in your product (the _Module_ parameter in `New-MarkdownHelp`). If you're going to manually specify the cmdlet names (the _Command_ parameter in `New-MarkdownHelp`), you can skip this step.
67+
6668
platyPS needs the name of the loaded PowerShell module or snap-in that contains the cmdlets you want to update. To find the name, run the following command:
6769

6870
```
@@ -96,7 +98,7 @@ Manifest 3.1.0.0 Microsoft.PowerShell.Utility {Add-Member, Add-T
9698
Script 1.2 PSReadline {Get-PSReadlineKeyHandler, Get-PSReadlineOption, Remov...
9799
```
98100

99-
For services that use remote PowerShell (Skype for Business Online, Teams, Exchange Online, Security & Compliance Center, and Exchange Online Protection), the module name is a temporary value that changes every time you connect. In this output, the module name is `tmp_byivwzpq.e1k`.
101+
For services that use remote PowerShell (Skype for Business Online, Teams, Exchange Online, Security & Compliance Center, and Exchange Online Protection), the module name is a temporary value that changes every time you connect. In this output, the module name is `tmp_byivwzpq.e1k`, but yours will be different.
100102

101103
For SharePoint Online in the SharePoint Online Management Shell, the module name is always `Microsoft.Online.SharePoint.PowerShell`.
102104

@@ -186,7 +188,7 @@ New-MarkdownHelp -Module tmp_byivwzpq.e1k -OutputFolder "C:\My Docs\SfBO" -Sessi
186188
```
187189
188190
#### Dump specific cmdlets to files
189-
This example create a topic file for the cmdlet named Get-CoolFeature in the Exchange Online PowerShell session where the session variable is `$Session` in the folder "C:\My Docs\ExO".
191+
This example creates a topic file for the cmdlet named Get-CoolFeature in the Exchange Online PowerShell session where the session variable is `$Session` in the folder "C:\My Docs\ExO".
190192
191193
```
192194
New-MarkdownHelp -Command "Get-CoolFeature" -OutputFolder "C:\My Docs\ExO" -Session $Session
@@ -330,10 +332,15 @@ After you're done editing the TOC file:
330332
## Appendix
331333
332334
### Reference
333-
* https://docs.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershell-6
334-
* https://docs.microsoft.com/en-us/powershell/module/powershellget/update-module?view=powershell-6
335-
* https://github.com/PowerShell/platyPS
336-
* https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/get-module?view=powershell-6
335+
336+
- https://docs.microsoft.com/en-us/powershell/module/powershellget/install-module?view=powershell-6
337+
338+
- https://docs.microsoft.com/en-us/powershell/module/powershellget/update-module?view=powershell-6
339+
340+
- https://github.com/PowerShell/platyPS
341+
342+
- https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/get-module?view=powershell-6
343+
337344
338345
### Install platyPS on older versions of Windows
339346

0 commit comments

Comments
 (0)