Merge pull request #3882 from MicrosoftDocs/chrisda

Converted SYNTAX blocks to one param per line and sorted
MicrosoftDocs · Oct 16, 2024 · 8a35f5e · 8a35f5e
2 parents a200090 + 02627e8
commit 8a35f5e
Show file tree

Hide file tree

Showing 12 changed files with 461 additions and 294 deletions.
diff --git a/docset/winserver2022-ps/defender/Add-MpPreference.md b/docset/winserver2022-ps/defender/Add-MpPreference.md
@@ -16,14 +16,23 @@ Modifies settings for Windows Defender.
 ## SYNTAX
 
 ```
-Add-MpPreference [-ExclusionPath <String[]>] [-ExclusionExtension <String[]>]
-[-ExclusionProcess <String[]>] [-ExclusionIpAddress <String[]>]
-[-ThreatIDDefaultAction_Ids <Int64[]>] [-ThreatIDDefaultAction_Actions <ThreatAction[]>]
-[-AttackSurfaceReductionOnlyExclusions <String[]>]
-[-ControlledFolderAccessAllowedApplications <String[]>]
-[-ControlledFolderAccessProtectedFolders <String[]>] [-AttackSurfaceReductionRules_Ids <String[]>]
-[-AttackSurfaceReductionRules_Actions <ASRRuleActionType[]>] [-Force] [-CimSession <CimSession[]>]
-[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
+Add-MpPreference
+ [-AsJob]
+ [-AttackSurfaceReductionOnlyExclusions <String[]>]
+ [-AttackSurfaceReductionRules_Actions <ASRRuleActionType[]>]
+ [-AttackSurfaceReductionRules_Ids <String[]>]
+ [-CimSession <CimSession[]>]
+ [-ControlledFolderAccessAllowedApplications <String[]>]
+ [-ControlledFolderAccessProtectedFolders <String[]>]
+ [-ExclusionExtension <String[]>]
+ [-ExclusionIpAddress <String[]>]
+ [-ExclusionPath <String[]>]
+ [-ExclusionProcess <String[]>]
+ [-Force]
+ [-ThreatIDDefaultAction_Actions <ThreatAction[]>]
+ [-ThreatIDDefaultAction_Ids <Int64[]>]
+ [-ThrottleLimit <Int32>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -69,7 +78,7 @@ For more information about Windows PowerShell background jobs, see
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -212,7 +221,7 @@ Specifies an array of IP addresses to exclude from scheduled and real-time scann
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -229,7 +238,7 @@ You can specify a folder to exclude all the files under the folder.
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -248,7 +257,7 @@ themselves. To exclude a process, specify it by using the **ExclusionPath** para
 ```yaml
 Type: String[]
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -264,7 +273,7 @@ Forces the command to run without asking for user confirmation.
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -327,7 +336,7 @@ computer.
 ```yaml
 Type: Int32
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named

diff --git a/docset/winserver2022-ps/defender/Get-MpComputerStatus.md b/docset/winserver2022-ps/defender/Get-MpComputerStatus.md
@@ -16,8 +16,11 @@ Gets the status of antimalware software on the computer.
 ## SYNTAX
 
 ```
