PowerShell 函数和参数集

PowerShell 函数可以具有不同的参数，具体取决于其调用方式。这称为参数集。例如，Get-Process 有一个名为 Name 的非强制参数，它指定要按名称获取哪些进程。但它还有一个名为 ID 的参数，它也指定要获取哪些进程，这次是通过 ID。这两个参数都存在但互斥，不能同时使用它们，因为它们是在两个不同的参数集中定义的。

首先一些基础知识

参数集在参数的[Parameter()] 块中定义。

例如：

function Test-MultiParamSets {
param(
[Parameter(ParameterSetName = 'Name')]
[string]$Name,

[Parameter(ParameterSetName = 'ID')]
[int]$ID
)
$PSCmdlet.ParameterSetName
}

这定义了一个具有两个参数集（Name 和 ID）的函数。参数集名称有一个称为“名称”的参数，参数集 ID 有一个称为“ID”的参数。这意味着这些参数不能同时使用。

该函数本身只会将当前集的名称写入管道。这是通过自动变量 $PSCmdlet 上的属性 ParameterSetName 访问的。

有几种方法可以研究命令并查看哪些参数集可用。最简单的方法是使用参数 - 调用 Get-Command，语法如下：

这显示了可以使用的每个参数集。第一组有一个非强制命名参数 Name，第二组有一个非强制命名参数 ID。

只要指定了其中一个参数，一切都很好，但是如果我们尝试在不指定任何参数的情况下运行该命令，我们将收到一条错误消息：

无法使用指定的命名参数解析参数集。

这意味着 PowerShell 不知道要使用哪个参数集并引发错误。

有两种方法可以解决这个问题。我们可以将一个参数设置为强制，并且仅将其中一个参数设置为强制。如果 Name 是强制的并且在不带参数的情况下调用该函数，PowerShell 将假定该集是 ID，因为这是唯一一个没有任何强制参数的集。

但还有更好的方法！通过将一个参数集设置为默认值，PowerShell 将知道在多个匹配时使用哪一个。只需添加以下内容即可完成此操作：

[CmdletBinding(DefaultParameterSetName = 'Name')]

多组中的一个参数

好吧，到目前为止事情都相当简单。如果我希望一个参数成为多个集合的成员怎么办？

然后给它多个 [Parameter()] 块！

假设我希望能够仅使用名称或同时使用 ID 和名称来调用该函数，但名称应该仅在第一种情况下是强制的。

这是一个新的例子：

function Test-MultiParamSets {
[CmdletBinding(DefaultParameterSetName = 'Name')]
param(
[Parameter(ParameterSetName = 'Name', Mandatory = $true)]
[Parameter(ParameterSetName = 'ID')]
[String]$Name,

[Parameter(ParameterSetName = 'ID')]
[int]$ID
)
$PSCmdlet.ParameterSetName
}

现在，如果我只运行不带参数的 Test-MultiParamSets，PowerShell 将使用我指定的默认集“名称”，并提示我输入名称，因为它是强制性的。

另一方面，如果我使用参数 ID 运行 Test-MultiParamSets，则不会提示我输入名称，因为在此参数集中它不是强制性的。

再次运行 Get-Command -Syntax 现在将显示以下内容：

我们可以清楚地看到参数Name仅在第一组中是必需的。

你还醒着吗？太棒了！那么，让我们向兔子洞进一步冲刺吧！

使用所有参数集

现在我开始对我的功能相当满意，但是在经常使用它之后，我厌倦了总是输入 -Name，我希望参数 Name 始终具有位置 0，这意味着第一个未命名参数值将始终属于参数 Name (只要该参数尚未使用 -Name 分配值）。

一种方法是添加一个新的参数块，其中 Position=0。由于该块中没有任何 ParameterSetName，因此它将应用于所有集合。

这是示例代码，这次再次更新：

function Test-MultiParamSets {
[CmdletBinding(DefaultParameterSetName = 'Name')]
param(
[Parameter(ParameterSetName = 'Name', Mandatory = $true)]
[Parameter(ParameterSetName = 'ID')]
[Parameter(Position = 0)]
[String]$Name,

[Parameter(ParameterSetName = 'ID')]
[int]
$ID
)
'Set name is:{0}' -f $PSCmdlet.ParameterSetName
'Name is: [{0}], ID is [{1}]' -f $Name, $ID
}

现在我可以运行 Test-MultiParamSets，它将接受 Name 作为位置参数。为了更清楚哪个参数具有哪个值，该函数现在还打印每个参数的值。

让我们回过头来看看 Get-Command 的语法：

这是事情变得有点混乱的时候。 Get-Command 仍将参数名称显示为已命名，而不是位置！

这里需要注意的是，我的第三个参数块中的属性实际上没有添加到任何参数集中，而是添加到一个名为 __AllParameterSets 的新集合中。

要查看这一点，我们可以使用从 Get-Command 返回的对象。它有一个名为“Parameters”的属性，它是一个哈希表，每个参数都有一个键。如果我们只看参数Name和ID（该函数还有一堆公共参数）：

这表明参数名称是三个参数集的一部分，尽管 Get-Command -Syntax 仅显示了两个参数集。

参数集 __AllParameterSets 是一个隐藏参数集，其属性将与所有其他集合并。我的经验是，如果在命名的 ParameterSet 中设置了属性，则该属性获胜，否则使用 __AllParameterSets 中的属性。 **但是，将属性设置为 $false 会被视为未设置，这意味着如果 __AllParameterSets 中的 Mandatory 为 True，并且集合名称和 ID 中的 Mandatory 为 True，则 True 获胜。

截图总结一下：

这里请注意，参数名称在名称（绿色）和 ID（红色）集合中命名（位置未设置），但在 __AllParameterSets 中命名为位置，这意味着 __AllParameterSets 获胜并且参数是位置的。

使用 Get-Command -Syntax 时，不会显示应用于 __AllParameterSets 参数集的任何属性。名称在上图中显示为两组的命名参数。

解决方法

为了使 Get-Command 显示正确的语法，不要使用 __AllParameterSets，养成将集合中所需的每个属性添加到该集合中的习惯，即使您必须多次添加它。我还发现这种方式代码更具可读性。

这是代码，按照我认为应该是最佳实践的方式编写：

function Test-MultiParamSets {
[CmdletBinding(DefaultParameterSetName = 'Name')]
param(
[Parameter(ParameterSetName = 'Name', Mandatory = $true, Position = 0)]
[Parameter(ParameterSetName = 'ID', Position = 0)]
[String]
$Name,

[Parameter(
ParameterSetName = 'ID'
)]
[int]
$ID
)
'Set name is:{0}' -f $PSCmdlet.ParameterSetName
'Name is: [{0}], ID is [{1}]' -f $Name, $ID
}

现在每个集合都有属性 Position=0

再次运行 Get-Command -Syntax 将显示正确的语法：

如果您读到这里，谢谢！请发表评论。