Skip to content

AvoidDefaultValueForMandatoryParameter.md

Latest commit

 

History

History
47 lines (38 loc) · 805 Bytes

AvoidDefaultValueForMandatoryParameter.md

File metadata and controls

47 lines (38 loc) · 805 Bytes
description Avoid Default Value For Mandatory Parameter
ms.custom PSSA v1.21.0
ms.date 06/28/2023
ms.topic reference
title 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
    )
}