如何支持 PowerShell 的 -WhatIf & - 确认调用其他 Cmdlet 的 Cmdlet 中的参数吗？

Question

我有一个支持 -WhatIf 的 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 和 $ 传递 -WhatIf 和 -Confirm 参数确认首选项变量。以下示例通过参数splatting< /a>:

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< /code> 自动变量，是否有必要传递它们？

考虑这个例子：

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)
        }                       
    }
}

Answer 5

为了避免您因这个问题和此处的答案而困扰几个小时，我建议您改为阅读这篇文章：

https://powershellexplained.com/2020-03-15-Powershell-shouldprocess-whatif-confirm-shouldcontinue-everything/#suppressing-nested-confirm-prompts

这里提供的答案对很多人来说并不适用我发现人们在不了解基本原理的情况下实施这里的答案是危险的。

以下是如何破解它以跨脚本模块工作：