Receive-Job
現在のセッションの PowerShell バックグラウンド ジョブの結果を取得します。
構文
Receive-Job
[-Job] <Job[]>
[[-Location] <String[]>]
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[<CommonParameters>]Receive-Job
[-Job] <Job[]>
[[-ComputerName] <String[]>]
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[<CommonParameters>]Receive-Job
[-Job] <Job[]>
[[-Session] <PSSession[]>]
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[<CommonParameters>]Receive-Job
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[-Name] <String[]>
[<CommonParameters>]Receive-Job
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[-InstanceId] <Guid[]>
[<CommonParameters>]Receive-Job
[-Keep]
[-NoRecurse]
[-Force]
[-Wait]
[-AutoRemoveJob]
[-WriteEvents]
[-WriteJobInResults]
[-Id] <Int32[]>
[<CommonParameters>]説明
コマンドレットはReceive-Job、コマンドレットまたは任意のコマンドレットの AsJob パラメーターを使用Start-Jobして開始されたものなど、PowerShell バックグラウンド ジョブの結果を取得します。
すべてのジョブの結果の取得、名前、ID、インスタンス ID、コンピューター名、場所、セッションによる指定、ジョブ オブジェクトの送信を行うことができます。
PowerShell バックグラウンド ジョブを開始すると、ジョブが開始されますが、結果はすぐには表示されません。 代わりに、バックグラウンド ジョブを表すオブジェクトが返されます。 このジョブ オブジェクトには、ジョブに関する有用な情報が含まれていますが、結果は含まれません。 このメソッドを使用すると、ジョブの実行中にセッションで引き続き作業できます。 PowerShell でのバックグラウンド ジョブの詳細については、「 about_Jobs」を参照してください。
コマンドレットは Receive-Job 、コマンドが送信された時点で生成された結果を Receive-Job 取得します。
結果がまだ完了していない場合は、追加 Receive-Job のコマンドを実行して残りの結果を取得できます。
既定では、ジョブの結果は受信時にシステムから削除されますが、再度受信できるように Keep パラメーターを使用して結果を保存することができます。
ジョブの結果を削除するには、Keep パラメーターをReceive-Job指定せずにコマンドをもう一度実行するか、セッションを閉じるか、 コマンドレットをRemove-Job使用してセッションからジョブを削除します。
Windows PowerShell 3.0 以降では、Receive-Jobワークフロー ジョブやスケジュールされたジョブのインスタンスなど、カスタム ジョブの種類の結果も取得されます。
Receive-Jobカスタム ジョブの種類の結果を取得できるようにするには、 コマンドレットを使用するか、モジュールで コマンドレットを使用Import-Moduleまたは取得して、コマンドをReceive-Job実行する前に、カスタム ジョブの種類をサポートするモジュールをセッションにインポートします。
特定のカスタム ジョブの種類については、カスタムのジョブの種類機能のドキュメントを参照してください。
例
例 1: 特定のジョブの結果を取得する
$job = Start-Job -ScriptBlock {Get-Process}
Receive-Job -Job $jobこれらのコマンドでは、 の Job パラメーター Receive-Job を使用して、特定のジョブの結果を取得します。
最初のコマンドは、 を使用して Start-Job ジョブを開始し、そのジョブ オブジェクトを 変数に $job 格納します。
2 番目のコマンドでは、 コマンドレットを Receive-Job 使用してジョブの結果を取得します。
Job パラメーターを使用して、ジョブを指定しています。
例 2: Keep パラメーターを使用する
$job = Start-Job -ScriptBlock {Get-Service dhcp, fakeservice}
$job | Receive-Job -Keep
Cannot find any service with service name 'fakeservice'.
+ CategoryInfo : ObjectNotFound: (fakeservice:String) [Get-Service], ServiceCommandException
+ FullyQualifiedErrorId : NoServiceFoundForGivenName,Microsoft.PowerShell.Commands.GetServiceCommand
+ PSComputerName : localhost
Status Name DisplayName
------ ---- -----------
Running dhcp DHCP Client
$job | Receive-Job -Keep
Cannot find any service with service name 'fakeservice'.
+ CategoryInfo : ObjectNotFound: (fakeservice:String) [Get-Service], ServiceCommandException
+ FullyQualifiedErrorId : NoServiceFoundForGivenName,Microsoft.PowerShell.Commands.GetServiceCommand
+ PSComputerName : localhost
Status Name DisplayName
------ ---- -----------
Running dhcp DHCP Client次の使用例は、 変数にジョブを $job 格納し、そのジョブを コマンドレットに Receive-Job パイプします。 パラメーターは、最初の -Keep ビューの後にすべての集計ストリーム データを再度取得できるようにするためにも使用されます。
例 3: 複数のバックグラウンド ジョブの結果を取得する
の AsJob パラメーター Invoke-Command を使用してジョブを開始すると、ジョブがリモート コンピューターで実行されている場合でも、ジョブ オブジェクトがローカル コンピューターに作成されます。
その結果、ジョブを管理するには、ローカルのコマンドを使用することになります。
また、 AsJob を使用すると、PowerShell は、開始された各ジョブの子ジョブを含む 1 つのジョブ オブジェクトを返します。 この例では、ジョブ オブジェクトには、各リモート コンピューターのジョブに 1 つずつ、合計 3 つの子ジョブが含まれます。
# Use the Invoke-Command cmdlet with the -AsJob parameter to start a background job that runs a Get-Service command on three remote computers.
# Store the resulting job object in the $j variable
$j = Invoke-Command -ComputerName Server01, Server02, Server03 -ScriptBlock {Get-Service} -AsJob
# Display the value of the **ChildJobs** property of the job object in $j.
# The display shows that the command created three child jobs, one for the job on each remote computer.
# You could also use the -IncludeChildJobs parameter of the Get-Job cmdlet.
$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
# Use the Receive-Job cmdlet to get the results of just the Job3 child job that ran on the Server02 computer.
# Use the *Keep* parameter to allow you to view the aggregated stream data more than once.
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例 4: 複数のリモート コンピューターでバックグラウンド ジョブの結果を取得する
# Use the New-PSSession cmdlet to create three user-managed PSSessions on three servers, and save the sessions in the $s variable.
$s = New-PSSession -ComputerName Server01, Server02, Server03
# Use Invoke-Command run a Start-Job command in each of the PSSessions in the $s variable.
# The creates a new job with a custom name to each server
# The job outputs the datetime from each server
# Save the job objects in the $j variable.
$j = Invoke-Command -Session $s -ScriptBlock {Start-Job -Name $('MyJob-' +$env:COMPUTERNAME) -ScriptBlock {(Get-Date).ToString()}}
# To confirm that these job objects are from the remote machines, run Get-Job to show no local jobs running.
Get-Job
# Display the three job objects in $j.
# Note that the Localhost location is not the local computer, but instead localhost as it relates to the job on each Server.
$j
Id Name State HasMoreData Location Command
-- ---- ----- ----------- -------- -------
1 MyJob-Server01 Completed True Localhost (Get-Date).ToString()
2 MyJob-Server02 Completed True Localhost (Get-Date).ToString()
3 MyJob-Server03 Completed True Localhost (Get-Date).ToString()
# Use Invoke-Command to run a Receive-Job command in each of the sessions in the $s variable and save the results in the $results variable.
# The Receive-Job command must be run in each session because the jobs were run locally on each server.
$results = Invoke-Command -Session $s -ScriptBlock {Receive-Job -Name $('MyJob-' +$env:COMPUTERNAME)}
3/22/2021 7:41:47 PM
3/22/2021 7:41:47 PM
3/22/2021 9:41:47 PMこの例は、3 つのリモート コンピューター上で実行されるバックグラウンド ジョブの結果を取得する方法を示しています。
前の例とは異なり、 を使用 Invoke-Command して コマンドを Start-Job 実行すると、実際には 3 台のコンピューターごとに 3 つの独立したジョブが開始されました。 結果として、このコマンドは、3 つの異なるコンピューターでローカルに実行される 3 つのジョブを表す 3 つのジョブ オブジェクトを返します。
例 5: 子ジョブにアクセスする
パラメーターは -Keep 、ジョブを再度表示できるように、ジョブの集計ストリームの状態を保持します。 このパラメーターを指定しないと、ジョブの受信時にすべての集計ストリーム データが消去されます。 詳細については、「about_Job_Details」を参照してください 。
注意
集計されたストリームには、すべての子ジョブのストリームが含まれます。 ジョブ オブジェクトと子ジョブ オブジェクトを使用して、データの個々のストリームに到達できます。
Start-Job -Name TestJob -ScriptBlock {dir C:\, Z:\}
# Without the Keep parameter, aggregated child job data is displayed once.
# Then destroyed.
Receive-Job -Name TestJob
Directory: C:\
Mode LastWriteTime Length Name
---- ------------- ------ ----
d-r--- 1/24/2019 7:11 AM Program Files
d-r--- 2/13/2019 8:32 AM Program Files (x86)
d-r--- 10/3/2018 11:47 AM Users
d----- 2/7/2019 1:52 AM Windows
Cannot find drive. A drive with the name 'Z' does not exist.
+ CategoryInfo : ObjectNotFound: (Z:String) [Get-ChildItem], DriveNotFoundException
+ FullyQualifiedErrorId : DriveNotFound,Microsoft.PowerShell.Commands.GetChildItemCommand
+ PSComputerName : localhost
# It would seem that the child job data is gone.
Receive-Job -Name TestJob
# Using the object model, you can still retrieve child job data and streams.
$job = Get-Job -Name TestJob
$job.ChildJobs[0].Error
Cannot find drive. A drive with the name 'Z' does not exist.
+ CategoryInfo : ObjectNotFound: (Z:String) [Get-ChildItem], DriveNotFoundException
+ FullyQualifiedErrorId : DriveNotFound,Microsoft.PowerShell.Commands.GetChildItemCommand
+ PSComputerName : localhostパラメーター
-AutoRemoveJob
このコマンドレットは、ジョブの結果を返した後にジョブを削除することを示します。
ジョブの結果が多い場合、ジョブはまだ削除されますが Receive-Job 、メッセージが表示されます。
このパラメーターは、カスタムのジョブの種類に対してのみ機能します。 スケジュールされたジョブのインスタンスなど、ジョブやセッションの外部の種類を保存するジョブのインスタンス用に設計されています。
このパラメーターは 、Wait パラメーターなしでは使用できません。
このパラメーターは Windows PowerShell 3.0 で導入されました。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ComputerName
コンピューターの名前の配列を指定します。
このパラメーターは、ローカル コンピューターに格納されているジョブの結果の中から選択します。
リモート コンピューターで実行されるジョブのデータは取得されません。
リモート コンピューターに格納されているジョブの結果を取得するには、 コマンドレットを Invoke-Command 使用してコマンドをリモートで Receive-Job 実行します。
| Type: | String[] |
| Aliases: | Cn |
| Position: | 1 |
| Default value: | All computers available |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-Force
ジョブが 中断 状態または 切断 状態の場合に、このコマンドレットが待機を継続することを示します。 既定では、 の Wait パラメーター Receive-Job は、ジョブが次のいずれかの状態にある場合に待機を返すか終了します。
- 完了
- 失敗
- 停止済み
- Suspended
- [接続解除されました。]
Force パラメーターは、このコマンドで Wait パラメーターも使用されている場合にのみ有効です。
このパラメーターは Windows PowerShell 3.0 で導入されました。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
ID の配列を指定します。 このコマンドレットは、指定された ID を持つジョブの結果を取得します。
ID は、現在のセッションのジョブを一意に識別する整数です。
インスタンス ID よりも覚えて入力する方が簡単ですが、現在のセッションでのみ一意です。 1 つ以上の ID をコンマで区切って入力できます。
ジョブの ID を見つけるには、 を使用します Get-Job。
| Type: | Int32[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InstanceId
インスタンス ID の配列を指定します。 このコマンドレットは、指定されたインスタンス ID を持つジョブの結果を取得します。
インスタンス ID は、コンピューター上のジョブを一意に識別する GUID です。
ジョブのインスタンス ID を見つけるには、 コマンドレットを使用します Get-Job 。
| Type: | Guid[] |
| Position: | 0 |
| Default value: | All instances |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Job
結果を取得するジョブを指定します。
ジョブまたはジョブを取得するコマンドを含む変数を入力します。
ジョブ オブジェクトを に Receive-Jobパイプすることもできます。
| Type: | Job[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Keep
このコマンドレットは、受信した後でも、集計されたストリーム データをシステムに保存することを示します。 既定では、集計されたストリーム データは、 で表示された後に Receive-Job消去されます。
セッションを閉じるか、 コマンドレットを使用してジョブを Remove-Job 削除すると、集計ストリーム データも削除されます。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
場所の配列を指定します。 このコマンドレットは、指定した場所にあるジョブの結果のみを取得します。
| Type: | String[] |
| Position: | 1 |
| Default value: | All locations |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
フレンドリ名の配列を指定します。 このコマンドレットは、指定された名前を持つジョブの結果を取得します。 ワイルドカード文字がサポートされています。
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-NoRecurse
このコマンドレットは、指定したジョブからのみ結果を取得することを示します。
既定では、 は、 Receive-Job 指定したジョブのすべての子ジョブの結果も取得します。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Session
セッションの配列を指定します。
このコマンドレットは、指定された PowerShell セッション (PSSession) で実行されたジョブの結果を取得します。
PSSession を含む変数、または PSSession を取得するコマンド (コマンドなど) をGet-PSSession入力します。
| Type: | PSSession[] |
| Position: | 1 |
| Default value: | All sessions |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Wait
このコマンドレットは、すべてのジョブ結果を受け取るまでコマンド プロンプトを抑制することを示します。
既定では、 Receive-Job すぐに使用可能な結果が返されます。
既定では、Wait パラメーターは、ジョブが次のいずれかの状態になるまで待機します:
- 完了
- 失敗
- 停止済み
- Suspended
- [接続解除されました。]
ジョブの状態が [中断] または [切断] の場合に待機を続行するように Wait パラメーターに指示するには、 Force パラメーターと Wait パラメーターを併用します。
このパラメーターは Windows PowerShell 3.0 で導入されました。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WriteEvents
このコマンドレットは、ジョブの完了を待機している間にジョブ状態の変更を報告することを示します。
このパラメーターは、Wait パラメーターがこのコマンドで使用され、Keep パラメーターが省略される場合にのみ有効です。
このパラメーターは Windows PowerShell 3.0 で導入されました。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WriteJobInResults
このコマンドレットがジョブ オブジェクトを返し、その後に結果が返されることを示します。
このパラメーターは、Wait パラメーターがこのコマンドで使用され、Keep パラメーターが省略される場合にのみ有効です。
このパラメーターは Windows PowerShell 3.0 で導入されました。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
ジョブ オブジェクトをこのコマンドレットにパイプできます。
出力
PSObject
このコマンドレットは、ジョブ内のコマンドの結果を返します。