powershell v7 - 功能管道问题

Question

我正在尝试编写 2 个函数：

• 第一个 (Get-Lab) 检索 [Lab] 对象
• 第二个（remove-Lab）删除一个 [Lab] 对象

[Lab] 是我的模块中定义的一个类。

当运行 Get-Lab 时，我使用正确的类型正确检索了我的实验室实例：

当我运行 Remove-Lab -Lab (Get-Lab -Name Mylab) 时，操作正确执行：

但是当我尝试通过管道传递 [Lab] 对象时它失败了。

函数没有通过管道接收对象。但是，我使用 ValueFromPipeline=$true 将 -Lab 参数设置为强制。

Function Remove-Lab{
[CmdletBinding(DefaultParameterSetName='Lab')]
param (
    [Parameter(ValueFromPipeline=$true,ParameterSetName='Lab',Position=0,Mandatory=$true)]
    [Lab]
    $Lab,
    
    # Parameter help description
    [Parameter(Position=1,Mandatory=$false)]
    [switch]
    $Force=$false
)

begin {
    Write-host ("`tLabName : {0}" -f $Lab.Name) -ForegroundColor Yellow

    if ($null -ne $Lab) {
        $LabToRemove = $Lab
    }

    if (-not [string]::IsNullOrEmpty($LabId)) {
        $LabToRemove = Get-Lab -Id $LabId
    }

    if (-not [string]::IsNullOrEmpty($Name)) {
        $LabToRemove = Get-Lab -Name $Name
    }

    if ($null -eq $LabToRemove) {
        throw "There is no Lab with specified characteristics. Please check your input"
    }
}

process {
    $DoRemoval = $true
    if ($Force.IsPresent -eq $false) {
        while ($null -eq $UserInput -or $UserInput -notin @('Y','N')) {
            $UserInput = Read-HostDefault -Prompt "Are you sure want to remove the selected Lab and all its components ? [Y]es, [N]o" -Default 'N'

            if ($UserInput -eq 'N') {
                $DoRemoval = $false
            }
        }

        Write-Host ("`tUser Input : {0}" -f $UserInput) -ForegroundColor Green
    }

    if ($DoRemoval -eq $true) {
        Write-Host ("`tAbout to Remove the following Lab : {0}" -f $LabToRemove.Name) -ForegroundColor Green
    }
}

end {

}

}

正如您在下面调试此函数时看到的，$Lab 参数为空。

你对这个问题有什么想法吗？

Answer 1

由于函数正在$LabId 或$Name 上进行测试，因此这些变量需要存在于函数中，而目前它们不存在。 尝试将参数更改为：

[CmdletBinding(DefaultParameterSetName='LabId')]
param (
    [Parameter(ValueFromPipeline=$true, ValueFromPipelineByPropertyName = $true, ParameterSetName='LabId',Position=0,Mandatory=$true)]
    [string]$LabId,

    [Parameter(ValueFromPipeline=$true, ValueFromPipelineByPropertyName = $true, ParameterSetName='LabName',Position=0,Mandatory=$true)]
    [string]$Name,

    # Parameter help description
    [switch]$Force  # no need to set a switch to $false because if you don't send that param, the undelying value will be $false by default
)

然后删除

Write-host ("`tLabName : {0}" -f $Lab.Name) -ForegroundColor Yellow

if ($null -ne $Lab) {
    $LabToRemove = $Lab
}

这里的重要部分是ValueFromPipelineByPropertyName = $true 声明

Answer 2

begin 在其他任何事情之前运行，包括管道参数绑定 - 因此您需要将检查管道绑定参数（如 $Lab）的代码移动到 process 块：

Function Remove-Lab{
[CmdletBinding(DefaultParameterSetName='Lab')]
param (
    [Parameter(ValueFromPipeline=$true,ParameterSetName='Lab',Position=0,Mandatory=$true)]
    [Lab]
    $Lab,
    
    # Parameter help description
    [Parameter(Position=1,Mandatory=$false)]
    [switch]
    $Force=$false
)

process {
    Write-host ("`tLabName : {0}" -f $Lab.Name) -ForegroundColor Yellow

    if ($null -ne $Lab) {
        $LabToRemove = $Lab
    }

    if (-not [string]::IsNullOrEmpty($LabId)) {
        $LabToRemove = Get-Lab -Id $LabId
    }

    if (-not [string]::IsNullOrEmpty($Name)) {
        $LabToRemove = Get-Lab -Name $Name
    }

    if ($null -eq $LabToRemove) {
        throw "There is no Lab with specified characteristics. Please check your input"
    }

    $DoRemoval = $true
    if ($Force.IsPresent -eq $false) {
        while ($null -eq $UserInput -or $UserInput -notin @('Y','N')) {
            $UserInput = Read-HostDefault -Prompt "Are you sure want to remove the selected Lab and all its components ? [Y]es, [N]o" -Default 'N'

            if ($UserInput -eq 'N') {
                $DoRemoval = $false
            }
        }

        Write-Host ("`tUser Input : {0}" -f $UserInput) -ForegroundColor Green
    }

    if ($DoRemoval -eq $true) {
        Write-Host ("`tAbout to Remove the following Lab : {0}" -f $LabToRemove.Name) -ForegroundColor Green
    }
}