AvoidDefaultValueForMandatoryParameter.md

description	ms.custom	ms.date	ms.topic	title
Avoid Default Value For Mandatory Parameter	PSSA v1.22.0	06/28/2023	reference	AvoidDefaultValueForMandatoryParameter

AvoidDefaultValueForMandatoryParameter

Severity Level: Warning

Description

Mandatory parameters should not have a default values because there is no scenario where the default can be used. PowerShell prompts for a value if the parameter value is not specified when calling the function.

Example

Wrong

function Test
{

    [CmdletBinding()]
    Param
    (
        [Parameter(Mandatory=$true)]
        $Parameter1 = 'default Value'
    )
}

Correct

function Test
{
    [CmdletBinding()]
    Param
    (
        [Parameter(Mandatory=$true)]
        $Parameter1
    )
}