Skip to content

Commit 626eae6

Browse files
Merge pull request MicrosoftDocs#3455 from RobBiddle/Remove-DedupSchedule.md#3433
Quality: PowerShell Summit Remove dedup schedule.md#3433
2 parents 26076e5 + 12e1ce7 commit 626eae6

File tree

1 file changed

+60
-35
lines changed

1 file changed

+60
-35
lines changed

docset/winserver2022-ps/deduplication/Remove-DedupSchedule.md

+60-35
Original file line numberDiff line numberDiff line change
@@ -16,45 +16,52 @@ Deletes a deduplication schedule.
1616
## SYNTAX
1717

1818
### Query (cdxml) (Default)
19+
1920
```
20-
Remove-DedupSchedule [-Name] <String[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>] [-AsJob]
21-
[-PassThru] [<CommonParameters>]
21+
Remove-DedupSchedule [-Name] <String[]> [-CimSession <CimSession[]>]
22+
[-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [<CommonParameters>]
2223
```
2324

2425
### InputObject (cdxml)
26+
2527
```
26-
Remove-DedupSchedule -InputObject <CimInstance[]> [-CimSession <CimSession[]>] [-ThrottleLimit <Int32>]
27-
[-AsJob] [-PassThru] [<CommonParameters>]
28+
Remove-DedupSchedule -InputObject <CimInstance[]> [-CimSession <CimSession[]>]
29+
[-ThrottleLimit <Int32>] [-AsJob] [-PassThru] [<CommonParameters>]
2830
```
2931

3032
## DESCRIPTION
31-
The **Remove-DedupSchedule** cmdlet deletes the specified **DeduplicationSchedule** object.
33+
34+
The `Remove-DedupSchedule` cmdlet deletes the specified **DeduplicationSchedule** object.
3235

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

3538
## EXAMPLES
3639

3740
### Example 1: Delete a schedule
38-
```
39-
PS C:\> Remove-DedupSchedule -Name "MyDailyOptimization"
41+
42+
```powershell
43+
Remove-DedupSchedule -Name "MyDailyOptimization"
4044
```
4145

42-
This command deletes the **DeduplicationJobSchedule** object named MyDailyOptimization.
46+
This command deletes the **DeduplicationJobSchedule** object named `MyDailyOptimization`.
4347

4448
## PARAMETERS
4549

4650
### -AsJob
47-
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
4851

49-
The cmdlet immediately returns an object that represents the job and then displays the command prompt.
50-
You can continue to work in the session while the job completes.
51-
To manage the job, use the `*-Job` cmdlets.
52-
To get the job results, use the [Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
52+
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to
53+
complete.
54+
55+
The cmdlet immediately returns an object that represents the job and then displays the command
56+
prompt. You can continue to work in the session while the job completes. To manage the job, use the
57+
`*-Job` cmdlets. To get the job results, use the
58+
[Receive-Job](https://go.microsoft.com/fwlink/?LinkID=113372) cmdlet.
5359

54-
For more information about Windows PowerShell background jobs, see [about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
60+
For more information about Windows PowerShell background jobs, see
61+
[about_Jobs](https://go.microsoft.com/fwlink/?LinkID=113251).
5562

5663
```yaml
57-
Type: SwitchParameter
64+
Type: System.Management.Automation.SwitchParameter
5865
Parameter Sets: (All)
5966
Aliases:
6067

@@ -66,12 +73,14 @@ Accept wildcard characters: False
6673
```
6774
6875
### -CimSession
69-
Runs the cmdlet in a remote session or on a remote computer.
70-
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.
71-
The default is the current session on the local computer.
76+
77+
Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session
78+
object, such as the output of a [New-CimSession](/powershell/module/cimcmdlets/new-cimsession) or
79+
[Get-CimSession](https://go.microsoft.com/fwlink/p/?LinkId=227966) cmdlet. The default is the
80+
current session on the local computer.
7281
7382
```yaml
74-
Type: CimSession[]
83+
Type: Microsoft.Management.Infrastructure.CimSession[]
7584
Parameter Sets: (All)
7685
Aliases: Session
7786

@@ -83,11 +92,12 @@ Accept wildcard characters: False
8392
```
8493
8594
### -InputObject
86-
Specifies the input to this cmdlet.
87-
You can use this parameter, or you can pipe the input to this cmdlet.
95+
96+
Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this
97+
cmdlet.
8898
8999
```yaml
90-
Type: CimInstance[]
100+
Type: Microsoft.Management.Infrastructure.CimInstance[]
91101
Parameter Sets: InputObject (cdxml)
92102
Aliases:
93103

@@ -99,10 +109,11 @@ Accept wildcard characters: False
99109
```
100110
101111
### -Name
112+
102113
Specifies the friendly name of one or more data deduplication job schedules to remove.
103114
104115
```yaml
105-
Type: String[]
116+
Type: System.String[]
106117
Parameter Sets: Query (cdxml)
107118
Aliases:
108119

@@ -114,10 +125,11 @@ Accept wildcard characters: False
114125
```
115126
116127
### -PassThru
128+
117129
Returns an object representing data deduplication settings to remove.
118130
119131
```yaml
120-
Type: SwitchParameter
132+
Type: System.Management.Automation.SwitchParameter
121133
Parameter Sets: (All)
122134
Aliases:
123135

@@ -129,12 +141,15 @@ Accept wildcard characters: False
129141
```
130142
131143
### -ThrottleLimit
132-
Specifies the maximum number of concurrent operations that can be established to run the cmdlet.
133-
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.
134-
The throttle limit applies only to the current cmdlet, not to the session or to the computer.
144+
145+
Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If
146+
this parameter is omitted or a value of `0` is entered, then Windows PowerShell® calculates an
147+
optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the
148+
computer. The throttle limit applies only to the current cmdlet, not to the session or to the
149+
computer.
135150

136151
```yaml
137-
Type: Int32
152+
Type: System.Int32
138153
Parameter Sets: (All)
139154
Aliases:
140155
@@ -146,25 +161,35 @@ Accept wildcard characters: False
146161
```
147162

148163
### CommonParameters
149-
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).
164+
165+
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
166+
-InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose,
167+
-WarningAction, and -WarningVariable. For more information, see
168+
[about_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).
150169

151170
## INPUTS
152171

153172
### System.String[]
154173

155174
### Microsoft.Management.Infrastructure.CimInstance
156-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
157-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
175+
176+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
177+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
178+
namespace and class name for the underlying WMI object.
158179

159180
## OUTPUTS
160181

161182
### Microsoft.Management.Infrastructure.CimInstance
162-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
163-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
183+
184+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
185+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
186+
namespace and class name for the underlying WMI object.
164187

165188
### Microsoft.Management.Infrastructure.CimInstance#ROOT/Microsoft/Windows/Deduplication/MSFT_DedupJobSchedule
166-
The `Microsoft.Management.Infrastructure.CimInstance` object is a wrapper class that displays Windows Management Instrumentation (WMI) objects.
167-
The path after the pound sign (`#`) provides the namespace and class name for the underlying WMI object.
189+
190+
The **Microsoft.Management.Infrastructure.CimInstance** object is a wrapper class that displays
191+
Windows Management Instrumentation (WMI) objects. The path after the pound sign (`#`) provides the
192+
namespace and class name for the underlying WMI object.
168193

169194
## NOTES
170195

0 commit comments

Comments
 (0)