Should-NotHaveParameter

This page was generated

Contributions are welcome in Pester-repo.

SYNOPSIS

Asserts that a command has does not have the parameter.

SYNTAX

Should-NotHaveParameter [[-ParameterName] <String>] [[-Actual] <Object>] [[-Because] <String>]
 [<CommonParameters>]

DESCRIPTION

This assertion inspects command metadata to verify that a parameter is absent. It only checks the parameter name, unlike Should-HaveParameter, which can also validate parameter details.

EXAMPLES

EXAMPLE 1

Get-Command "Invoke-WebRequest" | Should -NotHaveParameter Uri

This test fails, because it expected the parameter URI to not exist.

PARAMETERS

-ParameterName

The name of the parameter to check. E.g. Uri

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Actual

The actual command to check. E.g. Get-Command "Invoke-WebRequest"

Type: Object
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Because

The reason why the input should be the expected value.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES

The attribute [ArgumentCompleter] was added with PSv5. Previously this assertion will not be able to use the -HasArgumentCompleter parameter if the attribute does not exist.

RELATED LINKS

https://pester.dev/docs/commands/Should-NotHaveParameter

https://pester.dev/docs/assertions

VERSION

This page was generated using comment-based help in Pester 6.0.0-alpha5.