@@ -16,51 +16,59 @@ Cancels one or more specified data deduplication jobs.
1616## SYNTAX
1717
1818### ByVolume (Default)
19+
1920```
20- Stop-DedupJob [-Volume] <String[]> [[-Type] <Type[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
21- [-AsJob] [-PassThru] [<CommonParameters>]
21+ Stop-DedupJob [-Volume] <String[]> [[-Type] <Type[]>] [-CimSession <CimSession[]>]
22+ [-ThrottleLimit <Int32>] [- AsJob] [-PassThru] [<CommonParameters>]
2223```
2324
2425### ById
26+
2527```
26- Stop-DedupJob [-Id <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob] [-PassThru]
27- [<CommonParameters>]
28+ Stop-DedupJob [-Id <String[]>] [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
29+ [-AsJob] [-PassThru] [ <CommonParameters>]
2830```
2931
3032### InputObject (cdxml)
33+
3134```
32- Stop-DedupJob -InputObject <CimInstance[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
33- [-PassThru] [<CommonParameters>]
35+ Stop-DedupJob -InputObject <CimInstance[]> [-CimSession <CimSession[]>]
36+ [-ThrottleLimit <Int32>] [-AsJob] [- PassThru] [<CommonParameters>]
3437```
3538
3639## DESCRIPTION
37- The ** Stop-DedupJob** cmdlet cancels one or more specified data deduplication jobs.
40+
41+ The ` Stop-DedupJob ` cmdlet cancels one or more specified data deduplication jobs.
3842
3943To run this cmdlet, you must start Windows PowerShell® with the ** Run as administrator** option.
4044
4145## EXAMPLES
4246
4347### Example 1: Stop jobs on a specified volume
44- ```
45- PS C:\> Stop-DedupJob -Volume "D:"
48+
49+ ``` powershell
50+ Stop-DedupJob -Volume "D:"
4651```
4752
48- This command stops the deduplication jobs on the D: volume.
53+ This command stops the deduplication jobs on the ` D: ` volume.
4954
5055## PARAMETERS
5156
5257### -AsJob
53- Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
5458
55- The cmdlet immediately returns an object that represents the job and then displays the command prompt.
56- You can continue to work in the session while the job completes.
57- To manage the job, use the ` *-Job ` cmdlets.
58- To get the job results, use the [ Receive-Job] ( https://go.microsoft.com/fwlink/?LinkID=113372 ) cmdlet.
59+ Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
60+ complete.
5961
60- For more information about Windows PowerShell background jobs, see [ about_Jobs] ( https://go.microsoft.com/fwlink/?LinkID=113251 ) .
62+ The cmdlet immediately returns an object that represents the job and then displays the command
63+ prompt. You can continue to work in the session while the job completes. To manage the job, use the
64+ ` *-Job ` cmdlets. To get the job results, use the
65+ [ Receive-Job] ( https://go.microsoft.com/fwlink/?LinkID=113372 ) cmdlet.
66+
67+ For more information about Windows PowerShell background jobs, see
68+ [ about_Jobs] ( https://go.microsoft.com/fwlink/?LinkID=113251 ) .
6169
6270``` yaml
63- Type : SwitchParameter
71+ Type : System.Management.Automation. SwitchParameter
6472Parameter Sets : (All)
6573Aliases :
6674
@@ -72,12 +80,14 @@ Accept wildcard characters: False
7280` ` `
7381
7482### -CimSession
75- Runs the cmdlet in a remote session or on a remote computer.
76- 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.
77- The default is the current session on the local computer.
83+
84+ Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
85+ object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
86+ [Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
87+ current session on the local computer.
7888
7989` ` ` yaml
80- Type : CimSession[]
90+ Type : Microsoft.Management.Infrastructure. CimSession[]
8191Parameter Sets : (All)
8292Aliases : Session
8393
@@ -89,11 +99,11 @@ Accept wildcard characters: False
8999` ` `
90100
91101### -Id
92- Identifies the job to cancel.
93- To obtain this ID, run the ** Get-DedupJob** cmdlet.
102+
103+ Identifies the job to cancel. To obtain this ID, run the ` Get-DedupJob` cmdlet.
94104
95105` ` ` yaml
96- Type : String[]
106+ Type: System. String[]
97107Parameter Sets: ById
98108Aliases:
99109
@@ -105,11 +115,12 @@ Accept wildcard characters: False
105115` ` `
106116
107117# ## -InputObject
108- Specifies the input to this cmdlet.
109- You can use this parameter, or you can pipe the input to this cmdlet.
118+
119+ Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this
120+ cmdlet.
110121
111122` ` ` yaml
112- Type : CimInstance[]
123+ Type: Microsoft.Management.Infrastructure. CimInstance[]
113124Parameter Sets: InputObject (cdxml)
114125Aliases:
115126
@@ -121,10 +132,11 @@ Accept wildcard characters: False
121132` ` `
122133
123134# ## -PassThru
135+
124136Returns an object representing data deduplication settings to stop.
125137
126138` ` ` yaml
127- Type : SwitchParameter
139+ Type: System.Management.Automation. SwitchParameter
128140Parameter Sets: (All)
129141Aliases:
130142
@@ -136,12 +148,15 @@ Accept wildcard characters: False
136148` ` `
137149
138150# ## -ThrottleLimit
139- Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
140- 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.
141- The throttle limit applies only to the current cmdlet, not to the session or to the computer.
151+
152+ Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
153+ this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
154+ optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
155+ computer. The throttle limit applies only to the current cmdlet, not to the session or to the
156+ computer.
142157
143158` ` ` yaml
144- Type: Int32
159+ Type: System. Int32
145160Parameter Sets: (All)
146161Aliases:
147162
@@ -153,13 +168,14 @@ Accept wildcard characters: False
153168` ` `
154169
155170# ## -Type
156- Specifies an array of types of data deduplication jobs schedules for which to return **DeduplicationJobSchedule** objects.
157- The acceptable values for this parameter are :
158171
159- - Optimization
160- - GarbageCollection
161- - Scrubbing
162- - Unoptimization
172+ Specifies an array of types of data deduplication jobs schedules for which to return
173+ **DeduplicationJobSchedule** objects. The acceptable values for this parameter are:
174+
175+ - ` Optimization`
176+ - ` GarbageCollection`
177+ - ` Scrubbing`
178+ - ` Unoptimization`
163179
164180` ` ` yaml
165181Type: Type[]
@@ -175,14 +191,14 @@ Accept wildcard characters: False
175191` ` `
176192
177193# ## -Volume
178- Specifies one or more file system volumes on which to cancel one or more named data deduplication jobs.
179- Enter one or more volume IDs, drive letters, or volume GUID paths.
180- For drive letters, use the format D:.
181- For volume GUID paths, use the format \\\\ ?\Volume{{GUID}}\.
182- Separate multiple volumes with a comma.
194+
195+ Specifies one or more file system volumes on which to cancel one or more named data deduplication
196+ jobs. Enter one or more volume IDs, drive letters, or volume GUID paths. For drive letters, use the
197+ format `D:`. For volume GUID paths, use the format `\\ ?\Volume{{GUID}}\`. Separate multiple
198+ volumes with a comma.
183199
184200` ` ` yaml
185- Type: String[]
201+ Type: System. String[]
186202Parameter Sets: ByVolume
187203Aliases: Path, Name, DeviceId
188204
@@ -194,27 +210,37 @@ Accept wildcard characters: False
194210` ` `
195211
196212# ## CommonParameters
197- 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).
213+
214+ This cmdlet supports the common parameters : -Debug, -ErrorAction, -ErrorVariable,
215+ -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
216+ -WarningAction, and -WarningVariable. For more information, see
217+ [about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
198218
199219# # INPUTS
200220
201221# ## System.String[]
202222
203223# ## Microsoft.Management.Infrastructure.CimInstance
204- The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
205- The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
224+
225+ The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
226+ Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
227+ namespace and class name for the underlying WMI object.
206228
207229# ## Microsoft.PowerShell.Cmdletization.GeneratedTypes.DedupJob.Type[]
208230
209231# # OUTPUTS
210232
211233# ## Microsoft.Management.Infrastructure.CimInstance
212- The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
213- The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
234+
235+ The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
236+ Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
237+ namespace and class name for the underlying WMI object.
214238
215239# ## Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJob
216- The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
217- The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
240+
241+ The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
242+ Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
243+ namespace and class name for the underlying WMI object.
218244
219245# # NOTES
220246
0 commit comments