about_Splatting
簡単な説明
スプラッティングを使用して PowerShell のコマンドにパラメーターを渡す方法について説明します。
長い説明
スプラッティングは、パラメーター値のコレクションを 1 つの単位としてコマンドに渡すメソッドです。 PowerShell は、コレクション内の各値をコマンド パラメーターに関連付ける。 スプラッティングされたパラメーター値は、標準変数のように見える名前付きスプラッティング変数に格納されますが、ドル記号 () ではなく At 記号 (@) で始まります$。 At 記号は、1 つの値ではなく値のコレクションを渡す場合に PowerShell に指示します。
スプラッティングにより、コマンドが短くなり、読みやすくなります。 さまざまなコマンド呼び出 $PSBoundParameters しでスプラッティング値を再利用し、スプラッティングを使用して自動変数から他のスクリプトや関数にパラメーター値を渡します。
Windows PowerShell 3.0 から、スプラッティングを使用してコマンドのすべてのパラメーターを表す方法も使用できます。
構文
<CommandName> <optional parameters> @<HashTable> <optional parameters>
<CommandName> <optional parameters> @<Array> <optional parameters>
パラメーター名が不要な位置指定パラメーターのパラメーター値を指定するには、配列構文を使用します。 パラメーター名と値のペアを指定するには、ハッシュ テーブル構文を使用します。 スプラット値は、パラメーター リスト内の任意の場所に表示できます。
スプラッティングする場合は、ハッシュ テーブルまたは配列を使用してすべてのパラメーターを渡す必要はありません。 スプラッティングを使用して一部のパラメーターを渡し、他のパラメーターを位置またはパラメーター名で渡します。 また、1 つのコマンドで複数のオブジェクトをスプラットして、各パラメーターに複数の値を渡しないので、
PowerShell 7.1 では、コマンドでパラメーターを明示的に定義することで、スプラット パラメーターをオーバーライドできます。
ハッシュ テーブルを使用したスプラッティング
ハッシュ テーブルを使用して、パラメーター名と値のペアをスプラッターします。 この形式は、位置指定パラメーターやスイッチ パラメーターを含むすべてのパラメーターの種類に使用できます。 位置指定パラメーターは、名前で割り当てる必要があります。
次の例では、同じ Copy-Item ディレクトリ内の Test.txt ファイルをコピーする 2 Test2.txtを比較します。
最初の例では、パラメーター名が含まれる従来の形式を使用します。
Copy-Item -Path "test.txt" -Destination "test2.txt" -WhatIf
2 番目の例では、ハッシュ テーブルスプラッティングを使用します。 最初のコマンドは、パラメーター名とパラメーターと値のペアのハッシュ テーブルを作成し、変数に格納 $HashArguments します。 2 番目のコマンドは、 $HashArguments スプラッティングを使用してコマンドで 変数を使用します。 At 記号 () は@HashArguments、 コマンドのドル記号 ($HashArguments) を置き換える記号です。
WhatIf スイッチ パラメーターの値を指定するには、 または を使用$Trueします$False。
$HashArguments = @{
Path = "test.txt"
Destination = "test2.txt"
WhatIf = $true
}
Copy-Item @HashArguments
注意
最初のコマンドでは、At 記号 (@) は、スプラット値ではなくハッシュ テーブルを示します。 PowerShell のハッシュ テーブルの構文は次のとおりです。 @{<name>=<value>; <name>=<value>; ...}
配列を使用したスプラッティング
配列を使用して、パラメーター名を必要としない位置指定パラメーターの値をスプラッターします。 値は、配列内の位置番号の順序である必要があります。
次の例では、同じ Copy-Item ディレクトリ内の Test.txt ファイルをコピーする 2 Test2.txtを比較します。
最初の例では、パラメーター名を省略する従来の形式を使用します。 パラメーター値は、 コマンドの位置順に表示されます。
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 つのオブジェクトとして配列を渡す必要がある場合は、配列を別の配列の唯一の要素としてラップする必要があります。
次の例には、文字列の配列である 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!
例
例 1: さまざまなコマンドでスプラット パラメーターを再利用する
この例では、さまざまなコマンドでスプラット値を再利用する方法を示します。 この例のコマンドでは、 コマンドレットを 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."
例 2: パラメーターを使用してパラメーターを転送$PSBoundParameters
この例では、スプラッティングと自動変数を使用して、パラメーターを他のコマンドに転送する方法を $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
例 3: 明示的に定義されたパラメーターでスプラット パラメーターをオーバーライドする
この例では、明示的に定義されたパラメーターを使用してスプラット パラメーターをオーバーライドする方法を示します。 これは、新しいハッシュテーブルを構築したり、スプラッターに使用しているハッシュテーブルの値を変更したりしたくない場合に便利です。
変数 $commonParams には、場所に仮想マシンを作成するパラメーターが格納 East US されます。 変数 $allVms は、作成する仮想マシンの一覧です。 リストをループ処理し、 を使用 $commonParams して各仮想マシンを作成するためにパラメーターをスプラッターします。 ただし、他の myVM2 仮想マシンとは異なるリージョンに作成する必要があります。 ハッシュテーブルを調整 $commonParams する代わりに、 の Location New-AzVm Location パラメーターを明示的に定義して、 内のキーの値より代わりに使用できます $commonParams。
$commonParams = @{
ResourceGroupName = "myResourceGroup"
Location = "East US"
VirtualNetworkName = "myVnet"
SubnetName = "mySubnet"
SecurityGroupName = "myNetworkSecurityGroup"
PublicIpAddressName = "myPublicIpAddress"
}
$allVms = @('myVM1','myVM2','myVM3',)
foreach ($vm in $allVms)
{
if ($vm -eq 'myVM2')
{
New-AzVm @commonParams -Name $vm -Location "West US"
}
else
{
New-AzVm @commonParams -Name $vm
}
}
スプラッティング コマンド パラメーター
スプラッティングを使用して、コマンドのパラメーターを表します。 この手法は、プロキシ関数 (つまり、別のコマンドを呼び出す関数) を作成する場合に便利です。 この機能は、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)
メモ
CmdletBinding 属性または Parameter $args 属性のいずれかを使用して関数を高度な関数にした場合、自動変数は関数で使用できなくなりました。 高度な関数には、明示的なパラメーター定義が必要です。
PowerShell Desired State Configuration (DSC) はスプラッティングを使用するように設計されていない。 スプラッティングを使用して DSC リソースに値を渡す方法は使用できません。 詳細については、Gael Colas の記事「 擬似スプラッティング DSC リソース」を参照してください。
関連項目
フィードバック
フィードバックの送信と表示