【PowerShell】Paramによる引数の受け取り方法

PowerShellのParamによる引数の受け取り方法について記載します。

＜環境＞
OS：Windows10（64bit）
PSVersion：v5.1

Paramの基本構文

Param($引数1, $引数2・・・)

Param($arg1, $arg2)
Write-Output "arg1 = $arg1"
Write-Output "arg2 = $arg2"

PS C:\work> .\test.ps1 "foo" "bar"
arg1 = foo
arg2 = bar

PS C:\work> .\test.ps1 -arg2 "foo" -arg1 "bar"
arg1 = bar
arg2 = foo

引数の型を指定

Param([型]$引数1, [型]$引数2・・・)

Param(
    [string]$arg1,
    [int]$arg2,
    [bool]$arg3,
    [DateTime]$arg4,
    [string[]]$arg5
)
Write-Output "arg1 = $arg1"
Write-Output "arg2 = $arg2"
Write-Output "arg3 = $arg3"
Write-Output "arg4 = $arg4"
Write-Output "arg5 = $($arg5 -join ', ')"

PS C:\work> .\test.ps1 "foo" 99 $true "2023-05-25" "AAA", "BBB", "CCC"
arg1 = foo
arg2 = 99
arg3 = True
arg4 = 05/25/2023 00:00:00
arg5 = AAA, BBB, CCC

引数に初期値を設定

Param($引数1 = 初期値1, $引数2 = 初期値2・・・)

Param(
    [string]$arg1 = "initial",
    [int]$arg2 = "0",
    [bool]$arg3 = $true,
    [DateTime]$arg4 = (Get-Date),
    [string[]]$arg5 = ("AAA","BBB","CCC")
)
Write-Output "arg1 = $arg1"
Write-Output "arg2 = $arg2"
Write-Output "arg3 = $arg3"
Write-Output "arg4 = $arg4"
Write-Output "arg5 = $($arg5 -join ', ')"

PS C:\work> .\test.ps1 -arg2 99 -arg3 $false
arg1 = default
arg2 = 99
arg3 = False
arg4 = 05/25/2023 23:53:34
arg5 = AAA, BBB, CCC

引数に必須パラメータを設定

Param([parameter(mandatory)]$引数1・・・)

Param(
    [parameter(mandatory)][string]$arg1,
    [parameter(mandatory)][string]$arg2
)
Write-Output "arg1 = $arg1"
Write-Output "arg2 = $arg2"

PS C:\work> .\test.ps1 "foo"
コマンド パイプライン位置 1 のコマンドレット test.ps1
次のパラメーターに値を指定してください:
arg2: 

PS C:\work> .\test.ps1 "foo" ""
C:\work\test.ps1 : 引数が空の文字列であるため、パラメーター 'arg2' にバインドできません。
発生場所 行:1 文字:18
+ .\test.ps1 "foo" ""
+                  ~~
    + CategoryInfo          : InvalidData: (:) [test.ps1]、ParameterBindingValidationException
    + FullyQualifiedErrorId : ParameterArgumentValidationErrorEmptyStringNotAllowed,test.ps1

引数のチェック

Param([Validate属性]$引数1・・・)

Validate属性	チェック内容
[ValidateNotNull()]	引数の値が$nullでないことをチェックする。
[ValidateNotNullOrEmpty()]	引数の値が$null または 空文字でないことをチェックする。
[ValidateSet("Option1", "Option2")]	引数が指定した値のいずれかと一致していることをチェックする。 左記は"Option1"または"Option2"と一致するかチェックします。
[ValidateCount(1, 5)]	引数の配列やコレクションの要素数が指定した範囲内にあることをチェックする。 左記は要素数が"1文字以上、5文字以下かチェックします。
[ValidateLength(1, 5)]	string型引数の文字数が指定した値の範囲内であることをチェックする。 左記は文字数が1以上、5以下かチェックします。
[ValidateRange(1, 10)]	引数が指定した値の範囲内であることをチェックする。 左記は値が1以上、10以下かチェックします。
[ValidatePattern("^[a-zA-Z0-9]+$")]	引数が指定した正規表現と一致することをチェックする。 左記は値が半角英数字かチェックします。
[ValidateScript({if ($_ % 2 -eq 0) {$true} else {$false}})]	引数の値が指定したスクリプトで$trueを返すかチェックする。 左記は値が偶数（2で割り切れる）かチェックします。

Param(
    [ValidateNotNullOrEmpty()][string]$arg1,
    [ValidateSet("Option1", "Option2")][string]$arg2,
    [ValidateLength(1, 5)][string]$arg3
)
Write-Output "arg1 = $arg1"
Write-Output "arg2 = $arg2"
Write-Output "arg3 = $arg3"

PS C:\work> .\test.ps1 "" "Option1" "bar"
C:\work\test.ps1 : パラメーター 'arg1 の引数を確認できません。引数が null または空です。null または空でない引数を指定して、コマンドを再度実行してください。
発生場所 行:1 文字:12
+ .\test.ps1 "" "Option1" "bar"
+            ~~
    + CategoryInfo          : InvalidData: (:) [test.ps1]、ParameterBindingValidationException
    + FullyQualifiedErrorId : ParameterArgumentValidationError,test.ps1

PS C:\work> .\test.ps1 "foo" "XXX" "bar"
C:\work\test.ps1 : パラメーター 'arg2 の引数を確認できません。引数 "XXX" は、ValidateSet 属性で指定されたセット "Option1,Option2" に属していません。このセットの引数を指定して、コマンドを再度実行してください。
発生場所 行:1 文字:18
+ .\test.ps1 "foo" "XXX" "bar"
+                  ~~~~~
    + CategoryInfo          : InvalidData: (:) [test.ps1]、ParameterBindingValidationException
    + FullyQualifiedErrorId : ParameterArgumentValidationError,test.ps1

PS C:\work> .\test.ps1 "foo" "Option1" "foobar"
C:\work\test.ps1 : パラメーター 'arg3 の引数を確認できません。引数の文字の長さ 6 が長すぎます。引数の文字の長さが "5" 文字以下になるように短くして、コマンドを再実行してください。
発生場所 行:1 文字:28
+ .\test.ps1 "foo" "Option1" "foobar"
+                            ~~~~~~~~
    + CategoryInfo          : InvalidData: (:) [test.ps1]、ParameterBindingValidationException
    + FullyQualifiedErrorId : ParameterArgumentValidationError,test.ps1