Receive-Job

構文

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
       [-Name] <string[]>
       [-Keep]
       [-NoRecurse]
       [-Force]
       [-Wait]
       [-AutoRemoveJob]
       [-WriteEvents]
       [-WriteJobInResults]
       [<CommonParameters>]

Receive-Job
       [-InstanceId] <guid[]>
       [-Keep]
       [-NoRecurse]
       [-Force]
       [-Wait]
       [-AutoRemoveJob]
       [-WriteEvents]
       [-WriteJobInResults]
       [<CommonParameters>]

Receive-Job
       [-Id] <int[]>
       [-Keep]
       [-NoRecurse]
       [-Force]
       [-Wait]
       [-AutoRemoveJob]
       [-WriteEvents]
       [-WriteJobInResults]
       [<CommonParameters>]

説明

Receive-Job コマンドレットは、powerShell バックグラウンド ジョブの結果 (Start-Job コマンドレットまたはコマンドレットの AsJob パラメーターを使用して開始されたものなど) を取得します。 すべてのジョブの結果の取得、名前、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}
Start-Sleep -Seconds 1
Receive-Job -Job $job

これらのコマンドでは、Receive-Jobの Job パラメーターを使用して、特定のジョブの結果を取得します。

最初のコマンドは、 Start-Job を使用してジョブを開始し、ジョブ オブジェクトを $job 変数に格納します。

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

例 2: Keep パラメーターを使用する

$job = Start-Job -ScriptBlock {Get-Service dhcp, fakeservice}
Start-Sleep -Seconds 1
$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: 複数のバックグラウンド ジョブの結果を取得する

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

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

# 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 code 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.
$invokeCommandSplat = @{
    Session = $s
    ScriptBlock = {
        Start-Job -Name $('MyJob-' +$env:COMPUTERNAME) -ScriptBlock {
            (Get-Date).ToString()
        }
    }
}
$j = Invoke-Command @invokeCommandSplat
# 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

-ComputerName

-Force

-Id

-InstanceId

-Job

-Keep

-Location

-Name

-NoRecurse

-Session

-Wait

-WriteEvents

-WriteJobInResults

入力

Job

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

出力

PSObject

このコマンドレットは、ジョブ内のコマンドの結果を返します。

メモ

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

• rcjb

関連リンク

• Get-Job
• Invoke-Command
• Remove-Job
• Resume-Job
• Start-Job
• Stop-Job
• Suspend-Job
• Wait-Job