【PowerShell】スクリプトと関数で使う引数の基本設定と活用ポイント

# sample.ps1

# コメント：スクリプトに渡された引数の順序に従い、値を表示しています。

Write-Host "First argument: $($args[0])"
Write-Host "Second argument: $($args[1])"

First argument: Hello
Second argument: World

# sample.ps1

# コメント：すべての引数を foreach ループで確認しています。

foreach ($arg in $args) {
    Write-Host "Argument: $arg"
}

Argument: Apple
Argument: Banana
Argument: Cherry

# sample.ps1

# コメント：引数の数が期待通りか確認し、不足している場合は使用方法の案内を表示します。

if ($args.Count -lt 2) {
    Write-Host "Usage: .\sample.ps1 <Argument1> <Argument2>"
    exit
}
Write-Host "Argument 1: $($args[0])"
Write-Host "Argument 2: $($args[1])"

Usage: .\sample.ps1 <Argument1> <Argument2>

function Show-Message {
    param (
        [string]$Message
    )
    Write-Host "Message: $Message"
}

# コメント：関数呼び出しで文字列を指定しています。

Show-Message -Message "Hello PowerShell!"

Message: Hello PowerShell!

function Welcome {
    param (
        [Parameter(Mandatory=$true)]
        [string]$Name,
        [string]$Greeting = "Welcome"
    )
    Write-Host "$Greeting, $Name!"
}

# コメント：必須の引数 $Name を指定し、省略可能な $Greeting はデフォルト値が使用されます。

Welcome -Name "Alice"

Welcome, Alice!

function Introduce {
    param (
        [string]$Name,
        [int]$Age
    )
    Write-Host "Hello, my name is $Name and I am $Age years old."
}

# コメント：引数を2つ指定した関数呼び出し例です。

Introduce -Name "Bob" -Age 25

Hello, my name is Bob and I am 25 years old.

function Shout-Message {
    param (
        [string]$Name,
        [switch]$Shout
    )
    if ($Shout) {
        Write-Host "HELLO, $Name!"
    }
    else {
        Write-Host "Hello, $Name."
    }
}

# コメント：$Shout を使って大文字の挨拶を制御しています。

Shout-Message -Name "Alice" -Shout

HELLO, Alice!

function Get-Data {
    param (
        [switch]$VerboseMode
    )
    Write-Host "データ取得を実行します。"
    if ($VerboseMode) {
        Write-Host "詳細情報：デバッグログや各種パラメーターの状態を表示します。"
    }
    else {
        Write-Host "通常モードでの実行です。"
    }
}

# コメント：詳細モードを有効にして、より多くの情報を表示する例です。

Get-Data -VerboseMode

データ取得を実行します。
詳細情報：デバッグログや各種パラメーターの状態を表示します。

function Set-User {
    param (
        [Parameter(Mandatory=$true)]
        [string]$Username,
        [ValidateSet("Admin", "User", "Guest")]
        [string]$Role
    )
    Write-Host "設定中のユーザー: $Username"
    Write-Host "付与する役割: $Role"
}

# コメント：関数呼び出し時には、$Role に "Admin", "User", "Guest" のいずれかを指定する必要があります。

Set-User -Username "Charlie" -Role "Admin"

設定中のユーザー: Charlie
付与する役割: Admin

# コメント：Role に不正な値を設定すると validation エラーが発生します。

Set-User -Username "Charlie" -Role "SuperAdmin"

Set-User : Cannot validate argument on parameter 'Role'. The argument "SuperAdmin" does not belong to the set "Admin,User,Guest" specified by the ValidateSet attribute.

function Check-Numeric {
    param (
        [ValidateScript({ $_ -as [int] -ne $null })]
        [string]$InputValue
    )
    Write-Host "入力された数値は $InputValue です。"
}

# コメント：この関数は、引数が数値に変換できるかどうかを確認します。

Check-Numeric -InputValue "123"

入力された数値は 123 です。

function Verify-Range {
    param (
        [ValidateScript({
            if ($_ -ge 1 -and $_ -le 10) {
                $true
            }
            else {
                throw "値は1から10の範囲で指定してください。"
            }
        })]
        [int]$Number
    )
    Write-Host "入力された数値: $Number"
}

# コメント：範囲外の値を指定すると、カスタムエラーメッセージが表示されます。

Verify-Range -Number 15

Verify-Range : 値は1から10の範囲で指定してください。

function Invoke-DynamicParam {
    [CmdletBinding()]
    param ()
    Dynamicparam {

        # コメント：DynamicParameterDictionary の作成

        $paramDictionary = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary
        $attributeCollection = New-Object System.Collections.ObjectModel.Collection[System.Attribute]
        $parameterAttribute = New-Object System.Management.Automation.ParameterAttribute
        $parameterAttribute.Mandatory = $true
        $attributeCollection.Add($parameterAttribute)

        # コメント：DynamicParameter の定義

        $runtimeParam = New-Object System.Management.Automation.RuntimeDefinedParameter("DynamicValue", [string], $attributeCollection)
        $paramDictionary.Add("DynamicValue", $runtimeParam)
        return $paramDictionary
    }
    Write-Host "DynamicValue の値: $($PSBoundParameters['DynamicValue'])"
}

# コメント：実行時に DynamicValue パラメーターが必須となります。

Invoke-DynamicParam -DynamicValue "Dynamic Test"

DynamicValue の値: Dynamic Test

function Show-UserInfo {
    param (
        [hashtable]$UserInfo
    )
    Write-Host "ユーザー情報："
    foreach ($key in $UserInfo.Keys) {
        Write-Host "$key : $($UserInfo[$key])"
    }
}

# コメント：ハッシュテーブルを作成して、関数に渡しています。

$userData = @{
    "Name" = "Diana"
    "Age" = 28
    "Role" = "User"
}
Show-UserInfo -UserInfo $userData

ユーザー情報：
Name : Diana
Age : 28
Role : User

function Display-Product {
    param (
        [Parameter(Mandatory=$true)]
        [PSCustomObject]$Product
    )
    Write-Host "製品名: $($Product.Name)"
    Write-Host "価格: $($Product.Price)"
    Write-Host "在庫状況: $($Product.InStock)"
}

# コメント：製品情報を含むカスタムオブジェクトを作成しています。

$productObject = [PSCustomObject]@{
    Name    = "Laptop"
    Price   = 1500
    InStock = $true
}
Display-Product -Product $productObject

製品名: Laptop
価格: 1500
在庫状況: True

function Process-Number {
    param (
        [int]$Number
    )
    Write-Host "受け取った数値: $Number"
}

# コメント：意図せず文字列を渡した例です。エラーが発生します。

Process-Number -Number "NotANumber"

Process-Number : Cannot convert value "NotANumber" to type "System.Int32".

function Safe-Convert {
    param (
        [string]$InputValue
    )
    try {

        # コメント：強制的に整数型に変換を試みます。

        $number = [int]$InputValue
        Write-Host "変換成功：$number"
    }
    catch {
        Write-Host "エラー：入力値 '$InputValue' は数値に変換できません。"
    }
}

# コメント：正しい数値の場合と、変換できない場合の両方をテストします。

Safe-Convert -InputValue "100"
Safe-Convert -InputValue "abc"

変換成功：100
エラー：入力値 'abc' は数値に変換できません。