ForEach-Object

リファレンス

モジュール:: Microsoft.PowerShell.Core

入力オブジェクトのコレクション内の各項目に対して操作を実行します。

構文

ForEach-Object
            [-InputObject <PSObject>]
            [-Begin <ScriptBlock>]
            [-Process] <ScriptBlock[]>
            [-End <ScriptBlock>]
            [-RemainingScripts <ScriptBlock[]>]
            [-WhatIf]
            [-Confirm]
            [<CommonParameters>]

ForEach-Object
            [-InputObject <PSObject>]
            [-MemberName] <String>
            [-ArgumentList <Object[]>]
            [-WhatIf]
            [-Confirm]
            [<CommonParameters>]

ForEach-Object
            -Parallel <scriptblock>
            [-InputObject <psobject>]
            [-ThrottleLimit <int>]
            [-TimeoutSeconds <int>]
            [-AsJob]
            [-UseNewRunspace]
            [-WhatIf]
            [-Confirm]
            [<CommonParameters>]

説明

コマンドレットは ForEach-Object 、入力オブジェクトのコレクション内の各項目に対して操作を実行します。入力オブジェクトは、コマンドレットにパイプ処理することも、 InputObject パラメーターを使用して指定することもできます。

Windows PowerShell 3.0 以降では、コマンドを作成ForEach-Objectする 2 つの異なる方法があります。

スクリプトブロック。スクリプトブロックを使用して、操作を指定することができます。スクリプトブロック内で、変数を $_ 使用して現在のオブジェクトを表します。スクリプトブロックは、Process パラメーターの値です。スクリプトブロックには、任意の PowerShell スクリプトを含めることができます。

たとえば、次のコマンドでは、コンピューター上の各プロセスの ProcessName プロパティの値を取得します

Get-Process | ForEach-Object {$_.ProcessName}

ForEach-Objectでは、beginprocessabout_functionsで説明されているように、および end ブロックがサポートされています。

注意

スクリプトブロックは、呼び出し元のスコープで実行されます。したがって、ブロックはそのスコープ内の変数にアクセスでき、コマンドレットの完了後にそのスコープに保持される新しい変数を作成できます。
操作ステートメント。また、自然言語に似た操作ステートメントを記述することもできます。操作のステートメントを使用してプロパティの値を指定することも、メソッドを呼び出すこともできます。操作のステートメントは、Windows PowerShell 3.0 で導入されました。

たとえば、次のコマンドでは、コンピューター上の各プロセスの ProcessName プロパティの値も取得します。

Get-Process | ForEach-Object ProcessName
並列実行スクリプトブロック。 PowerShell 7.0 以降では、各スクリプトブロックを並列で実行する 3 つ目のパラメーターセットを使用できます。 ThrottleLimit パラメーターは、一度に実行される並列スクリプトの数を制限します。前と同様に、変数を $_ 使用して、スクリプトブロック内の現在の入力オブジェクトを表します。キーワード (keyword)を$using:使用して、実行中のスクリプトに変数参照を渡します。

PowerShell 7 では、ループイテレーションごとに新しい実行空間が作成され、最大限の分離が確保されます。これは、実行している作業が新しい実行空間の作成と比較して小さい場合や、多くの反復で重要な作業を実行している場合に、パフォーマンスとリソースに大きな影響を与える可能性があります。 PowerShell 7.1 以降では、実行空間プールからの実行空間は既定で再利用されます。 ThrottleLimit パラメーターは、実行空間プールのサイズを設定します。既定の実行空間プールサイズは 5 です。 UseNewRunspace スイッチを使用して、イテレーションごとに新しい実行空間を作成できます。

既定では、並列スクリプトブロックは、並列タスクを開始した呼び出し元の現在の作業ディレクトリを使用します。

詳細については、この記事の「メモ」セクションを参照してください。

例

例 1: 配列内の整数を除算する

この例では、3 つの整数の配列を受け取り、それぞれを 1024 で除算します。

30000, 56798, 12432 | ForEach-Object -Process {$_/1024}

29.296875
55.466796875
12.140625

例 2: ディレクトリ内のすべてのファイルの長さを取得する

この例では、PowerShell インストールディレクトリ内のファイルとディレクトリを処理します $PSHOME。

