Skip to content

Commit 8a35f5e

Browse files
authored
Merge pull request MicrosoftDocs#3882 from MicrosoftDocs/chrisda
Converted SYNTAX blocks to one param per line and sorted
2 parents a200090 + 02627e8 commit 8a35f5e

12 files changed

+461
-294
lines changed

docset/winserver2022-ps/defender/Add-MpPreference.md

+23-14
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,23 @@ Modifies settings for Windows Defender.
1616
## SYNTAX
1717

1818
```
19-
Add-MpPreference [-ExclusionPath <String[]>] [-ExclusionExtension <String[]>]
20-
[-ExclusionProcess <String[]>] [-ExclusionIpAddress <String[]>]
21-
[-ThreatIDDefaultAction_Ids <Int64[]>] [-ThreatIDDefaultAction_Actions <ThreatAction[]>]
22-
[-AttackSurfaceReductionOnlyExclusions <String[]>]
23-
[-ControlledFolderAccessAllowedApplications <String[]>]
24-
[-ControlledFolderAccessProtectedFolders <String[]>] [-AttackSurfaceReductionRules_Ids <String[]>]
25-
[-AttackSurfaceReductionRules_Actions <ASRRuleActionType[]>] [-Force] [-CimSession <CimSession[]>]
26-
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
19+
Add-MpPreference
20+
[-AsJob]
21+
[-AttackSurfaceReductionOnlyExclusions <String[]>]
22+
[-AttackSurfaceReductionRules_Actions <ASRRuleActionType[]>]
23+
[-AttackSurfaceReductionRules_Ids <String[]>]
24+
[-CimSession <CimSession[]>]
25+
[-ControlledFolderAccessAllowedApplications <String[]>]
26+
[-ControlledFolderAccessProtectedFolders <String[]>]
27+
[-ExclusionExtension <String[]>]
28+
[-ExclusionIpAddress <String[]>]
29+
[-ExclusionPath <String[]>]
30+
[-ExclusionProcess <String[]>]
31+
[-Force]
32+
[-ThreatIDDefaultAction_Actions <ThreatAction[]>]
33+
[-ThreatIDDefaultAction_Ids <Int64[]>]
34+
[-ThrottleLimit <Int32>]
35+
[<CommonParameters>]
2736
```
2837

2938
## DESCRIPTION
@@ -69,7 +78,7 @@ For more information about Windows PowerShell background jobs, see
6978
```yaml
7079
Type: SwitchParameter
7180
Parameter Sets: (All)
72-
Aliases:
81+
Aliases:
7382

7483
Required: False
7584
Position: Named
@@ -212,7 +221,7 @@ Specifies an array of IP addresses to exclude from scheduled and real-time scann
212221
```yaml
213222
Type: String[]
214223
Parameter Sets: (All)
215-
Aliases:
224+
Aliases:
216225
217226
Required: False
218227
Position: Named
@@ -229,7 +238,7 @@ You can specify a folder to exclude all the files under the folder.
229238
```yaml
230239
Type: String[]
231240
Parameter Sets: (All)
232-
Aliases:
241+
Aliases:
233242
234243
Required: False
235244
Position: Named
@@ -248,7 +257,7 @@ themselves. To exclude a process, specify it by using the **ExclusionPath** para
248257
```yaml
249258
Type: String[]
250259
Parameter Sets: (All)
251-
Aliases:
260+
Aliases:
252261
253262
Required: False
254263
Position: Named
@@ -264,7 +273,7 @@ Forces the command to run without asking for user confirmation.
264273
```yaml
265274
Type: SwitchParameter
266275
Parameter Sets: (All)
267-
Aliases:
276+
Aliases:
268277
269278
Required: False
270279
Position: Named
@@ -327,7 +336,7 @@ computer.
327336
```yaml
328337
Type: Int32
329338
Parameter Sets: (All)
330-
Aliases:
339+
Aliases:
331340
332341
Required: False
333342
Position: Named

docset/winserver2022-ps/defender/Get-MpComputerStatus.md

+17-15
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,11 @@ Gets the status of antimalware software on the computer.
1616
## SYNTAX
1717

1818
```
19-
Get-MpComputerStatus [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
20-
[<CommonParameters>]
19+
Get-MpComputerStatus
20+
[-AsJob]
21+
[-CimSession <CimSession[]>]
22+
[-ThrottleLimit <Int32>]
23+
[<CommonParameters>]
2124
```
2225

2326
## DESCRIPTION
@@ -29,7 +32,7 @@ computer.
2932

3033
### Example 1: Get the computer status
3134