-Get-MpComputerStatus [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
-[<CommonParameters>]
+Get-MpComputerStatus
+ [-AsJob]
+ [-CimSession <CimSession[]>]
+ [-ThrottleLimit <Int32>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -29,7 +32,7 @@ computer.
 
 ### Example 1: Get the computer status
 
-```
+```powershell
 PS C:\> Get-MpComputerStatus
 AMEngineVersion                  : 1.1.24050.5
 AMProductVersion                 : 4.18.24050.7
@@ -45,18 +48,18 @@ AntivirusSignatureAge            : 1
 AntivirusSignatureLastUpdated    : 6/4/2024 8:06:27 AM
 AntivirusSignatureVersion        : 1.413.102.0
 BehaviorMonitorEnabled           : True
-ComputerID                       : 
+ComputerID                       :
 ComputerState                    : 0
 DefenderSignaturesOutOfDate      : False
-DeviceControlDefaultEnforcement  : 
+DeviceControlDefaultEnforcement  :
 DeviceControlPoliciesLastUpdated : 12/31/1600 4:00:00 PM
 DeviceControlState               : Disabled
 FullScanAge                      : 4294967295
-FullScanEndTime                  : 
+FullScanEndTime                  :
 FullScanOverdue                  : False
 FullScanRequired                 : False
-FullScanSignatureVersion         : 
-FullScanStartTime                : 
+FullScanSignatureVersion         :
+FullScanStartTime                :
 InitializationProgress           : ServiceStartedSuccessfully
 IoavProtectionEnabled            : True
 IsTamperProtected                : False
@@ -71,14 +74,14 @@ NISSignatureVersion              : 1.413.102.0
 OnAccessProtectionEnabled        : True
 ProductStatus                    : 524288
 QuickScanAge                     : 4294967295
-QuickScanEndTime                 : 
+QuickScanEndTime                 :
 QuickScanOverdue                 : False
-QuickScanSignatureVersion        : 
-QuickScanStartTime               : 
+QuickScanSignatureVersion        :
+QuickScanStartTime               :
 RealTimeProtectionEnabled        : True
 RealTimeScanDirection            : 0
 RebootRequired                   : False
-SmartAppControlExpiration        : 
+SmartAppControlExpiration        :
 SmartAppControlState             : Off
 TamperProtectionSource           : E5 transition
 TDTCapable                       : N/A
@@ -95,7 +98,6 @@ TroubleShootingModeSource        : ATP
 TroubleShootingQuotaResetTime    : 6/5/2024 4:47:42 PM
 TroubleShootingStartTime         : N/A
 PSComputerName                   :
-
 ```
 
 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
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -157,7 +159,7 @@ computer.
 ```yaml
 Type: Int32
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named

diff --git a/docset/winserver2022-ps/defender/Get-MpPreference.md b/docset/winserver2022-ps/defender/Get-MpPreference.md
@@ -16,8 +16,11 @@ Gets preferences for the Windows Defender scans and updates.
 ## SYNTAX
 
 ```
-Get-MpPreference [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
-[<CommonParameters>]
+Get-MpPreference
+ [-AsJob]
+ [-CimSession <CimSession[]>]
+ [-ThrottleLimit <Int32>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -30,7 +33,7 @@ information about the preferences that this cmdlet retrieves, see
 
 ### Example 1: View the scheduled scan day
 
-```
+```powershell
 PS C:\> $Preferences = Get-MpPreference
 PS C:\> $Preferences.ScanScheduleDay
 ```
@@ -58,7 +61,7 @@ For more information about Windows PowerShell background jobs, see
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -97,7 +100,7 @@ computer.
 ```yaml
 Type: Int32
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named

diff --git a/docset/winserver2022-ps/defender/Get-MpThreat.md b/docset/winserver2022-ps/defender/Get-MpThreat.md
@@ -24,8 +24,12 @@ Get-MpThreat [<CommonParameters>]
 ### ById
 
 ```
-Get-MpThreat [-ThreatID <Int64[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
-[<CommonParameters>]
+Get-MpThreat
+ [-AsJob]
+ [-CimSession <CimSession[]>]
+ [-ThreatID <Int64[]>]
+ [-ThrottleLimit <Int32>]
+ [<CommonParameters>]
 ```
 
 ## DESCRIPTION
@@ -37,7 +41,7 @@ computer.
 
 ### Example 1: Get the history of a detected threat
 
-```
+```powershell
 PS C:\> Get-MpThreat -ThreatID 1994
 ```
 
@@ -61,7 +65,7 @@ For more information about Windows PowerShell background jobs, see
 ```yaml
 Type: SwitchParameter
 Parameter Sets: ById
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -117,7 +121,7 @@ computer.
 ```yaml
 Type: Int32
 Parameter Sets: ById
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -146,4 +150,3 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
 [Get-MpThreatCatalog](./Get-MpThreatCatalog.md)
 
 [Get-MpThreatDetection](./Get-MpThreatDetection.md)
-
diff --git a/docset/winserver2022-ps/defender/Get-MpThreatCatalog.md b/docset/winserver2022-ps/defender/Get-MpThreatCatalog.md
@@ -24,7 +24,11 @@ Get-MpThreatCatalog [<CommonParameters>]
 ### ById
 
 ```
-Get-MpThreatCatalog [-ThreatID <Int64[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
+Get-MpThreatCatalog
+ [-AsJob]
+ [-CimSession <CimSession[]>]
+ [-ThreatID <Int64[]>]
+ [-ThrottleLimit <Int32>]
  [<CommonParameters>]
 ```
 
@@ -37,7 +41,7 @@ The definitions catalog contains references to all known threats that Windows De
 
 ### Example 1: Get a known threat from the definitions catalog
 
-```
+```powershell
 PS C:\> Get-MpThreatCatalog -ThreatID 1994
 ```
 
@@ -61,7 +65,7 @@ For more information about Windows PowerShell background jobs, see
 ```yaml
 Type: SwitchParameter
 Parameter Sets: ById
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -117,7 +121,7 @@ computer.
 ```yaml
 Type: Int32
 Parameter Sets: ById
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named

diff --git a/docset/winserver2022-ps/defender/Get-MpThreatDetection.md b/docset/winserver2022-ps/defender/Get-MpThreatDetection.md
@@ -22,7 +22,11 @@ Get-MpThreatDetection [<CommonParameters>]
 
 ### ById
 ```
-Get-MpThreatDetection [-ThreatID <Int64[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
+Get-MpThreatDetection
+ [-AsJob]
+ [-CimSession <CimSession[]>]
+ [-ThreatID <Int64[]>]
+ [-ThrottleLimit <Int32>]
  [<CommonParameters>]
 ```
 
@@ -33,15 +37,15 @@ If Windows Defender has detected the threat that you specify, this cmdlet return
 ## EXAMPLES
 
 ### Example 1: Get threats that Windows Defender detected
-```
+```powershell
 PS C:\> Get-MpThreatDetection
 ```
 
 This command returns the list of past malware detections for the local computer.
 
 **Error codes**
 
-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. 
+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.
 
 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).
 
@@ -87,19 +91,19 @@ For a list of error codes, along with possible reasons and resolutions, see [Win
 ## PARAMETERS
 
 ### -AsJob
-Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. 
+Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
 
-The cmdlet immediately returns an object that represents the job and then displays the command prompt. 
-You can continue to work in the session while the job completes. 
-To manage the job, use the `*-Job` cmdlets. 
-To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet. 
+The cmdlet immediately returns an object that represents the job and then displays the command prompt.
+You can continue to work in the session while the job completes.
+To manage the job, use the `*-Job` cmdlets.
+To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
 
 For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
 
 ```yaml
 Type: SwitchParameter
 Parameter Sets: ById
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -109,8 +113,8 @@ Accept wildcard characters: False
 ```
 
 ### -CimSession
-Runs the cmdlet in a remote session or on a remote computer. 
-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. 
+Runs the cmdlet in a remote session or on a remote computer.
+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.
 The default is the current session on the local computer.
 
 ```yaml
@@ -149,7 +153,7 @@ The throttle limit applies only to the current cmdlet, not to the session or to
 ```yaml
 Type: Int32
 Parameter Sets: ById
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named