about_Splatting

簡単な説明

Splatting を使用して PowerShell のコマンドにパラメーターを渡す方法について説明します。

長い説明

Splatting は、パラメーター値のコレクションを単位としてコマンドに渡すメソッドです。 PowerShell は、コレクション内の各値をコマンド パラメーターに関連付けます。 Splatted パラメーター値は、標準変数のように見える名前付きスプラッティング変数に格納されますが、ドル記号 () ではなく At 記号 (@$) で始まります。 At 記号は、1 つの値ではなく値のコレクションを渡すことを PowerShell に通知します。

Splatting を使用すると、コマンドが短くなり、読みやすくなります。 さまざまなコマンド呼び出しでスプラッティング値を再利用し、splatting を使用して、パラメーター値を自動変数から他の $PSBoundParameters スクリプトや関数に渡すことができます。

Windows PowerShell 3.0 以降では、splatting を使用してコマンドのすべてのパラメーターを表すこともできます。

構文

<CommandName> <optional parameters> @<HashTable> <optional parameters>
<CommandName> <optional parameters> @<Array> <optional parameters>

パラメーター名が不要な位置指定パラメーターのパラメーター値を指定するには、配列構文を使用します。 パラメーター名と値のペアを指定するには、ハッシュ テーブル構文を使用します。 splatted 値は、パラメーター リストの任意の場所に表示できます。

スプラッティング時に、ハッシュ テーブルまたは配列を使用してすべてのパラメーターを渡す必要はありません。 スプラッティングを使用していくつかのパラメーターを渡し、他のパラメーターを位置またはパラメーター名で渡すことができます。 また、各パラメーターに複数の値を渡さないように、1 つのコマンドで複数のオブジェクトをスプラットすることもできます。

ハッシュ テーブルを使用したスプラッティング

ハッシュ テーブルを使用して、パラメーター名と値のペアをスプラットします。 この形式は、位置指定パラメーターやスイッチ パラメーターを含むすべてのパラメーター型に使用できます。 位置指定パラメーターは名前で割り当てる必要があります。

次の例では、Test.txt ファイルを同じディレクトリ内のTest2.txt ファイルにコピーする 2 つの Copy-Item コマンドを比較します。

最初の例では、パラメーター名が含まれる従来の形式を使用します。

Copy-Item -Path "test.txt" -Destination "test2.txt" -WhatIf

2 番目の例では、ハッシュ テーブルのスプラッティングを使用します。 最初のコマンドは、パラメーター名とパラメーター値のペアのハッシュ テーブルを作成し、変数に $HashArguments 格納します。 2 番目のコマンドでは、 $HashArguments splatting を使用してコマンド内の変数を使用します。 At 記号 (@HashArguments) は、コマンドのドル記号 ($HashArguments) を置き換えます。

WhatIf スイッチ パラメーターの値を指定するには、次を使用$Trueします。$False

$HashArguments = @{
  Path = "test.txt"
  Destination = "test2.txt"
  WhatIf = $true
}
Copy-Item @HashArguments

注意

最初のコマンドでは、At 記号 (@) は、スプラッティングされた値ではなく、ハッシュ テーブルを示します。 PowerShell のハッシュ テーブルの構文は次のとおりです。 @{<name>=<value>; <name>=<value>; ...}

配列を使用したスプラッティング

配列を使用して、位置指定パラメーターの値をスプラットします。パラメーター名は必要ありません。 値は配列内の位置番号の順序で指定する必要があります。

次の例では、Test.txt ファイルを同じディレクトリ内のTest2.txt ファイルにコピーする 2 つの Copy-Item コマンドを比較します。

最初の例では、パラメーター名を省略する従来の形式を使用します。 パラメーター値は、コマンド内の位置順に表示されます。

Copy-Item "test.txt" "test2.txt" -WhatIf

2 番目の例では、配列のスプラッティングを使用します。 最初のコマンドは、パラメーター値の配列を作成し、変数に $ArrayArguments 格納します。 値は配列内の位置順です。 2 番目のコマンドでは、 $ArrayArguments スプラッティングでコマンド内の変数を使用します。 At 記号 (@ArrayArguments) は、コマンドのドル記号 ($ArrayArguments) を置き換えます。

$ArrayArguments = "test.txt", "test2.txt"
Copy-Item @ArrayArguments -WhatIf

ArgumentList パラメーターの使用

いくつかのコマンドレットには、コマンドレットによって実行されるスクリプト ブロックにパラメーター値を渡すために使用される ArgumentList パラメーターがあります。 ArgumentList パラメーターは、スクリプト ブロックに渡される値の配列を受け取ります。 PowerShell は、配列のスプラッティングを効果的に使用して、値をスクリプト ブロックのパラメーターにバインドします。 ArgumentList を使用する場合、配列を単一のパラメーターにバインドされた 1 つのオブジェクトとして渡す必要がある場合は、配列を別の配列の唯一の要素としてラップする必要があります。

次の例には、文字列の配列である 1 つのパラメーターを受け取るスクリプト ブロックがあります。

$array = 'Hello', 'World!'
Invoke-Command -ScriptBlock {
  param([string[]]$words) $words -join ' '
  } -ArgumentList $array

この例では、最初の $array 項目のみがスクリプト ブロックに渡されます。

Hello
$array = 'Hello', 'World!'
Invoke-Command -ScriptBlock {
  param([string[]]$words) $words -join ' '
} -ArgumentList (,$array)

この例では、 $array 配列全体が 1 つのオブジェクトとしてスクリプト ブロックに渡されるように配列にラップされています。

