PowerShell同时处理管道与命令行输入的异常检测及实现问询

问题 #

我在PowerShell 7.3中测试如下脚本：

[CmdletBinding()]
param ( 
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [string]$ComputerName,
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [string]$DomainName,
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [pscredential]$Credential,
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [string]$IPv4Address,
    [string]$userName,
    [string]$log
)
Process {
    "***"
    "ComputerName:$ComputerName"
    "DomainName:$DomainName"
    if ($Credential) { "Credential:" + $Credential.username }else { "No credential" }
    "IP Address:$IPv4Address"
    "User name:$UserName"
}

单独通过管道输入对象、单独指定命令行参数，或指定部分支持管道的参数并结合管道输入时，脚本均正常运行，且命令行参数会覆盖管道对象的对应属性。但当同时指定全部4个支持管道的参数并结合管道输入时，每次执行Process块都会报错：

"Remove-RemoteUser: The input object cannot be bound to any parameters for the command either because the command does not take pipeline input or the input and its properties do not match any of the parameters that take pipeline input."

需求：

1. 在脚本内检测该异常情况，提前终止并给出友好提示
2. 实现让命令行参数等效为管道输入对象进行处理

解决方案 #

一、检测异常并提前终止 #

问题根源是：当所有支持ValueFromPipelineByPropertyName的参数都通过命令行显式指定后，PowerShell会尝试将管道输入对象绑定到剩余的非管道参数，但这些参数不支持管道输入，导致绑定失败。

可以在脚本的begin块中添加检测逻辑：

[CmdletBinding()]
param ( 
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [string]$ComputerName,
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [string]$DomainName,
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [pscredential]$Credential,
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [string]$IPv4Address,
    [string]$userName,
    [string]$log
)

begin {
    # 判断是否有管道输入
    $hasPipeInput = $MyInvocation.ExpectingInput
    # 判断所有支持管道的参数是否都已通过命令行指定
    $allPipeParamsSet = (-not [string]::IsNullOrEmpty($ComputerName)) -and 
                       (-not [string]::IsNullOrEmpty($DomainName)) -and 
                       ($null -ne $Credential) -and 
                       (-not [string]::IsNullOrEmpty($IPv4Address))

    if ($hasPipeInput -and $allPipeParamsSet) {
        Write-Error "错误：请勿同时通过命令行指定全部4个支持管道的参数并结合管道输入。请选择单一参数传递方式，或仅指定部分管道参数。" -ErrorAction Stop
    }
}

Process {
    "***"
    "ComputerName:$ComputerName"
    "DomainName:$DomainName"
    if ($Credential) { "Credential:" + $Credential.username }else { "No credential" }
    "IP Address:$IPv4Address"
    "User name:$UserName"
}

核心逻辑是通过$MyInvocation.ExpectingInput识别管道输入，再检查所有管道参数是否已显式赋值，两者同时满足则抛出错误终止执行。

二、将命令行参数转为等效管道输入处理 #

如果希望命令行参数的处理逻辑和管道输入完全一致，可以将显式指定的参数封装成对象，再通过管道传递给自己：

[CmdletBinding()]
param ( 
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [string]$ComputerName,
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [string]$DomainName,
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [pscredential]$Credential,
    [parameter(ValueFromPipelineByPropertyName = $true)]
    [string]$IPv4Address,
    [string]$userName,
    [string]$log
)

begin {
    $hasPipeInput = $MyInvocation.ExpectingInput
    # 判断是否有命令行指定的管道参数
    $hasPipeParamsSet = (-not [string]::IsNullOrEmpty($ComputerName)) -or 
                       (-not [string]::IsNullOrEmpty($DomainName)) -or 
                       ($null -ne $Credential) -or 
                       (-not [string]::IsNullOrEmpty($IPv4Address))

    if (-not $hasPipeInput -and $hasPipeParamsSet) {
        # 创建等效的管道输入对象
        $inputObj = [PSCustomObject]@{
            ComputerName = $ComputerName
            DomainName   = $DomainName
            Credential   = $Credential
            IPv4Address  = $IPv4Address
            userName     = $userName
            log          = $log
        }
        # 清空原参数避免重复处理，再通过管道调用当前脚本
        $PSBoundParameters.Clear()
        $inputObj | & $MyInvocation.MyCommand @PSBoundParameters
        return
    }
}

Process {
    "***"
    "ComputerName:$ComputerName"
    "DomainName:$DomainName"
    if ($Credential) { "Credential:" + $Credential.username }else { "No credential" }
    "IP Address:$IPv4Address"
    "User name:$UserName"
}

这个方案的核心是：当无管道输入但指定了管道参数时，将参数打包成自定义对象，通过管道调用当前脚本，让参数绑定逻辑和管道输入完全一致。

内容的提问来源于stack exchange，提问作者Roman