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 cmdlet 获取 PowerShell 后台作业的结果，例如使用 Start-Job cmdlet 或任何 cmdlet 的 AsJob 参数启动的作业。
你可以获取所有作业的结果，或通过作业的名称、ID、实例 ID、计算机名称、位置或会话或者通过提交作业对象来标识作业。
当你启动 PowerShell 后台作业时，该作业将启动，但是结果不会立即显示。 而该命令将返回一个表示该后台作业的对象。 该作业对象包含有关该作业的有用信息，但是不包含结果。 此方法允许你在作业运行时继续在会话中工作。 有 PowerShell 中的后台作业的详细信息，请参阅 about_Jobs。
Receive-Job cmdlet 获取在提交 Receive-Job 命令之前生成的结果。
如果结果尚不完整，你可以运行其他 Receive-Job 命令获取剩余结果。
默认情况下，作业结果将在你收到它们时从系统中删除，但是你可以使用 Keep 参数来保存这些结果，以便可以再次收到它们。
若要删除作业结果，请再次运行 Receive-Job 命令（不使用 Keep 参数）、关闭会话或使用 Remove-Job cmdlet 从会话中删除该作业。
从 Windows PowerShell 3.0 开始，Receive-Job 还获取自定义作业类型的结果，例如工作流作业和计划作业的实例。
若要使 Receive-Job 能够获取具有自定义作业类型的作结果，可在运行 Receive-Job 命令之前，使用 Import-Module cmdlet 或者使用或获取模块中的 cmdlet，将支持自定义作业类型的模块导入到会话中。
有关特定的自定义作业类型的信息，请参阅自定义作业类型功能的文档。
示例
示例 1：获取特定作业的结果
$job = Start-Job -ScriptBlock {Get-Process}
Receive-Job -Job $job这些命令使用 Receive-Job 的 Job 参数来获取特定作业的结果。
第一个命令使用 Start-Job 启动作业并将作业对象存储在 $job 变量中。
第二个命令使用 Receive-Job cmdlet 来获取作业的结果。
它使用 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 cmdlet。 -Keep 参数还用于允许在第一次查看后再次检索所有聚合流数据。
示例 3：获取多个后台作业的结果
当你使用 Invoke-Command 的 AsJob 参数启动作业时，作业对象将创建在本地计算机上，即使作业在远程计算机上运行也是如此。
因此，你可以使用本地命令来管理作业。
此外，当你使用 AsJob 时，PowerShell 将返回一个包含所与启动的每个作业对应的子作业的作业对象。 在此示例中，该作业对象包含三个子作业，分别对应于每台远程计算机上的每个作业。
# 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此示例显示了如何获取在三台远程计算机上运行的后台作业的结果。
与前面的示例不同，使用 Invoke-Command 运行 Start-Job 命令实际上在三台计算机上的每台计算机上启动了三个独立作业。 结果，该命令返回了三个作业对象，代表在三台不同计算机上本地运行的三个作业。
示例 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
指示此 cmdlet 在返回作业结果后删除作业。
如果作业具有更多结果，则仍会删除该作业，但是 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 cmdlet 远程运行 Receive-Job 命令。
| Type: | String[] |
| Aliases: | Cn |
| Position: | 1 |
| Default value: | All computers available |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-Force
指示此 cmdlet 在作业处于挂起或断开连接状态时继续等待。 默认情况下，当作业处于以下状态之一时，将返回 Receive-Job 的 Wait 参数（或结束等待）：
- 已完成
- 已失败
- 已停止
- 已挂起
- 已断开连接。
仅当命令中也使用 Wait 参数时，Force 参数才有效。
已在 Windows PowerShell 3.0 中引入了此参数。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
指定一个 ID 数组。 此 cmdlet 将获取具有指定 ID 的作业的结果。
ID 是一个整数，用于在当前会话中唯一标识作业。
它比实例 ID 更容易记住和键入，但它仅在当前会话中是唯一的。 你可以键入一个或多个 ID（以逗号分隔）。
若要查找某个作业的 ID，请使用 Get-Job。
| Type: | Int32[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-InstanceId
指定实例 ID 的数组。 此 cmdlet 将获取具有指定实例 ID 的作业的结果。
实例 ID 是一个 GUID，用于在计算机上唯一标识作业。
若要查找作业的实例 ID，请使用 Get-Job cmdlet。
| 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
指示此 cmdlet 将聚合的流数据保存在系统中，即使在你收到这些数据之后也是如此。 默认情况下，使用 Receive-Job 查看后，聚合的流数据将被删除。
关闭会话，或使用 Remove-Job cmdlet 删除作业也会删除聚合的流数据。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Location
指定位置数组。 此 cmdlet 仅获取指定位置中的作业结果。
| Type: | String[] |
| Position: | 1 |
| Default value: | All locations |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
指定一个友好名称数组。 此 cmdlet 将获取具有指定名称的作业的结果。 支持使用通配符。
| Type: | String[] |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-NoRecurse
指示此 cmdlet 仅从指定的作业获取结果。
默认情况下，Receive-Job 还会获取指定作业的所有子作业的结果。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Session
指定会话数组。
此 cmdlet 将获取在指定的 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
指示此 cmdlet 禁止显示命令提示符，直到接收所有作业结果。
默认情况下，Receive-Job 将立即返回可用结果。
默认情况下，Wait 参数将等待作业处于以下状态之一：
- 已完成
- 已失败
- 已停止
- 已挂起
- 已断开连接。
若要指示 Wait 参数在作业状态为 Suspended 或 Disconnected 时继续等待，请使用 Force 参数以及 Wait 参数。
已在 Windows PowerShell 3.0 中引入了此参数。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WriteEvents
指示此 cmdlet 在等待作业完成时报告作业状态更改。
仅当在命令中使用 Wait 参数并且省略 Keep 参数时，此参数才有效。
已在 Windows PowerShell 3.0 中引入了此参数。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WriteJobInResults
指示此 cmdlet 返回作业对象，后跟结果。
仅当在命令中使用 Wait 参数并且省略 Keep 参数时，此参数才有效。
已在 Windows PowerShell 3.0 中引入了此参数。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
输入
可以通过管道将作业对象传递给此 cmdlet。
输出
此 cmdlet 将返回作业中的命令的结果。
备注
PowerShell 包含 Receive-Job 的以下别名：
- 所有平台：
rcjb
相关链接
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