Pattern: Missing ShouldProcess
for state changing function
Issue: -
Functions whose verbs change system state should support ShouldProcess
.
Verbs that should support ShouldProcess
:
New
Set
Remove
Start
Stop
Restart
Reset
Update
Include the SupportsShouldProcess
argument in the CmdletBinding
attribute.
Example of incorrect code:
function Set-ServiceObject
{
[CmdletBinding()]
param
(
[string]
$Parameter1
)
...
}
Example of correct code:
function Set-ServiceObject
{
[CmdletBinding(SupportsShouldProcess = $true)]
param
(
[string]
$Parameter1
)
...
}