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
)
}
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for