UseShouldProcessForStateChangingFunctions.md

description	Use ShouldProcess For State Changing Functions
ms.custom	PSSA v1.21.0
ms.date	06/28/2023
ms.topic	reference
title	UseShouldProcessForStateChangingFunctions

UseShouldProcessForStateChangingFunctions

Severity Level: Warning

Description

Functions whose verbs change system state should support ShouldProcess.

Verbs that should support ShouldProcess:

• New
• Set
• Remove
• Start
• Stop
• Restart
• Reset
• Update

How

Include the SupportsShouldProcess argument in the CmdletBinding attribute.

Example

Wrong

function Set-ServiceObject
{
    [CmdletBinding()]
    param
    (
        [string]
        $Parameter1
    )
    ...
}

Correct

function Set-ServiceObject
{
    [CmdletBinding(SupportsShouldProcess = $true)]
    param
    (
        [string]
        $Parameter1
    )
    ...
}