32-
```
35+
```powershell
3336
PS C:\> Get-MpComputerStatus
3437
AMEngineVersion : 1.1.24050.5
3538
AMProductVersion : 4.18.24050.7
@@ -45,18 +48,18 @@ AntivirusSignatureAge : 1
4548
AntivirusSignatureLastUpdated : 6/4/2024 8:06:27 AM
4649
AntivirusSignatureVersion : 1.413.102.0
4750
BehaviorMonitorEnabled : True
48-
ComputerID :
51+
ComputerID :
4952
ComputerState : 0
5053
DefenderSignaturesOutOfDate : False
51-
DeviceControlDefaultEnforcement :
54+
DeviceControlDefaultEnforcement :
5255
DeviceControlPoliciesLastUpdated : 12/31/1600 4:00:00 PM
5356
DeviceControlState : Disabled
5457
FullScanAge : 4294967295
55-
FullScanEndTime :
58+
FullScanEndTime :
5659
FullScanOverdue : False
5760
FullScanRequired : False
58-
FullScanSignatureVersion :
59-
FullScanStartTime :
61+
FullScanSignatureVersion :
62+
FullScanStartTime :
6063
InitializationProgress : ServiceStartedSuccessfully
6164
IoavProtectionEnabled : True
6265
IsTamperProtected : False
@@ -71,14 +74,14 @@ NISSignatureVersion : 1.413.102.0
7174
OnAccessProtectionEnabled : True
7275
ProductStatus : 524288
7376
QuickScanAge : 4294967295
74-
QuickScanEndTime :
77+
QuickScanEndTime :
7578
QuickScanOverdue : False
76-
QuickScanSignatureVersion :
77-
QuickScanStartTime :
79+
QuickScanSignatureVersion :
80+
QuickScanStartTime :
7881
RealTimeProtectionEnabled : True
7982
RealTimeScanDirection : 0
8083
RebootRequired : False
81-
SmartAppControlExpiration :
84+
SmartAppControlExpiration :
8285
SmartAppControlState : Off
8386
TamperProtectionSource : E5 transition
8487
TDTCapable : N/A
@@ -95,7 +98,6 @@ TroubleShootingModeSource : ATP
9598
TroubleShootingQuotaResetTime : 6/5/2024 4:47:42 PM
9699
TroubleShootingStartTime : N/A
97100
PSComputerName :
98-
99101
```
100102

101103
This command gets the status of antimalware protection software installed on the computer.
@@ -118,7 +120,7 @@ For more information about Windows PowerShell background jobs, see
118120
```yaml
119121
Type: SwitchParameter
120122
Parameter Sets: (All)
121-
Aliases:
123+
Aliases:
122124

