Skip to main content
Version: v6

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>]

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 Get-Date | Should-NotHaveParameter Uri

This assertion passes, because Get-Date has no -Uri parameter.

EXAMPLE 2​

function Get-PublicReport {
    param([string] $Name)
}

Get-Command Get-PublicReport | Should-NotHaveParameter Credential

This assertion passes, because Get-PublicReport does not expose a -Credential parameter. This is useful for guarding against accidentally adding parameters you want to keep off a command's public surface.

PARAMETERS​

-Actual​

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

Type: System.Object
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Because​

The reason why the input should be the expected value.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 2
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ParameterName​

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

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters​

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

INPUTS​

System.Object​

OUTPUTS​

NOTES​

Use the -ErrorAction parameter to control soft-assertion behavior for this assertion. -ErrorAction Continue records the failure and lets the rest of the test run (a soft assertion), while -ErrorAction Stop fails the test immediately, for example to guard a precondition before continuing.

When -ErrorAction is not specified, the behavior comes from Should.ErrorAction in the configuration, which defaults to Stop. See https://pester.dev/docs/assertions/soft-assertions for more about soft assertions.

VERSION​

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