Get-ChildItem $PSHOME |
  ForEach-Object -Process {if (!$_.PSIsContainer) {$_.Name; $_.Length / 1024; " " }}

オブジェクトがディレクトリでない場合、スクリプトブロックはファイルの名前を取得し 、Length プロパティ の値を 1024 で除算し、次のエントリから区切るスペース (" ") を追加します。このコマンドレットでは 、PSISContainer プロパティを使用して、オブジェクトがディレクトリであるかどうかを判断します。

例 3: 最新のシステムイベントを操作する

次の使用例は、システムイベントログから 1,000 件の最新のイベントをテキストファイルに書き込みます。現在の時刻は、イベントの処理の前後に表示されます。

Get-EventLog -LogName System -Newest 1000 |
    ForEach-Object -Begin {Get-Date} -Process {
        Out-File -FilePath Events.txt -Append -InputObject $_.Message
    } -End {Get-Date}

Get-EventLog は、システムイベントログから最新の 1000 個のイベントを取得し、コマンドレットに ForEach-Object パイプします。 Begin パラメーターは、現在の日付と時刻を示します。次に、 Process パラメーターはコマンドレットを Out-File 使用して、events.txt という名前のテキストファイルを作成し、そのファイル内の各イベントの message プロパティを格納します。最後に、 End パラメーターを使用して、すべての処理が完了した後の日付と時刻を表示します。

例 4: レジストリキーの値を変更する

次の使用例は、キーの下にあるすべてのサブキーの RemotePath レジストリエントリの値を HKCU:\Network 大文字のテキストに変更します。

Get-ItemProperty -Path HKCU:\Network\* |
  ForEach-Object {
    Set-ItemProperty -Path $_.PSPath -Name RemotePath -Value $_.RemotePath.ToUpper()
  }

このフォーマットを使用して、レジストリエントリ値の形式や内容を変更することができます。

ネットワーク キーの各サブキーは、サインオン時に再接続するマップされたネットワークドライブを表します。 RemotePath エントリには、接続されているドライブの UNC パスが含まれます。たとえば、ドライブを E: に\\Server\Shareマップすると、RemotePath レジストリ値がに設定された E サブキーがにHKCU:\Network\\Server\Share作成されます。

コマンドは、コマンドレットを Get-ItemProperty 使用して ネットワーク キーのすべてのサブキーを取得し、コマンドレットを Set-ItemProperty 使用して各キーの RemotePath レジストリエントリの値を変更します。コマンドの Set-ItemProperty パスは、レジストリキーの PSPath プロパティの値です。これは、レジストリエントリではなく、レジストリキーを表す Microsoft .NET Framework オブジェクトのプロパティです。コマンドは、文字列REG_SZである RemotePath 値の ToUpper() メソッドを使用します。

は各キーのプロパティを変更するため Set-ItemProperty 、 ForEach-Object プロパティにアクセスするにはコマンドレットが必要です。

例 5: $null自動変数を使用する

この例では、自動変数をコマンドレットにパイプ処理する $null 効果を ForEach-Object 示します。

1, 2, $null, 4 | ForEach-Object {"Hello"}

Hello
Hello
Hello
Hello

PowerShell は明示的なプレースホルダーとして扱 $null うため、コマンドレットは ForEach-Object 、パイプされた他のオブジェクトの場合と同様に、の値 $null を生成します。

例 6: プロパティ値を取得する

この例では、コマンドレットの MemberName パラメーターを使用して、インストールされているすべての PowerShell モジュールの Path プロパティの値をForEach-Object取得します。

Get-Module -ListAvailable | ForEach-Object -MemberName Path
Get-Module -ListAvailable | Foreach Path

2 番目のコマンドは、1 番目のコマンドと同等です。コマンドレットのエイリアスをForeachForEach-Object使用し、省略可能な MemberName パラメーターの名前を省略します。

コマンドレットは ForEach-Object 、プロパティ値の型を変更する Format コマンドレットや Select-Object コマンドレットとは異なり、型を変更せずに値を取得するため、プロパティ値を取得する場合に便利です。

例 7: モジュール名をコンポーネント名に分割する

この例では、2 つのドット区切りのモジュール名をコンポーネント名に分割する 3 つの方法を示します。このコマンドは、文字列の Split メソッドを呼び出します。 3 つのコマンドは、別の構文を使用しますが、すべて同等であり、交換可能です。出力は、3 つのケースすべてで同じです。

