我对PowerShell很陌生,但喜欢它在我们的Windows机器上自动执行大量任务。我喜欢你可以从其他脚本调用函数,但是我编写的脚本都使用用户可以提供的参数(因此同事们更容易使用它们)。
特别是有一个参数在我的脚本中通常是必需的。我面临的问题是从具有强制参数的脚本调用函数。
这是一个简单的例子:
Param(
[Parameter()]
[ValidateNotNullOrEmpty()]
[string]$VirtualMachine=$(throw "Machine name missing!"),
[int]$Attempts = 150
)
Function DoSomething($VirtualMachine, $Attempts){
write("$VirtualMachine and $Attempts")
}
将此作为脚本运行,您将提供-VirtualMachine "VMnameHere" -Attempts 123
。运行它会产生VMnameHere and 123
。完善!但是..如果我尝试将其作为另一个脚本中的函数调用..
此处示例:
. ".\Manage-Machine.ps1"
DoSomething -VirtualMachine "nwb-thisisamachine" -Attempts 500
这产生了一个错误:
Machine name missing!
At C:\Users\something\Desktop\Dump\play\Manage-Machine.ps1:33 char:28
+ [string]$VirtualMachine=$(throw "Machine name missing!"),
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : OperationStopped: (Machine name missing!:String) [], RuntimeException
+ FullyQualifiedErrorId : Machine name missing!
这显然是因为该字段是强制性的。我在这种情况下如何调用函数我做错了什么?如果函数所属的脚本具有必需参数,是否有另一种方法来调用该函数,因为如果我删除参数的验证,则一切正常。
会喜欢一些意见,
谢谢!
答案 0 :(得分:2)
我会使用[parameter(Mandatory = $true)]
并删除=$(throw "Machine name missing!")
。
然后,您可以使用-NonInteractive
标志(documentation link)运行powershell,并且任何缺少的必需参数都将导致错误,并且将返回非零退出代码。
此回复代码应由CI流程选取,它本身将处理错误。
答案 1 :(得分:0)
我不确定这样做是个好主意,但听起来好像以下情况会有效:
Param(
[ValidateNotNullOrEmpty()]
# Do NOT use = $(Throw ...) or [Parameter(Mandatory)].
[string]$VirtualMachine,
[int]$Attempts = 150
)
# Determine if the script is being "dot-sourced".
# Note: The `$MyInvocation.Line -eq ''` part detects being run from the
# ISE or Visual Studio Code, which implicitly perform sourcing too.
$isDotSourced = $MyInvocation.InvocationName -eq '.' -or $MyInvocation.Line -eq ''
# NOT sourced? Enforce mandatory parameters.
if (-not $isDotSourced) {
if (-not $VirtualMachine) { Throw "Machine name missing!" }
}
Function DoSomething($VirtualMachine, $Attempts) {
"$VirtualMachine and $Attempts"
}
# NOT sourced? Call the default function or
# do whatever you want the script to do when invoked as a whole.
if (-not $isDotSourced) {
DoSomething $VirtualMachine $Attempts
}
. .\Manage-Machine.ps1
只会定义函数(在这种情况下为DoSomething
),以后调用;
由于没有任何脚本参数在技术上被声明为强制性,因此不带参数的调用将会成功(与您的尝试不同,throw
语句总是会被激活 - 无论是直接调用还是点源)。
.\Manage-Machine.ps1
将强制存在$VirtualMachine
参数值,并立即调用DoSomething
,将参数值传递给。{/ p>
请注意,当然,您的功能也可以从输入参数和添加验证属性中受益。