Powershell mutex parameters use instances

Powershell mutex parameters use instances

This article mainly introduces how to use Powershell mutex parameters. This article provides two sample codes to illustrate how to use mutex parameters. For more information, see

Sometimes Powershell functions need to be mutually exclusive, so that users can only select either of them.

To create a set of mutually exclusive parameters for the script, you can mark them with different attributes and ensure their uniqueness (assuming that the parameter type cannot be automatically recognized ).

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

Function Test-ParameterSet { [CmdletBinding (defaparameparametersetname = 'number')] Param ( [Int] [Parameter (ParameterSetName = 'number', Position = 0)] $ Id,   [String] [Parameter (ParameterSetName = 'text', Position = 0)] $ Name )   $ PSCmdlet. ParameterSetName $ PSBoundParameters }

The preceding function has two parameters:-id and-name. You can use only one of them, and neither of them can be used. The example also shows how to obtain user input parameters.

Multiple mutex parameters can be distinguished by "ParameterSetName" (including set parameters)

In fact, you can also assign multiple parameters and one parameter, that is, a fixed parameter and an optional parameter.

?

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 Test-ParameterSet function tells you that-ComputerName is optional when "NonCredential" is used. When you use the "-Credential" parameter, "-ComputerName" becomes a required parameter, if the "-LocalAction" parameter is used,-ComputerName and-Credential cannot be used.