Wait-Job

模块:

Microsoft.PowerShell.Core

等待会话中运行的一个或所有 PowerShell 作业处于终止状态。

语法

Wait-Job
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [-Id] <Int32[]>
    [<CommonParameters>]

Wait-Job
    [-Job] <Job[]>
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [<CommonParameters>]

Wait-Job
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [-Name] <String[]>
    [<CommonParameters>]

Wait-Job
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [-InstanceId] <Guid[]>
    [<CommonParameters>]

Wait-Job
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [-State] <JobState>
    [<CommonParameters>]

Wait-Job
    [-Any]
    [-Timeout <Int32>]
    [-Force]
    [-Filter] <Hashtable>
    [<CommonParameters>]

说明

Wait-Job cmdlet 等待作业处于终止状态，然后再继续执行。 终止状态为：

• 已完成
• 已失败
• 已停止
• Suspended
• 已断开连接

可以等到指定作业或所有作业都处于终止状态。 还可以使用 Timeout 参数设置作业的最长等待时间，或使用 Force 参数等待处于 Suspended 或 Disconnected 状态的作业。

当作业中的命令完成时，Wait-Job 将返回一个作业对象并继续执行。

可以使用 Wait-Job cmdlet 等待通过使用 Start-Job cmdlet 或 Invoke-Command cmdlet 的 AsJob 参数启动的作业。 有关作业的详细信息，请参阅 about_Jobs。

从 Windows PowerShell 3.0 开始，Wait-Job cmdlet 还将等待自定义作业类型，例如工作流作业和计划作业的实例。 若要使 Wait-Job 能够等待特定类型的作业，请使用 Import-Module cmdlet 或使用或获取模块中的 cmdlet，在运行 Get-Job cmdlet 之前将支持自定义作业类型的模块导入到会话中。 有关特定的自定义作业类型的信息，请参阅自定义作业类型功能的文档。

示例

示例 1：等待所有作业

Get-Job | Wait-Job

此命令等待会话中运行的所有作业完成。

示例 2：等待通过使用 Start-Job 在远程计算机上启动的作业

$s = New-PSSession Server01, Server02, Server03
Invoke-Command -Session $s -ScriptBlock {Start-Job -Name Date1 -ScriptBlock {Get-Date}}
$done = Invoke-Command -Session $s -Command {Wait-Job -Name Date1}
$done.Count

3

此示例演示如何使用 Wait-Job cmdlet 以及通过使用 Start-Job cmdlet 在远程计算机上启动的作业。 Start-Job 和 Wait-Job 命令均使用 Invoke-Command cmdlet 提交到远程计算机。

此示例使用 Wait-Job 来确定在三台不同计算机上作为作业运行的 Get-Date 命令是否已完成。

第一个命令在所有三台远程计算机上创建 Windows PowerShell 会话 (PSSession)，并将这些会话存储在 $s 变量中。

第二个命令使用 Invoke-Command 在 $s 中的三个会话中的每一个中运行 Start-Job。 所有作业都命名为 Date1。

第三个命令使用 Invoke-Command 运行 Wait-Job。 此命令等待每台计算机上的 Date1 作业完成。 它将生成的 job 对象集合（数组）存储在 $done 变量中。

第四个命令使用 $done 变量中作业对象数组的 Count 属性来确定已完成的作业数量。

示例 3：确定第一个作业何时完成