Hello World!

この例では、さまざまなコマンドで splatted 値を再利用する方法を示します。 この例のコマンドでは、コマンドレットを Write-Host 使用して、ホスト プログラム コンソールにメッセージを書き込みます。 スプラッティングを使用して、前景色と背景色を指定します。

すべてのコマンドの色を変更するには、変数の値を $Colors 変更するだけです。

最初のコマンドは、パラメーター名と値のハッシュ テーブルを作成し、ハッシュ テーブルを変数に $Colors 格納します。

$Colors = @{ForegroundColor = "black"; BackgroundColor = "white"}

2 番目と 3 番目のコマンドでは、 $Colors コマンドのスプラッティングに変数を Write-Host 使用します。 を$Colors variable使用するには、ドル記号 () を At 記号 ($Colors@Colors) に置き換えます。

#Write a message with the colors in $Colors
Write-Host "This is a test." @Colors

#Write second message with same colors. The position of splatted
#hash table does not matter.
Write-Host @Colors "This is another test."

この例では、splatting と自動変数を使用して、パラメーターを他のコマンドに転送する方法を $PSBoundParameters 示します。

$PSBoundParameters自動変数は、スクリプトまたは関数の実行時に使用されるすべてのパラメーター名と値を含むディクショナリ オブジェクト (System.Collections.Generic.Dictionary) です。

次の例では、変数を $PSBoundParameters 使用して、スクリプトまたは関数に渡されたパラメーター値を関数から Test2 関数に Test1 転送します。 両方とも、スプラッティングを Test1 使用して Test2 関数を呼び出します。

function Test1
{
    param($a, $b, $c)

    $a
    $b
    $c
}

function Test2
{
    param($a, $b, $c)

    #Call the Test1 function with $a, $b, and $c.
    Test1 @PsBoundParameters

    #Call the Test1 function with $b and $c, but not with $a
    $LimitedParameters = $PSBoundParameters
    $LimitedParameters.Remove("a") | Out-Null
    Test1 @LimitedParameters
}
Test2 -a 1 -b 2 -c 3
1
2
3
2
3

Splatting コマンド パラメーター

splatting を使用して、コマンドのパラメーターを表すことができます。 この手法は、プロキシ関数 、つまり別のコマンドを呼び出す関数を作成する場合に便利です。 この機能は、Windows PowerShell 3.0 で導入されています。

コマンドのパラメーターをスプラットするには、コマンド パラメーターを表すために使用 @Args します。 この手法は、コマンド パラメーターを列挙するよりも簡単で、呼び出されたコマンドのパラメーターが変更された場合でもリビジョンなしで動作します。

この機能は、割り当てられていないすべてのパラメーター値を含む自動変数を使用 $Args します。

たとえば、次の関数はコマンドレットを Get-Process 呼び出します。 この関数では、 @Args コマンドレットのすべてのパラメーターを Get-Process 表します。

function Get-MyProcess { Get-Process @Args }

この関数を使用すると、次の Get-MyProcess コマンドに示すように、割り当てられていないすべてのパラメーターとパラメーター値が渡されます @Args

Get-MyProcess -Name PowerShell
Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    463      46   225484     237196   719    15.86   3228 powershell
Get-MyProcess -Name PowerShell_Ise -FileVersionInfo
ProductVersion   FileVersion      FileName
--------------   -----------      --------
6.2.9200.16384   6.2.9200.1638... C:\Windows\system32\WindowsPowerShell\...

明示的に宣言されたパラメーターを持つ関数で使用 @Args できます。 関数では複数回使用できますが、次の例に示すように、入力したすべてのパラメーターがすべてのインスタンス @Argsに渡されます。

function Get-MyCommand
{
    Param ([switch]$P, [switch]$C)
    if ($P) { Get-Process @Args }
    if ($C) { Get-Command @Args }
}

Get-MyCommand -P -C -Name PowerShell
Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
408      28    75568      83176   620     1.33   1692 powershell

Path               : C:\Windows\System32\WindowsPowerShell\v1.0\powershell.e
Extension          : .exe
Definition         : C:\Windows\System32\WindowsPowerShell\v1.0\powershell.e
Visibility         : Public
OutputType         : {System.String}
Name               : powershell.exe
CommandType        : Application
ModuleName         :
Module             :
RemotingCapability : PowerShell
Parameters         :
ParameterSets      :
HelpUri            :
FileVersionInfo    : File:             C:\Windows\System32\WindowsPowerShell
                     \v1.0\powershell.exe
                     InternalName:     POWERSHELL
                     OriginalFilename: PowerShell.EXE.MUI
                     FileVersion:      10.0.14393.0 (rs1_release.160715-1616
                     FileDescription:  Windows PowerShell
                     Product:          Microsoft Windows Operating System
                     ProductVersion:   10.0.14393.0
                     Debug:            False
                     Patched:          False
                     PreRelease:       False
                     PrivateBuild:     False
                     SpecialBuild:     False
                     Language:         English (United States)

メモ

コマンドレット バインド属性またはパラメーター属性を使用して関数を高度な関数にした場合、$args関数で自動変数を使用できなくなります。 高度な関数には、明示的なパラメーター定義が必要です。

PowerShell Desired State Configuration (DSC) は、スプラッティングを使用するように設計されていませんでした。 スプラッティングを使用して DSC リソースに値を渡すことはできません。 詳細については、Gael Colas の記事 「疑似スプラッティング DSC リソース」を参照してください

こちらもご覧ください