如何在调用其他 Cmdlet 的 Cmdlet 中支持 PowerShell 的 -WhatIf 和 -Confirm 参数？

Question

我有一个支持 -WhatIf 和 -Confirm 参数的 PowerShell 脚本 cmdlet。

它通过在执行更改之前调用$PSCmdlet.ShouldProcess() 方法来做到这一点。
这按预期工作。

我的问题是我的 Cmdlet 是通过调用其他 Cmdlet 来实现的，而 -WhatIf 或 -Confirm 参数没有传递给我调用的 Cmdlet。

如何将 -WhatIf 和 -Confirm 的值传递给我从 Cmdlet 调用的 Cmdlet？

例如，如果我的 Cmdlet 是 Stop-CompanyXyzServices 并且它使用 Stop-Service 来实现其操作。

如果 -WhatIf 传递给 Stop-CompanyXyzServices 我希望它也传递给 Stop-Service。

这可能吗？

Answer 1

显式传递参数

您可以使用$WhatIfPreference 和$ConfirmPreference 变量传递-WhatIf 和-Confirm 参数。以下示例使用parameter splatting 实现了这一点：

if($ConfirmPreference -eq 'Low') {$conf = @{Confirm = $true}}

StopService MyService -WhatIf:([bool]$WhatIfPreference.IsPresent) @conf

如果在包含函数上使用了-WhatIf 开关，则$WhatIfPreference.IsPresent 将是True。使用包含函数上的-Confirm 开关临时将$ConfirmPreference 设置为low。

隐式传递参数

既然-Confirm和-WhatIf临时自动设置了$ConfirmPreference和$WhatIfPreference变量，那还需要传递吗？

考虑这个例子：

function ShouldTestCallee {
    [cmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Medium')] 
    param($test)

    $PSCmdlet.ShouldProcess($env:COMPUTERNAME,"Confirm?")
}


function ShouldTestCaller {
    [cmdletBinding(SupportsShouldProcess=$true)]
    param($test)

    ShouldTestCallee
}

$ConfirmPreference = 'High'
ShouldTestCaller
ShouldTestCaller -Confirm

ShouldTestCaller 从ShouldProcess() 产生True

ShouldTestCaller -Confirm 会导致确认提示，即使我没有通过开关。

编辑

@manojlds 的回答让我意识到我的解决方案总是将$ConfirmPreference 设置为“低”或“高”。如果确认首选项为“低”，我已更新我的代码以仅设置 -Confirm 开关。

Answer 2

经过一番谷歌搜索，我想出了一个很好的解决方案，可以将常用参数传递给调用的命令。您可以使用 @ splatting 运算符传递传递给您的命令的所有参数。例如，如果

Start-Service -Name ServiceAbc @PSBoundParameters

位于脚本的主体中，powershell 会将传递给脚本的所有参数传递给 Start-Service 命令。唯一的问题是，如果你的脚本包含一个 -Name 参数，它也会被传递，PowerShell 会抱怨你包含了两次 -Name 参数。我编写了以下函数来将所有常用参数复制到一个新字典中，然后将其吐出。

function Select-BoundCommonParameters
{
    [CmdletBinding()]
    param(
        [Parameter(Mandatory=$true)]
        $BoundParameters
    )
    begin
    {
        $boundCommonParameters = New-Object -TypeName 'System.Collections.Generic.Dictionary[string, [Object]]'
    }
    process
    {
        $BoundParameters.GetEnumerator() |
            Where-Object { $_.Key -match 'Debug|ErrorAction|ErrorVariable|WarningAction|WarningVariable|Verbose' } |
            ForEach-Object { $boundCommonParameters.Add($_.Key, $_.Value) }

        $boundCommonParameters
    }
}

最终结果是您将 -Verbose 等参数传递给脚本中调用的命令，它们尊重调用者的意图。

Answer 3

这是基于@Rynant 和@Shay Levy 的答案的完整解决方案：

function Stop-CompanyXyzServices
{
    [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='Medium')]

    Param(
        [Parameter(
            Position=0,
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true
        )]      
        [string]$Name
    )

    process
    {
        if($PSCmdlet.ShouldProcess($env:COMPUTERNAME,"Stop XYZ services '$Name'")){  
            ActualCmdletProcess
        }
        if([bool]$WhatIfPreference.IsPresent){
            ActualCmdletProcess
        }
    }
}

function ActualCmdletProcess{
# add here the actual logic of your cmdlet, and any call to other cmdlets
Stop-Service $name -WhatIf:([bool]$WhatIfPreference.IsPresent) -Confirm:("Low","Medium" -contains $ConfirmPreference)
}

我们必须查看-WhatIf 是否也单独传递，以便可以将whatif 传递给各个cmdlet。 ActualCmdletProcess 基本上是一种重构，这样您就不会只为WhatIf 再次调用同一组命令。希望这对某人有所帮助。

Answer 4

根据@manojlds 评论更新

将 $WhatIf 和 $Confirm 转换为布尔值并将值传递给底层 cmdlet：

function Stop-CompanyXyzServices
{
    [CmdletBinding(SupportsShouldProcess=$true,ConfirmImpact='High')]

    Param(
        [Parameter(
            Position=0,
            ValueFromPipeline=$true,
            ValueFromPipelineByPropertyName=$true
        )]      
        [string]$Name
    )


    process
    {
        if($PSCmdlet.ShouldProcess($env:COMPUTERNAME,"Stop service '$Name'"))
        {                   
            Stop-Service $name -WhatIf:([bool]$WhatIf) -Confirm:([bool]$confirm)
        }                       
    }
}