"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" |
    ForEach-Object {$_.Split(".")}
"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" |
    ForEach-Object -MemberName Split -ArgumentList "."
"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" |
    Foreach Split "."

Microsoft
PowerShell
Core
Microsoft
PowerShell
Host

最初のコマンドは、スクリプトブロックと現在のオブジェクト演算子を含む従来の構文を使用します $_。メソッドの指定にドット構文を使用し、区切り記号の引数を囲むためにかっこを使用します。

2 番目のコマンドでは 、MemberName パラメーターを使用して Split メソッドを指定し、 ArgumentList パラメーターを使用してドット (.) を分割区切り記号として識別します。

3 番目のコマンドは、コマンドレットの Foreach エイリアスを ForEach-Object 使用し、 MemberName パラメーターと ArgumentList パラメーターの名前を省略します。省略可能です。

例 8: 2 つのスクリプトブロックで ForEach-Object を使用する

この例では、2 つのスクリプトブロックを位置指定して渡します。すべてのスクリプトブロックは Process パラメーターにバインドされます。ただし、 これらは Begin パラメーターと Process パラメーターに渡されたかのように扱われます。

1..2 | ForEach-Object { 'begin' } { 'process' }

begin
process
process

例 9: 2 つ以上のスクリプトブロックで ForEach-Object を使用する

この例では、4 つのスクリプトブロックを位置指定して渡します。すべてのスクリプトブロックは Process パラメーターにバインドされます。ただし、これらは Begin、 Process、 End の各パラメーターに渡されたかのように扱われます。

1..2 | ForEach-Object { 'begin' } { 'process A' }  { 'process B' } { 'end' }

begin
process A
process B
process A
process B
end

注意

最初のスクリプトブロックは常にブロックに begin マップされ、最後のブロックはブロックに end マップされ、2 つの中間ブロックはブロックに process マップされます。

例 10: パイプライン項目ごとに複数のスクリプトブロックを実行する

前の例に示すように、 Process パラメーターを使用して渡された複数のスクリプトブロックが Begin パラメーターと End パラメーターにマップされます。このマッピングを回避するには、 Begin パラメーターと End パラメーターに明示的な値を指定する必要があります。

1..2 | ForEach-Object -Begin $null -Process { 'one' }, { 'two' }, { 'three' } -End $null

one
two
three
one
two
three

例 11: 低速スクリプトを並列バッチで実行する

この例では、文字列を評価し、1 秒間スリープするスクリプトブロックを実行します。

$Message = "Output:"

1..8 | ForEach-Object -Parallel {
    "$using:Message $_"
    Start-Sleep 1
} -ThrottleLimit 4

Output: 1
Output: 2
Output: 3
Output: 4
Output: 5
Output: 6
Output: 7
Output: 8

入力が 4 つのバッチで処理されるように、 ThrottleLimit パラメーター値は 4 に設定されます。 $using: キーワード (keyword)は、各並列スクリプトブロックに変数を$Message渡すために使用されます。

例 12: ログエントリを並列で取得する

この例では、ローカル Windows マシン上の 5 つのシステムログから 50,000 個のログエントリを取得します。

$logNames = 'Security', 'Application', 'System', 'Windows PowerShell',
    'Microsoft-Windows-Store/Operational'

$logEntries = $logNames | ForEach-Object -Parallel {
    Get-WinEvent -LogName $_ -MaxEvents 10000
} -ThrottleLimit 5

$logEntries.Count

50000

Parallel パラメーターは、入力ログ名ごとに並列実行されるスクリプトブロックを指定します。 ThrottleLimit パラメーターを使用すると、5 つのスクリプトブロックすべてが同時に実行されます。

例 13: ジョブとして並列で実行する

この例では、スクリプトブロックを同時に 2 つずつ実行するジョブを作成します。

PS> $job = 1..10 | ForEach-Object -Parallel {
    "Output: $_"
    Start-Sleep 1
} -ThrottleLimit 2 -AsJob

PS> $job

Id     Name            PSJobTypeName   State         HasMoreData     Location      Command
--     ----            -------------   -----         -----------     --------      -------
23     Job23           PSTaskJob       Running       True            PowerShell    …

PS> $job.ChildJobs