$s = New-PSSession -ComputerName (Get-Content -Path .\Machines.txt)
$c = 'Get-EventLog -LogName System | Where-Object {$PSItem.EntryType -eq "error" --and $PSItem.Source -eq "LSASRV"} | Out-File -FilePath Errors.txt'
Invoke-Command -Session $s -ScriptBlock {Start-Job -ScriptBlock {$Using:c}
Invoke-Command -Session $s -ScriptBlock {Wait-Job -Any}

此示例使用 Wait-Job 的 Any 参数来确定当前会话中运行的多个作业中的第一个作业何时处于终止状态。 它还演示了如何使用 Wait-Job cmdlet 等待远程作业完成。

第一个命令在 Machines.txt 文件中列出的每台计算机上创建一个 PSSession，并将 PSSession 对象存储在 $s 变量中。 该命令使用 Get-Content cmdlet 来获取文件的内容。 将 Get-Content 命令用括号括起，以确保它在 New-PSSession 命令之前运行。

第二个命令将 Get-EventLog 命令字符串（用引号引起来）存储在 $c 变量中。

第三个命令使用 Invoke-Command cmdlet 在 $s 中的每个会话中运行 Start-Job。 Start-Job 命令将启动一个作业，该作业在 $c 变量中运行 Get-EventLog 命令。

该命令使用 Using 作用域修饰符以指示已在本地计算机上定义 $c 变量。 在 Windows PowerShell 3.0 中引入了 Using 作用域修饰符。 有关 Using 作用域修饰符的详细信息，请参阅 about_Remote_Variables。

第四个命令使用 Invoke-Command 在会话中运行 Wait-Job 命令。 它使用 Any 参数等待远程计算机上的第一个作业处于终止状态。

示例 4：设置远程计算机上作业的等待时间

PS> $s = New-PSSession -ComputerName Server01, Server02, Server03
PS> $jobs = Invoke-Command -Session $s -ScriptBlock {Start-Job -ScriptBlock {Get-Date}}
PS> $done = Invoke-Command -Session $s -ScriptBlock {Wait-Job -Timeout 30}
PS>

此示例显示了如何使用 Wait-Job 的 Timeout 参数设置在远程计算机上运行的作业的最长等待时间。

第一个命令在三台远程计算机（Server01、Server02 和 Server03）中的每台计算机上创建一个 PSSession，然后将 PSSession 对象存储在 $s 变量中。

第二个命令使用 Invoke-Command 在 $s 中的每个 PSSession 对象中运行 Start-Job。 它将生成的作业对象存储在 $jobs 变量中。

第三个命令使用 Invoke-Command 在 $s 中的每个会话中运行 Wait-Job。 Wait-Job 命令确定所有命令是否在 30 秒内完成。 它使用值为 30 的 Timeout 参数来确定最长等待时间，然后将命令的结果存储在 $done 变量中。

在此示例中，30 秒后，只有 Server02 计算机上的命令完成。 Wait-Job 将结束等待，返回表示已完成作业的对象，并显示命令提示符。

$done 变量包含一个表示在 Server02 上运行的作业的作业对象。

示例 5：等待多个作业中的一个完成

Wait-Job -id 1,2,5 -Any

此命令通过 ID 识别三个作业，并等待其中任何一个作业处于终止状态。 第一个作业完成后继续执行。

示例 6：等待一段时间，然后允许作业在后台继续

Wait-Job -Name "DailyLog" -Timeout 120

此命令将等待 DailyLog 作业完成，等待时间为 120 秒（2 分钟）。 如果作业在接下来的两分钟内没有完成，则会继续执行命令，并且作业继续在后台运行。

示例 7：按名称等待作业

Wait-Job -Name "Job3"

此命令使用作业名称来标识要等待的作业。

示例 8：等待本地计算机上的作业使用 Start-Job 启动

$j = Start-Job -ScriptBlock {Get-ChildItem -Filter *.ps1| Where-Object {$PSItem.LastWriteTime -gt ((Get-Date) - (New-TimeSpan -Days 7))}}
$j | Wait-Job

此示例演示如何使用 Wait-Job cmdlet 以及使用 Start-Job 在本地计算机上启动的作业。

这些命令启动一个可获取在上一周添加或更新的 Windows PowerShell 脚本文件的作业。

第一个命令使用 Start-Job 在本地计算机上启动作业。 该作业运行 Get-ChildItem 命令，该命令可获取上周添加或更新的所有具有 .ps1 文件扩展名的文件。

第三个命令使用 Wait-Job 等待作业处于终止状态。 作业完成后，该命令将显示包含有关该作业的信息的作业对象。

示例 9：等待通过使用 Invoke-Command 在远程计算机上启动的作业

$s = New-PSSession -ComputerName Server01, Server02, Server03
$j = Invoke-Command -Session $s -ScriptBlock {Get-Process} -AsJob
$j | Wait-Job

此示例展示如何将 Wait-Job 与通过使用 Invoke-Command 的 AsJob 参数在远程计算机上启动的作业结合使用。 使用 AsJob 时，将在本地计算机上创建作业，并自动将结果返回到本地计算机，即使作业运行在远程计算机上也是如此。

此示例使用 Wait-Job 来确定在三台远程计算机上的会话中运行的 Get-Process 命令是否处于终止状态。

第一个命令在三台计算机上创建 PSSession 对象并将它们存储在 $s 变量中。

第二个命令使用 Invoke-Command 在 $s 中的三个会话中的每一个中运行 Get-Process。 该命令使用 AsJob 参数将该命令作为作业异步运行。 该命令返回一个作业对象（就像通过使用 Start-Job 启动的作业那样），并将该作业对象存储在 $j 变量中。

第三个命令使用管道运算符 (|) 将 $j 中的作业对象发送到 Wait-Job cmdlet。 请注意，此示例中不需要 Invoke-Command 命令，因为作业驻留在本地计算机上。

示例 10：等待具有 ID 的作业

Get-Job

Id   Name     State      HasMoreData     Location             Command
--   ----     -----      -----------     --------             -------
1    Job1     Completed  True            localhost,Server01.. get-service
4    Job4     Completed  True            localhost            dir | where

Wait-Job -Id 1

此命令等待 ID 值为 1 的作业。

参数

-Any

指示此 cmdlet 返回作业对象并在任何作业完成时继续执行。 默认情况下，Wait-Job 会等到所有指定作业完成后才显示提示。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Filter

指定条件的哈希表。 此 cmdlet 等待满足哈希表中所有条件的作业。 输入一个哈希表，其中的键为作业属性，其中的值为作业属性值。

此参数仅适用于自定义作业类型，例如工作流作业和计划作业。 它不适用于标准作业，例如那些通过使用 Start-Job cmdlet 创建的作业。 有关支持此参数的信息，请参阅作业类型的帮助主题。

已在 Windows PowerShell 3.0 中引入了此参数。

类型:	Hashtable
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Force

指示此 cmdlet 继续等待处于挂起或断开连接状态的作业。 默认情况下，当作业处于以下状态之一时，Wait-Job 将返回或结束等待：

• 已完成
• 已失败
• 已停止
• Suspended
• 已断开连接

已在 Windows PowerShell 3.0 中引入了此参数。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Id

指定此 cmdlet 等待的作业 ID 数组。

ID 是一个整数，用于在当前会话中唯一标识作业。 它比实例 ID 更容易记住和键入，但它仅在当前会话中是唯一的。 你可以键入一个或多个 ID（以逗号分隔）。 若要查找某个作业的 ID，请键入 Get-Job。

类型:	Int32[]
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-InstanceId

指定此 cmdlet 等待的作业实例 ID 数组。 默认值为所有作业。

实例 ID 是一个 GUID，用于在计算机上唯一标识作业。 若要查找某个作业的实例 ID，请使用 Get-Job。

类型:	Guid[]
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Job

指定此 cmdlet 等待的作业。 输入一个包含作业对象的变量或可获取作业对象的命令。 也可以使用管道运算符将作业对象发送到 Wait-Job cmdlet。 默认情况下，Wait-Job 会等待在当前会话中创建的所有作业。

类型:	Job[]
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Name

指定此 cmdlet 等待的作业的易记名称。

类型:	String[]
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-State

指定作业状态。 此 cmdlet 仅等待处于指定状态的作业。 此参数的可接受值为：

• NotStarted
• 正在运行
• 已完成
• 已失败
• 已停止
• 已阻止
• Suspended
• 已断开连接
• 暂停中
• 正在停止

有关作业状态的详细信息，请参阅 JobState 枚举。

类型:	JobState
接受的值:	NotStarted, Running, Completed, Failed, Stopped, Blocked, Suspended, Disconnected, Suspending, Stopping, AtBreakpoint
Position:	0
默认值:	None
必需:	True
接受管道输入:	True
接受通配符:	False

-Timeout

指定每个作业的最长等待时间（以秒为单位）。 默认值 -1 表示 cmdlet 等待作业完成。 从提交 Wait-Job 命令而不是 Start-Job 命令开始计时。

如果超过此时间，即使作业仍在运行，等待也会结束并继续执行。 该命令不显示任何错误消息。

类型:	Int32
别名:	TimeoutSec
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

输入

System.Management.Automation.RemotingJob

你可以通过管道将作业对象传递给此 cmdlet。

输出

System.Management.Automation.PSRemotingJob

此 cmdlet 将返回表示处于终止状态的作业的作业对象。 如果等待因超过 Timeout 参数的值而结束，则 Wait-Job 不会返回任何对象。

备注

PowerShell 包含 Wait-Job 的以下别名：

• 所有平台：
  • wjb

默认情况下，当作业处于以下状态之一时，Wait-Job 将返回或结束等待：

• 已完成
• 已失败
• 已停止
• Suspended
• 已断开连接

要指示 Wait-Job 继续等待已挂起和已断开连接的作业，请使用 Force 参数。

相关链接

• Get-Job
• Invoke-Command
• Receive-Job
• Remove-Job
• Start-Job
• Stop-Job