Powershell cmdlet 的嵌套参数

Question

新手问题。

如何为 Powershell cmdlet 声明嵌套参数？我想要一个看起来像这样的 cmdlet。

New-FootballTeam 
[-Defenders [[-LeftBack] <string>] [[-RightBack] <string>] ]
[-Midfielders [[-LeftWing] <string>] [[-RightWing] <string>] [[-CentreMidfield] <string>] ] 

我尝试使用ParameterSetName 参数将Defenders 和Midfielders 下的参数组合在一起。但是当我执行help New-FootballTeam 时，Defenders 和 Midfielders 标记不会出现，我会看到类似这样的内容。

New-FootballTeam 
[[-LeftBack] <string>] [[-RightBack] <string>]
[[-LeftWing] <string>] [[-RightWing] <string>] [[-CentreMidfield] <string>] 

谢谢，提前。

Answer 1

PowerShell 不支持您所描述的参数嵌套。 PowerShell 支持多个参数集，允许您指定对特定命令调用有效的不同“集”参数。 ParameterSets（除了内部的 AllParametersSet - 没有分配参数集的参数被放置）是互斥的。通常每个参数集都有一个唯一的参数，PowerShell 使用该参数来选择用于参数解析的特定参数集 - 这是互斥位。如果 PowerShell 无法确定使用哪个参数集，它将发出错误。在某些情况下，您可以通过使用[CmdletBinding(DefaultParameterSet="<defaultParameterSetName>")] 来帮助 PowerShell，告诉 PowerShell 在无法根据提供的参数和参数确定时使用哪个参数集。

Answer 2

有一个简洁的 powershell 功能称为动态参数，您可以使用它来解决这个问题。虽然有点啰嗦：

Function New-FootballTeam {
    [CmdletBinding()]
    Param(
        [Switch]$Defenders,
        [Switch]$Midfielders
    )

    DynamicParam {
        $dynamicParameters = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary
        $toAdd = @()

        if ($Defenders) {
            $toAdd += @('LeftBack', 'RightBack')
        }

        if ($Midfielders) {
            $toAdd += @('LeftWing', 'RightWing')
        }

        $toAdd | % {
            $attr = New-Object System.Management.Automation.ParameterAttribute
            $attr.ParameterSetName = "__AllParameterSets"
            $attr.Mandatory = $True

            $attributes = New-Object System.Collections.ObjectModel.Collection[System.Attribute]
            $attributes.Add($attr)

            $param = New-Object System.Management.Automation.RuntimeDefinedParameter(
                $_,
                'string',
                $attributes
            )

            $dynamicParameters.Add($_, $param)
        }

        return $dynamicParameters
    }

    Begin {
        $LeftBack  = $PSBoundParameters.LeftBack
        $RightBack = $PSBoundParameters.RightBack
        $LeftWing  = $PSBoundParameters.LeftWing
        $RightWing = $PSBoundParameters.RightWing
    }

    End {
        if ($Defenders) {
            Write-Host "LeftBack : $LeftBack"
            Write-Host "RightBack: $RightBack"
        }
        if ($Midfielders) {
            Write-Host "LeftWing : $LeftWing"
            Write-Host "RightWing: $RightWing"
        }
    }

}

但是，此解决方案有一些注意事项 - 使用 Get-Help 时不会列出动态参数，而 Intellisense 有时也可以使用它们。但它确实有效，并且由于示例中的参数设置为强制，当设置了后卫/中场开关时，PS 会提示您输入所需的侧翼/后卫。

Answer 3

像这样定义你的参数：

function New-FootballTeam {

    param(
    [Parameter(Mandatory = $true, ParameterSetName = "Defenders")]
    [switch]$Defenders,
    [Parameter(ParameterSetName = "Defenders", Position = 0)]
    [string]$LeftBack,
    [Parameter(ParameterSetName = "Defenders", Position = 1)]
    [string]$RightBack,
    [Parameter(Mandatory = $true, ParameterSetName = "Midfielders")]
    [switch]$Midfielders,
    [Parameter(ParameterSetName = "Midfielders", Position = 0)]
    [string]$LeftWing,
    [Parameter(ParameterSetName = "Midfielders", Position = 1)]
    [string]$RightWing,
    [Parameter(ParameterSetName = "Midfielders", Position = 2)]
    [string]$CentreMidfield
    )

}

会给你想要的东西：

NAME  
    New-FootballTeam

SYNTAX
    New-FootballTeam [[-LeftBack] <string>] [[-RightBack] <string>] -Defenders  [<CommonParameters>]

    New-FootballTeam [[-LeftWing] <string>] [[-RightWing] <string>] [[-CentreMidfield] <string>] -Midfielders  [<CommonParameters>]

虽然我不太确定这个示例中的参数集或参数 Defenders 和 Midfielders 的意义。您可以通过参数名称准确地说明您的意思。将所有位置作为参数放在一个集合中会更简单。