Id     Name            PSJobTypeName   State         HasMoreData     Location      Command
--     ----            -------------   -----         -----------     --------      -------
24     Job24           PSTaskChildJob  Completed     True            PowerShell    …
25     Job25           PSTaskChildJob  Completed     True            PowerShell    …
26     Job26           PSTaskChildJob  Running       True            PowerShell    …
27     Job27           PSTaskChildJob  Running       True            PowerShell    …
28     Job28           PSTaskChildJob  NotStarted    False           PowerShell    …
29     Job29           PSTaskChildJob  NotStarted    False           PowerShell    …
30     Job30           PSTaskChildJob  NotStarted    False           PowerShell    …
31     Job31           PSTaskChildJob  NotStarted    False           PowerShell    …
32     Job32           PSTaskChildJob  NotStarted    False           PowerShell    …
33     Job33           PSTaskChildJob  NotStarted    False           PowerShell    …

ThrottleLimit パラメーターは、一度に実行される並列スクリプトブロックの数を制限します。 AsJob パラメーターを指定すると、ForEach-Objectコンソールに出力をストリーミングする代わりに、コマンドレットからジョブオブジェクトが返されます。変数は $job 、出力データを収集し、実行中の状態を監視するジョブオブジェクトを受け取ります。プロパティには $job.ChildJobs 、並列スクリプトブロックを実行する子ジョブが含まれています。

例 14: スレッドセーフ変数参照の使用

この例では、スクリプトブロックを並列で呼び出して、一意の名前の Process オブジェクトを収集します。

$threadSafeDictionary = [System.Collections.Concurrent.ConcurrentDictionary[string,object]]::new()
Get-Process | ForEach-Object -Parallel {
    $dict = $using:threadSafeDictionary
    $dict.TryAdd($_.ProcessName, $_)
}

$threadSafeDictionary["pwsh"]

NPM(K)    PM(M)      WS(M)     CPU(s)      Id  SI ProcessName
 ------    -----      -----     ------      --  -- -----------
     82    82.87     130.85      15.55    2808   2 pwsh

ConcurrentDictionary オブジェクトの 1 つのインスタンスが各スクリプトブロックに渡され、オブジェクトが収集されます。 ConcurrentDictionary はスレッドセーフであるため、各並列スクリプトで変更しても安全です。 System.Collections.Generic.Dictionary などのスレッドセーフでないオブジェクトは、ここで使用しても安全ではありません。

注意

この例は、 Parallel パラメーターの非効率的な使用です。スクリプトは、入力オブジェクトを同時実行ディクショナリオブジェクトに追加します。これは簡単であり、個別のスレッドで各スクリプトを呼び出すオーバーヘッドの価値はありません。並列スイッチなしでの実行ForEach-Objectは、より効率的で高速です。この例は、スレッドセーフ変数の使用方法を示すことを目的としています。

例 15: 並列実行によるエラーの書き込み

この例では、書き込まれたエラーの順序がランダムである並列でエラーストリームに書き込みます。

1..3 | ForEach-Object -Parallel {
    Write-Error "Error: $_"
}

Write-Error: Error: 1
Write-Error: Error: 3
Write-Error: Error: 2

例 16: 並列実行でのエラーの終了

この例では、1 つの並列実行スクリプトブロックで終了エラーを示します。

1..5 | ForEach-Object -Parallel {
    if ($_ -eq 3)
    {
        throw "Terminating Error: $_"
    }

    Write-Output "Output: $_"
}

Exception: Terminating Error: 3
Output: 1
Output: 4
Output: 2
Output: 5

Output: 3 は、そのイテレーションの並列スクリプトブロックが終了したため、書き込まれることはありません。

注意

PipelineVariable 共通パラメーター変数は、キーワード (keyword)を使用する場合でも、シナリオではForeach-Object -Parallel$using: サポートされません。

例 17: 入れ子になった並列スクリプト ScriptBlockSet で変数を渡す

スコープ付きスクリプトブロックの外部に変数をForeach-Object -Parallel作成し、スクリプトブロック内でキーワード (keyword)で$using使用できます。

$test1 = 'TestA'
1..2 | Foreach-Object -Parallel {
    $using:test1
}

TestA
TestA

