Project

PSPublishModule

Build, test, version, sign, and publish PowerShell modules with reusable PowerForge pipelines.

View on GitHub Releases Get package
Stars 48
Forks 16
PowerShell Gallery downloads 17,213
Release v3.0.169
Language: C# Updated: 2026-10-13

API Reference

Command

Get-BenchmarkInput

Namespace PSPublishModule
Inputs
None
Outputs
System.String System.Int32 System.Boolean

Gets a caller-supplied benchmark input variable.

Remarks

Gets a caller-supplied benchmark input variable.

Examples

Authored help example

EXAMPLE 1


Get-BenchmarkInput -Name 'Name'

EXAMPLE 2


Get-BenchmarkInput -Bool

EXAMPLE 3


Get-BenchmarkInput -Int

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

Get-BenchmarkInput [-Default <Object>] -Name <String> [-Required] [<CommonParameters>]
#
Parameter set: Text

Parameters

Default Object optionalposition: 1pipeline: False
Default value used when the variable was not supplied.
Name String requiredposition: 0pipeline: False
Benchmark variable name.
Required SwitchParameter optionalposition: namedpipeline: False
Fail when the variable was not supplied or is empty.

Outputs

System.String, System.Int32, System.Boolean

Get-BenchmarkInput [-Default <Object>] -Int -Name <String> [-Required] [<CommonParameters>]
#
Parameter set: Int

Parameters

Default Object optionalposition: 1pipeline: False
Default value used when the variable was not supplied.
Int SwitchParameter requiredposition: namedpipeline: False
Return the benchmark variable as one or more integers.
Name String requiredposition: 0pipeline: False
Benchmark variable name.
Required SwitchParameter optionalposition: namedpipeline: False
Fail when the variable was not supplied or is empty.

Outputs

System.String, System.Int32, System.Boolean

Get-BenchmarkInput -Bool [-Default <Object>] -Name <String> [-Required] [<CommonParameters>]
#
Parameter set: Bool

Parameters

Bool SwitchParameter requiredposition: namedpipeline: False
Return the benchmark variable as a boolean.
Default Object optionalposition: 1pipeline: False
Default value used when the variable was not supplied.
Name String requiredposition: 0pipeline: False
Benchmark variable name.
Required SwitchParameter optionalposition: namedpipeline: False
Fail when the variable was not supplied or is empty.

Outputs

System.String, System.Int32, System.Boolean