PowerShell函数参数即可选又必选


关键词

PowerShell函数 参数集 可选必选

摘要

本文介绍PowerShell自定义函数中使用参数集时,可以将同一个参数既设置为可选,又设置为必选。

好吧,洪哥承认,这个话题有点无聊,但确实还是有点有趣,不妨看一看啦。

在PowerShell中,我们有可能有这样的需求,如果只需要输入某个参数时,这个参数是可选的。但如果还要输入别的参数,那这个参数就变成必选的了。那么这种需求如何来满足呢?那就是本文的意义所在了。

function Connect-Somewhere
{
    [CmdletBinding(DefaultParameterSetName=’A’)]
    param
    (
        [Parameter(ParameterSetName=’A’,Mandatory=$false)]
        [Parameter(ParameterSetName=’B’,Mandatory=$true)]
        $ComputerName,
        [Parameter(ParameterSetName=’B’,Mandatory=$false)]
        $Credential
    )
    $chosen = $PSCmdlet.ParameterSetName
    “You have chosen $chosen parameter set.”
}

读了上面这个函数,有没有什么疑惑?上面这个PowerShell函数定义了两个参数集,一个参数集名为A,另一个名为B。参数集A只有一个参数$ComputerName,且它是可选的。而参数集B有两个参数$ComputerName和$Credential。如果我们使用参数集A时,输入不需要输入ComputerName这个参数,因为它不是必选的。而如果我们使用参数集B,这个时候就必须要填$ComputerName了。

且看下面的函数调用示例。

PS> Connect-Somewhere
You have chosen A parameter set.
PS> Connect-Somewhere -ComputerName test
You have chosen A parameter set.
PS> Connect-Somewhere -Credential user1
cmdlet Connect-Somewhere at command pipeline position 1
Supply values for the following parameters:
ComputerName: NOWMANDATORY!
You have chosen B parameter set.

第一个调用Case是使用默认参数集,函数中默认参数集是参数集A,参数集A只有一个参数$ComputerName,且是可选的,所以什么都不输入是可以的。
第二个调用Case是使用了一个ComputerName参数,符合参数集A的条件,自动匹配为参数集A了。
第三个调用Case只使用了一个Credential参数,这个参数是出现在参数集B中的。但如果使用参数集B,那必须填ComputerName参数,所以就报错了。

关于PowerShell函数参数即可选又必选,本文就介绍这么多,希望对您有所帮助,谢谢!

 

文章的版权

洪哥写文章很苦逼,如果本文对您略有帮助,点击感兴趣的广告支持洪哥!万分感谢!本文属于“洪哥笔记”原创文章,转载请注明来源地址:PowerShell函数参数即可选又必选:http://www.splaybow.com/post/powershell-parameter-mandatory-optional.html

关注与收藏

如果您在服务器运维、网络管理、网站或系统开发过程中有任何疑问,洪哥以此为饭碗,请加QQ:115085382!
了解更多好文章,请关注我们的新浪微博和腾讯微博
亲,先存起来,方便以后再看啊!加入收藏夹的话,按Ctrl+D


« PowerShell函数参数集自动识别参数数据类型 PowerShell函数限制数组参数个数 »