# You CANNOT create a variable inside a scoped scriptblock
# to be used in a nested foreach parallel scriptblock.
$test1 = 'TestA'
1..2 | Foreach-Object -Parallel {
    $using:test1
    $test2 = 'TestB'
    1..2 | Foreach-Object -Parallel {
        $using:test2
    }
}

Line |
   2 |  1..2 | Foreach-Object -Parallel {
     |         ~~~~~~~~~~~~~~~~~~~~~~~~~~
     | The value of the using variable '$using:test2' can't be retrieved because it has
     | not been set in the local session.

入れ子になった scriptblock は変数に $test2 アクセスできないため、エラーがスローされます。

例 18: スクリプトを並列で実行する複数のジョブを作成する

ThrottleLimit パラメーターは、の各インスタンスで実行される並列スクリプトの ForEach-Object -Parallel数を制限します。 AsJob パラメーターを使用するときに作成できるジョブの数は制限されません。ジョブ自体は同時に実行されるため、複数の並列ジョブを作成し、それぞれが同時実行スクリプトブロックのスロットル制限数まで実行できます。

$jobs = for ($i=0; $i -lt 10; $i++) {
    1..10 | ForEach-Object -Parallel {
        ./RunMyScript.ps1
    } -AsJob -ThrottleLimit 5
}

$jobs | Receive-Job -Wait

この例では、実行中のジョブを 10 個作成します。各ジョブでは、5 つのスクリプトが同時に実行されなくなります。同時に実行されるインスタンスの合計数は 50 に制限されます ( ThrottleLimit の 5 の 10 個のジョブの倍)。

パラメーター

-ArgumentList

メソッド呼び出しに対する引数の配列を指定します。 ArgumentList の動作の詳細については、「about_Splatting」を参照してください。

このパラメーターは Windows PowerShell 3.0 で導入されました。

Type:	Object[]
Aliases:	Args
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-AsJob

並列呼び出しを PowerShell ジョブとして実行します。実行中のスクリプトブロックからの出力ではなく、1 つのジョブオブジェクトが返されます。ジョブオブジェクトには、実行される各並列スクリプトブロックの子ジョブが含まれています。ジョブオブジェクトを PowerShell ジョブコマンドレットと共に使用して、実行中の状態を確認し、データを取得できます。

このパラメーターは、PowerShell 7.0 で導入されました。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Begin

このコマンドレットが入力オブジェクトを処理する前に実行されるスクリプトブロックを指定します。このスクリプトブロックは、パイプライン全体に対して 1 回だけ実行されます。ブロックの begin 詳細については、「 about_Functions」を参照してください。

Type:	ScriptBlock
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-End

このコマンドレットがすべての入力オブジェクトを処理した後に実行されるスクリプトブロックを指定します。このスクリプトブロックは、パイプライン全体に対して 1 回だけ実行されます。ブロックの end 詳細については、「 about_Functions」を参照してください。

Type:	ScriptBlock
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

入力オブジェクトを指定します。 ForEach-Object は、各入力オブジェクトに対してスクリプトブロックまたは操作ステートメントを実行します。オブジェクトが格納されている変数を入力するか、オブジェクトを取得するコマンドまたは式を入力します。

コマンドの結果をにパイプするのではなく、 InputObject パラメーターをと共 ForEach-Objectに ForEach-Object使用すると、 InputObject 値は 1 つのオブジェクトとして扱われます。これは、値がコマンドの結果であるコレクションである場合でも当てはまります (例: -InputObject (Get-Process))。 InputObject は、配列またはオブジェクトのコレクションから個々のプロパティを返すことができるので、を使用ForEach-Objectして、定義されたプロパティに特定の値を持つオブジェクトのオブジェクトのコレクションに対して操作を実行する場合は、このトピックの例に示すようにパイプラインでを使用ForEach-Objectすることをお勧めします。

Type:	PSObject
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-MemberName

取得するメンバープロパティの名前、または呼び出すメンバーメソッドを指定します。メンバーは、静的メンバーではなく、インスタンスメンバーである必要があります。

ワイルドカード文字は使用できますが、結果の文字列が一意の値に解決される場合にのみ機能します。たとえば、を実行 Get-Process | ForEach -MemberName *Nameすると、ワイルドカードパターンが複数のメンバーと一致し、コマンドが失敗します。

このパラメーターは Windows PowerShell 3.0 で導入されました。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	True

-Parallel

入力オブジェクトの並列処理に使用するスクリプトブロックを指定します。操作を記述するスクリプトブロックを入力します。

このパラメーターは、PowerShell 7.0 で導入されました。

Type:	ScriptBlock
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Process

各入力オブジェクトに対して実行される操作を指定します。このスクリプトブロックは、パイプライン内のすべてのオブジェクトに対して実行されます。ブロックの process 詳細については、「 about_Functions」を参照してください。

Process パラメーターに複数のスクリプトブロックを指定すると、最初のスクリプトブロックは常にブロックにbeginマップされます。スクリプトブロックが 2 つしかない場合、2 番目のブロックはブロックに process マップされます。 3 つ以上のスクリプトブロックがある場合、最初のスクリプトブロックは常にブロックに begin マップされ、最後のブロックはブロックに end マップされ、中央のブロックはブロックに process マップされます。

Type:	ScriptBlock[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-RemainingScripts

Process パラメーターによって取得されないすべてのスクリプトブロックを指定します。

このパラメーターは Windows PowerShell 3.0 で導入されました。

Type:	ScriptBlock[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ThrottleLimit

並列で実行されるスクリプトブロックの数を指定します。入力オブジェクトは、実行中のスクリプトブロック数が ThrottleLimit を下回るまでブロックされます。既定値は 5 です。

ThrottleLimit パラメーターは、の各インスタンスで実行される並列スクリプトの ForEach-Object -Parallel数を制限します。 AsJob パラメーターを使用するときに作成できるジョブの数は制限されません。ジョブ自体は同時に実行されるため、複数の並列ジョブを作成し、それぞれが同時スクリプトブロックのスロットル制限数まで実行できます。

このパラメーターは、PowerShell 7.0 で導入されました。

Type:	Int32
Position:	Named
Default value:	5
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TimeoutSeconds

すべての入力が並列に処理されるまで待機する秒数を指定します。指定したタイムアウト時間が経過すると、実行中のすべてのスクリプトが停止します。また、処理する残りの入力オブジェクトはすべて無視されます。の既定値 0 はタイムアウトを無効にし ForEach-Object -Parallel 、無期限に実行できます。コマンドラインで CtrlCを+入力すると、実行中ForEach-Object -Parallelのコマンドが停止します。このパラメーターを AsJob パラメーターと共に使用することはできません。

このパラメーターは、PowerShell 7.0 で導入されました。

Type:	Int32
Position:	Named
Default value:	0
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UseNewRunspace

並列呼び出しでは、実行空間プールから実行空間を再利用するのではなく、ループの繰り返しごとに新しい実行空間を作成します。

このパラメーターは PowerShell 7.1 で導入されました

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。コマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

PSObject

任意のオブジェクトをこのコマンドレットにパイプできます。

出力

PSObject

このコマンドレットは、入力によって決定されるオブジェクトを返します。

メモ

PowerShell には、の次のエイリアスが ForEach-Object含まれています。

すべてのプラットフォーム:
- %
- foreach

コマンドレットは ForEach-ObjectForeach ステートメントとよく似ていますが、 Foreach ステートメントに入力をパイプすることはできません。 Foreach ステートメントの詳細については、「about_Foreach」を参照してください。

PowerShell 4.0 以降では、 Where コレクションで使用するメソッドと ForEach メソッドが追加されました。これらの新しいメソッドの詳細については、こちらを参照してくださいabout_arrays

ForEach-Object -Parallelの使用

ForEach-Object -Parallel は、新しい実行空間内の各スクリプトブロックを実行します。新しい実行空間では、順次処理で実行 ForEach-Object するよりも大幅に多くのオーバーヘッドが発生します。並列実行のオーバーヘッドがスクリプトブロックで実行される作業と比較して小さい場合は、 Parallel を使用することが重要です。例:
- マルチコアマシンでのコンピューティング集中型スクリプト
- 結果の待機またはファイル操作の実行に時間を費やすスクリプト
Parallel パラメーターを使用すると、スクリプトの実行速度が通常より大幅に遅くなる可能性があります。特に、並列スクリプトが簡単な場合は。 Parallel を試して、それが有益な場所を見つける。
並列で実行する場合、 ScriptProperties または ScriptMethods で修飾されたオブジェクトは、スクリプトが最初にアタッチされていたのとは異なる実行空間で実行されている場合、正しく機能することが保証されません。

Scriptblock 呼び出しは、実際に呼び出される場所に関係なく、常に ホーム 実行空間で実行を試みます。ただし、 ForEach-Object -Parallel 使用後に削除される一時的な実行空間が作成されるため、スクリプトをで実行するための実行空間はなくなりました。

この動作は、 ホーム ランスペースがまだ存在する限り機能します。ただし、スクリプトが呼び出し元の実行空間にのみ存在し、 ホーム 実行空間に存在しない外部変数に依存している場合は、目的の結果が得られない可能性があります。
終了しないエラーは、スクリプトブロックの並列実行で発生すると、コマンドレットエラーストリームに書き込まれます。並列スクリプトブロックの実行順序は非決定的であるため、エラーストリームにエラーが出現する順序はランダムです。同様に、警告、詳細、情報などの他のデータストリームに書き込まれたメッセージは、不確定な順序でそれらのデータストリームに書き込まれます。

例外などの終了エラーは、発生するスクリプトブロックの個々の並列インスタンスを終了します。 1 つのスクリプトブロックで終了エラーが発生しても、コマンドレットが終了 Foreach-Object しない可能性があります。並列で実行されている他のスクリプトブロックも、終了エラーが発生しない限り、引き続き実行されます。終了エラーは、 の FullyQualifiedErrorIdPSTaskExceptionを持つ ErrorRecord としてエラー データストリームに書き込まれます。終了エラーは、PowerShell try/catch または trap ブロックを使用して、終了しないエラーに変換できます。
PipelineVariable 共通パラメーター変数は、キーワード (keyword)の場合でも並列シナリオでは$using:サポートされません。

重要

パラメーターセットは ForEach-Object -Parallel 、個別のプロセススレッドでスクリプトブロックを並列に実行します。 $using: キーワード (keyword)を使用すると、コマンドレット呼び出しスレッドから実行中の各スクリプトブロックスレッドに変数参照を渡すことができます。スクリプトブロックは異なるスレッドで実行されるため、参照渡しで渡されるオブジェクト変数は安全に使用する必要があります。一般に、変更されない参照先オブジェクトから読み取ると安全です。オブジェクトの状態を変更する必要がある場合は、.NET System.Collection.Concurrent 型などのスレッドセーフオブジェクトを使用する必要があります (例 14 を参照)。

次の方法で共有

ForEach-Object

構文

説明

例

例 1: 配列内の整数を除算する

例 2: ディレクトリ内のすべてのファイルの長さを取得する

例 3: 最新のシステム イベントを操作する

例 4: レジストリ キーの値を変更する

例 5: $null自動変数を使用する

例 6: プロパティ値を取得する

例 7: モジュール名をコンポーネント名に分割する

例 8: 2 つのスクリプト ブロックで ForEach-Object を使用する

例 9: 2 つ以上のスクリプト ブロックで ForEach-Object を使用する

例 10: パイプライン項目ごとに複数のスクリプト ブロックを実行する

例 11: 低速スクリプトを並列バッチで実行する

例 12: ログ エントリを並列で取得する

例 13: ジョブとして並列で実行する

例 14: スレッド セーフ変数参照の使用

例 15: 並列実行によるエラーの書き込み

例 16: 並列実行でのエラーの終了

例 17: 入れ子になった並列スクリプト ScriptBlockSet で変数を渡す

例 18: スクリプトを並列で実行する複数のジョブを作成する

パラメーター

-ArgumentList

-AsJob

-Begin

-Confirm

-End

-InputObject

-MemberName

-Parallel

-Process

-RemainingScripts

-ThrottleLimit

-TimeoutSeconds

-UseNewRunspace

-WhatIf

入力

出力

メモ

関連リンク

その他のリソース

例 3: 最新のシステムイベントを操作する

例 4: レジストリキーの値を変更する

例 8: 2 つのスクリプトブロックで ForEach-Object を使用する

例 9: 2 つ以上のスクリプトブロックで ForEach-Object を使用する

例 10: パイプライン項目ごとに複数のスクリプトブロックを実行する

例 12: ログエントリを並列で取得する

例 14: スレッドセーフ変数参照の使用