Skip to content

Commit 4c3453e

Browse files
RobBiddlemichaeltlombardi
authored andcommitted
Style guide fixes
1 parent 91fa9ff commit 4c3453e

File tree

1 file changed

+59
-38
lines changed

1 file changed

+59
-38
lines changed

docset/winserver2022-ps/deduplication/Get-DedupJob.md

Lines changed: 59 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -16,38 +16,45 @@ Returns status and information for currently running or queued deduplication job
1616
## SYNTAX
1717

1818
```
19-
Get-DedupJob [[-Type] <Type[]>] [[-Volume] <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
20-
[-AsJob] [<CommonParameters>]
19+
Get-DedupJob [[-Type] <Type[]>] [[-Volume] <String[]>] [-CimSession <CimSession[]>]
20+
[-ThrottleLimit <Int32>] [-AsJob] [<CommonParameters>]
2121
```
2222

2323
## DESCRIPTION
24-
The **Get-DedupJob** returns status and information for currently running or queued deduplication jobs.
24+
25+
The `Get-DedupJob` returns status and information for currently running or queued deduplication
26+
jobs.
2527

2628
To run this cmdlet, you must start Windows PowerShell® with the **Run as administrator** option.
2729

2830
## EXAMPLES
2931

3032
### Example 1: Get information for jobs for specified volumes
31-
```
32-
PS C:\> Get-DedupJob -Volume "D:","F:"
33+
34+
```powershell
35+
Get-DedupJob -Volume "D:","F:"
3336
```
3437

35-
This command gets status and information for currently running or queued deduplication jobs for the D: and F: volumes.
38+
This command gets status and information for currently running or queued deduplication jobs for the
39+
`D:` and `F:` volumes.
3640

3741
## PARAMETERS
3842

3943
### -AsJob
40-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
4144

42-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
43-
You can continue to work in the session while the job completes.
44-
To manage the job, use the `*-Job` cmdlets.
45-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
45+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
46+
complete.
4647

47-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
48+
The cmdlet immediately returns an object that represents the job and then displays the command
49+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
50+
`*-Job` cmdlets. To get the job results, use the
51+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
52+
53+
For more information about Windows PowerShell background jobs, see
54+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
4855

4956
```yaml
50-
Type: SwitchParameter
57+
Type: System.Management.Automation.SwitchParameter
5158
Parameter Sets: (All)
5259
Aliases:
5360

@@ -59,12 +66,14 @@ Accept wildcard characters: False
5966
```
6067
6168
### -CimSession
62-
Runs the cmdlet in a remote session or on a remote computer.
63-
Enter a computer name or a session object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet.
64-
The default is the current session on the local computer.
69+
70+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
71+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
72+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
73+
current session on the local computer.
6574
6675
```yaml
67-
Type: CimSession[]
76+
Type: Microsoft.Management.Infrastructure.CimSession[]
6877
Parameter Sets: (All)
6978
Aliases: Session
7079

@@ -76,12 +85,15 @@ Accept wildcard characters: False
7685
```
7786
7887
### -ThrottleLimit
79-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
80-
If this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer.
81-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
88+
89+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
90+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
91+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
92+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
93+
computer.
8294

8395
```yaml
84-
Type: Int32
96+
Type: System.Int32
8597
Parameter Sets: (All)
8698
Aliases:
8799
@@ -93,13 +105,14 @@ Accept wildcard characters: False
93105
```
94106

95107
### -Type
96-
Specifies an array of types of data deduplication jobs for which to return the job state.
97-
The acceptable values for this parameter are:
98108

99-
- Optimization
100-
- GarbageCollection
101-
- Scrubbing
102-
- Unoptimization
109+
Specifies an array of types of data deduplication jobs for which to return the job state. The
110+
acceptable values for this parameter are:
111+
112+
- `Optimization`
113+
- `GarbageCollection`
114+
- `Scrubbing`
115+
- `Unoptimization`
103116

104117
```yaml
105118
Type: Type[]
@@ -115,14 +128,14 @@ Accept wildcard characters: False
115128
```
116129

117130
### -Volume
118-
Specifies one or more file system volumes for which to return **DeduplicationJob** objects.
119-
Enter one or more volume IDs, drive letters, or volume GUID paths.
120-
For drive letters, use the format D:.
121-
For volume GUID paths, use the format \\\\?\Volume{{GUID}}\.
122-
Separate multiple volumes with a comma.
131+
132+
Specifies one or more file system volumes for which to return **DeduplicationJob** objects. Enter
133+
one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the format `D:`.
134+
For volume GUID paths, use the format `\\\\?\Volume{{GUID}}\`. Separate multiple volumes with a
135+
comma.
123136

124137
```yaml
125-
Type: String[]
138+
Type: System.String[]
126139
Parameter Sets: (All)
127140
Aliases: Path, Name
128141
@@ -134,7 +147,11 @@ Accept wildcard characters: False
134147
```
135148

136149
### CommonParameters
137-
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
150+
151+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
152+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
153+
-WarningAction, and -WarningVariable. For more information, see
154+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
138155

139156
## INPUTS
140157

@@ -145,12 +162,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable
145162
## OUTPUTS
146163

147164
### Microsoft.Management.Infrastructure.CimInstance
148-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
149-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
165+
166+
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
167+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
168+
namespace and class name for the underlying WMI object.
150169

151170
### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJob
152-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
153-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
171+
172+
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays
173+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
174+
namespace and class name for the underlying WMI object.
154175

155176
## NOTES
156177

0 commit comments

Comments
 (0)