Receive-Job

Receive-Job [-Job] <Job[]> [[-ComputerName] <string[]>] [-Keep] [-NoRecurse] [<CommonParameters>]

Receive-Job [[-InstanceId] <Guid[]>] [-Keep] [-NoRecurse] [<CommonParameters>]

Receive-Job [-Job] <Job[]> [[-Location] <string[]>] [-Keep] [-NoRecurse] [<CommonParameters>]

Receive-Job [[-Name] <string[]>] [-Keep] [-NoRecurse] [<CommonParameters>]

Receive-Job [-Job] <Job[]> [[-Session] <PSSession[]>] [-Keep] [-NoRecurse] [<CommonParameters>]

Receive-Job [-Id] <Int32[]> [-Keep] [-NoRecurse] [<CommonParameters>]

C:\PS>$job = start-job -scriptblock {get-process}

C:\PS> receive-job -job $job

説明
-----------
これらのコマンドは Job パラメーターを使用して、特定のジョブの結果を取得します。最初のコマンドは、Start-Job コマンドレットを使用して、"Get-Process" コマンドを実行するジョブを開始しますこのコマンドは、代入演算子 (=) を使用して、$job 変数に結果のジョブ オブジェクトを保存します。

2 番目のコマンドは、Receive-Job コマンドレットを使用してジョブの結果を取得します。ジョブは Job パラメーターを使用して指定しています。

C:\PS>$job = start-job -scriptblock {get-process}

C:\PS> $job | receive-job

説明
-----------
この例は、コマンドがパイプライン演算子 (|) を使用して、ジョブ オブジェクトを Receive-Job に渡すことを除いて、例 2 と同じです。その結果、コマンドには、ジョブを指定するための Job パラメーターは必要ありません。

C:\PS>$j = invoke-command -computername Server01, Server02, Server03 -scriptblock {get-service} -AsJob

C:\PS> $j.childjobs

Id   Name     State      HasMoreData   Location       Command
--   ----     -----      -----------   --------       -------
2    Job2     Completed  True          Server01       get-service
3    Job3     Completed  True          Server02       get-service
4    Job4     Completed  True          Server03       get-service

C:\PS> receive-job -name Job3  -keep

Status  Name        DisplayName                        PSComputerName
------  ----------- -----------                        --------------
Running AeLookupSvc Application Experience             Server02
Stopped ALG         Application Layer Gateway Service  Server02
Running Appinfo     Application Information            Server02
Running AppMgmt     Application Management             Server02

説明
-----------
これらのコマンドは、Receive-Job の Name パラメーターを使用して、リモート コンピューターで実行される複数のバックグラウンド ジョブのうちの 1 つの結果を取得します。

最初のコマンドは、Invoke-Command コマンドレットを使用して、3 台のリモート コンピューター上で Get-Service コマンドを実行するバックグラウンド ジョブを開始します。また、AsJob パラメーターを使用して、バックグラウンド ジョブとしてコマンドを実行します。このコマンドは、結果のジョブ オブジェクトを $j 変数に保存します。

ジョブを開始するために Invoke-Command の AsJob パラメーターを使用すると、ジョブはリモート コンピューターで実行されますが、ジョブ オブジェクトはローカル コンピューターに作成されます。そのため、ローカル コマンドを使用してジョブを管理します。

また、AsJob を使用すると、Windows PowerShell は、開始された各ジョブに対応する子ジョブを含む 1 つのジョブ オブジェクトを返します。この場合、ジョブ オブジェクトには、各リモート コンピューター上でそれぞれ実行されるジョブに対応する 3 つの子ジョブが含まれます。

2 番目のコマンドは、ドット メソッドを使用して、$j のジョブ オブジェクトの ChildJobs プロパティの値を表示します。この表示には、各リモート コンピューター上でそれぞれ実行されるジョブに対応する 3 つの子ジョブがコマンドによって作成されたことが示されます。
 
3 番目のコマンドは、Receive-Job コマンドレットを使用して、Server02 コンピューターで実行された子ジョブ Job3 の結果を取得します。このコマンドは、子ジョブの名前を指定するために Name パラメーターを、ジョブの結果を取得後も保存するために Keep パラメーターをそれぞれ使用します。

C:\PS>$s = new-pssession -computername Server01, Server02, Server03

C:\PS> $j = invoke-command -session $s -scriptblock {start-job -scriptblock {get-eventlog -logname system}}

C:\PS> $j

Id   Name     State      HasMoreData   Location   Command
--   ----     -----      -----------   --------   -------
1    Job1     Completed  True          Localhost  get-eventlog system
2    Job2     Completed  True          Localhost  get-eventlog system
3    Job3     Completed  True          Localhost  get-eventlog system

C:\PS> $results = invoke-command -session $s -scriptblock {param($j) receive-job -job $j} -ArgumentList $j

説明
-----------
この例は、3 台のリモート コンピューターで実行されるバックグラウンド ジョブの結果を取得する方法を示しています。

最初のコマンドは、New-PSSession コマンドレットを使用して、コマンドで指定された各サーバーでそれぞれ実行される 3 つの PSSession を作成します。PSSession は $s 変数に保存されます。

2 番目のコマンドは、Invoke-Command コマンドレットを使用して、$s 変数の各 PSSession で Start-Job コマンドを実行します。ジョブは、システム ログ内のイベントを取得する Get-Eventlog コマンドを実行します。結果は $j 変数に保存されます。

コマンドは Invoke-Command を使用して Start-Job コマンドを実行したため、実際には 3 台のコンピューターのそれぞれで独立した 3 つのジョブが開始されました。その結果、コマンドは、3 台の異なるコンピューターでローカルに実行された 3 つのジョブを表す 3 つのジョブ オブジェクトを返しました。

3 番目のコマンドは $j の 3 つのジョブ オブジェクトを表示します。

4 番目のコマンドは、Invoke-Command を使用して、$s の各PSSessions で Receive-Job コマンドを実行し、結果を $results 変数に保存します。

$j はローカル変数であるため、スクリプト ブロックは "param" キーワードを使用してコマンドの変数を宣言し、ArgumentList パラメーターを使用して $j の値を指定します。