123125
Required: False
124126
Position: Named
@@ -157,7 +159,7 @@ computer.
157159
```yaml
158160
Type: Int32
159161
Parameter Sets: (All)
160-
Aliases:
162+
Aliases:
161163
162164
Required: False
163165
Position: Named

docset/winserver2022-ps/defender/Get-MpPreference.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,11 @@ Gets preferences for the Windows Defender scans and updates.
1616
## SYNTAX
1717

1818
```
19-
Get-MpPreference [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
20-
[<CommonParameters>]
19+
Get-MpPreference
20+
[-AsJob]
21+
[-CimSession <CimSession[]>]
22+
[-ThrottleLimit <Int32>]
23+
[<CommonParameters>]
2124
```
2225

2326
## DESCRIPTION
@@ -30,7 +33,7 @@ information about the preferences that this cmdlet retrieves, see
3033

3134
### Example 1: View the scheduled scan day
3235

33-
```
36+
```powershell
3437
PS C:\> $Preferences = Get-MpPreference
3538
PS C:\> $Preferences.ScanScheduleDay
3639
```
@@ -58,7 +61,7 @@ For more information about Windows PowerShell background jobs, see
5861
```yaml
5962
Type: SwitchParameter
6063
Parameter Sets: (All)
61-
Aliases:
64+
Aliases:
6265

6366
Required: False
6467
Position: Named
@@ -97,7 +100,7 @@ computer.
97100
```yaml
98101
Type: Int32
99102
Parameter Sets: (All)
100-
Aliases:
103+
Aliases:
101104
102105
Required: False
103106
Position: Named

docset/winserver2022-ps/defender/Get-MpThreat.md

+9-6
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,12 @@ Get-MpThreat [<CommonParameters>]
2424
### ById
2525

2626
```
27-
Get-MpThreat [-ThreatID <Int64[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
28-
[<CommonParameters>]
27+
Get-MpThreat
28+
[-AsJob]
29+
[-CimSession <CimSession[]>]
30+
[-ThreatID <Int64[]>]
31+
[-ThrottleLimit <Int32>]
32+
[<CommonParameters>]
2933
```
3034

3135
## DESCRIPTION
@@ -37,7 +41,7 @@ computer.
3741

3842
### Example 1: Get the history of a detected threat
3943

40-
```
44+
```powershell
4145
PS C:\> Get-MpThreat -ThreatID 1994
4246
```
4347

@@ -61,7 +65,7 @@ For more information about Windows PowerShell background jobs, see
6165
```yaml
6266
Type: SwitchParameter
6367
Parameter Sets: ById
64-
Aliases:
68+
Aliases:
6569

6670
Required: False
6771
Position: Named
@@ -117,7 +121,7 @@ computer.
117121
```yaml
118122
Type: Int32
119123
Parameter Sets: ById
120-
Aliases:
124+
Aliases:
121125
122126
Required: False
123127
Position: Named
@@ -146,4 +150,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
146150
[Get-MpThreatCatalog](./Get-MpThreatCatalog.md)
147151

148152
[Get-MpThreatDetection](./Get-MpThreatDetection.md)
149-

docset/winserver2022-ps/defender/Get-MpThreatCatalog.md

+8-4
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,11 @@ Get-MpThreatCatalog [<CommonParameters>]
2424
### ById
2525

2626
```
27-
Get-MpThreatCatalog [-ThreatID <Int64[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
27+
Get-MpThreatCatalog
28+
[-AsJob]
29+
[-CimSession <CimSession[]>]
30+
[-ThreatID <Int64[]>]
31+
[-ThrottleLimit <Int32>]
2832
[<CommonParameters>]
2933
```
3034

@@ -37,7 +41,7 @@ The definitions catalog contains references to all known threats that Windows De
3741

3842
### Example 1: Get a known threat from the definitions catalog
3943

40-
```
44+
```powershell
4145
PS C:\> Get-MpThreatCatalog -ThreatID 1994
4246
```
4347

@@ -61,7 +65,7 @@ For more information about Windows PowerShell background jobs, see
6165
```yaml
6266
Type: SwitchParameter
6367
Parameter Sets: ById
64-
Aliases:
68+
Aliases:
6569

6670
Required: False
6771
Position: Named
@@ -117,7 +121,7 @@ computer.
117121
```yaml
118122
Type: Int32
119123
Parameter Sets: ById
120-
Aliases:
124+
Aliases:
121125
122126
Required: False
123127
Position: Named

docset/winserver2022-ps/defender/Get-MpThreatDetection.md

+16-12
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,11 @@ Get-MpThreatDetection [<CommonParameters>]
2222

2323
### ById
2424
```
25-
Get-MpThreatDetection [-ThreatID <Int64[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
25+
Get-MpThreatDetection
26+
[-AsJob]
27+
[-CimSession <CimSession[]>]
28+
[-ThreatID <Int64[]>]
29+
[-ThrottleLimit <Int32>]
2630
[<CommonParameters>]
2731
```
2832

@@ -33,15 +37,15 @@ If Windows Defender has detected the threat that you specify, this cmdlet return
3337
## EXAMPLES
3438

3539
### Example 1: Get threats that Windows Defender detected
36-
```
40+
```powershell
3741
PS C:\> Get-MpThreatDetection
3842
```
3943

4044
This command returns the list of past malware detections for the local computer.
4145

4246
**Error codes**
4347

44-
The following table lists the hexadecimal and decimal error codes for this cmdlet. Each hexadecimal error code has a 0x8050 prefix. Therefore, an ERROR_MP_BAD_SCANID error corresponds to error code 0x80508012. Additionally, an ERR_MP_REMOVE_FAILED error corresponds to error code 0x80508017.
48+
The following table lists the hexadecimal and decimal error codes for this cmdlet. Each hexadecimal error code has a 0x8050 prefix. Therefore, an ERROR_MP_BAD_SCANID error corresponds to error code 0x80508012. Additionally, an ERR_MP_REMOVE_FAILED error corresponds to error code 0x80508017.
4549

4650
For a list of error codes, along with possible reasons and resolutions, see [Windows Defender Antivirus client error codes](/windows/security/threat-protection/windows-defender-antivirus/troubleshoot-windows-defender-antivirus#windows-defender-antivirus-client-error-codes) in the topic [Review event logs and error codes to troubleshoot issues with Windows Defender Antivirus](/windows/security/threat-protection/windows-defender-antivirus/troubleshoot-windows-defender-antivirus#windows-defender-antivirus-client-error-codes).
4751

@@ -87,19 +91,19 @@ For a list of error codes, along with possible reasons and resolutions, see [Win
8791
## PARAMETERS
8892

8993
### -AsJob
90-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
94+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
9195

92-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
93-
You can continue to work in the session while the job completes.
94-
To manage the job, use the `*-Job` cmdlets.
95-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
96+
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
97+
You can continue to work in the session while the job completes.
98+
To manage the job, use the `*-Job` cmdlets.
99+
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
96100

97101
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
98102

99103
```yaml
100104
Type: SwitchParameter
101105
Parameter Sets: ById
102-
Aliases:
106+
Aliases:
103107

104108
Required: False
105109
Position: Named
@@ -109,8 +113,8 @@ Accept wildcard characters: False
109113
```
110114
111115
### -CimSession
112-
Runs the cmdlet in a remote session or on a remote computer.
113-
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
116+
Runs the cmdlet in a remote session or on a remote computer.
117+
Enter a computer name or a session object, such as the output of a [New-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227967) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
114118
The default is the current session on the local computer.
115119
116120
```yaml
@@ -149,7 +153,7 @@ The throttle limit applies only to the current cmdlet, not to the session or to
149153
```yaml
150154
Type: Int32
151155
Parameter Sets: ById
152-
Aliases:
156+
Aliases:
153157
154158
Required: False
155159
Position: Named

0 commit comments

Comments
 (0)