PowerShell implementation parameter mutex example
To make parameters mutually exclusive in PowerShell functions, you can use the "ParameterSetName" attribute to define a parameter attribute in different parameters or parameter sets.
Many people may not pay attention to it. In PowerShell functions, we can define multiple parameter attributes on the same parameter name, in this way, mandatory can make a parameter mandatory in a specific scenario, and optional in another scenario.
?
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26 |
Function Test-ParameterSet
{
[CmdletBinding (defaparameparametersetname = 'noncredential')]
Param
(
$ Id,
[Parameter (ParameterSetName = 'localonly', Mandatory = $ false)]
$ LocalAction,
[Parameter (ParameterSetName = 'credential', Mandatory = $ true)]
[Parameter (ParameterSetName = 'noncredential', Mandatory = $ false)]
$ ComputerName,
[Parameter (ParameterSetName = 'credential', Mandatory = $ false)]
$ Credential
)
$ PSCmdlet. ParameterSetName
$ PSBoundParameters
If ($ PSBoundParameters. ContainsKey ('computername '))
{
Write-Warning 'remote call'
}
}
|
The preceding function Test-ParameterSet demonstrates that-ComputerName is an optional parameter when the parameter "NonCredential" is activated. When you use the-Credential parameter,-ComputerName becomes a mandatory parameter. After you use the-LocalAction parameter, both-ComputerName and-Credential are dispensable.