Wait-Job

  • 參考
模組:
Microsoft.PowerShell.Core

等候會話中執行的一或所有 PowerShell 作業處於終止狀態。

Syntax

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>]

Description

Cmdlet Wait-Job 會等候作業處於終止狀態，然後再繼續執行。 終止狀態為：

  • 已完成
  • 失敗
  • 已停止
  • 暫止
  • 已中斷連接

您可以等到指定的作業，或所有作業都處於終止狀態。 您也可以使用 Timeout 參數來設定作業的等候時間上限，或使用 Force 參數來等候 或 Disconnected 狀態中的Suspended作業。

當作業中的命令完成時， Wait-Job 會傳回作業物件並繼續執行。

您可以使用 Wait-Job Cmdlet 來等候使用 Cmdlet 或 Cmdlet 的 AsJob 參數啟動Start-Job的工作Invoke-Command。 如需工作的詳細資訊，請參閱 about_Jobs。

從 Windows PowerShell 3.0 開始， Wait-Job Cmdlet 也會等候自定義作業類型，例如工作流程作業和排程工作的實例。 若要啟用 Wait-Job 以等候特定類型的作業，請在執行 Cmdlet 之前 Get-Job ，先將支援自定義作業類型的模組匯入會話，方法是使用 Import-Module Cmdlet 或使用 或取得模組中的 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-JobWait-Job 命令都會使用 Invoke-Command Cmdlet 提交至遠端電腦。

這個範例會使用 Wait-Job 來判斷在三部不同計算機上以作業身分執行的命令是否已 Get-Date 完成。

第一個命令會在三部遠端計算機上建立 Windows PowerShell 工作階段 （PSSession），並將其儲存在變數中 $s 。

第二個命令會使用 Invoke-Command 在 Start-Job 中的 $s三個會話中執行。 所有作業都會命名為 Date1。

第三個命令會使用 Invoke-Command 來執行 Wait-Job。 此命令會等候 Date1 每部電腦上的作業完成。 它會將產生的作業物件集合（陣列）儲存在變數中$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}

此範例使用 的 Any 參數 Wait-Job 來判斷目前工作階段中執行之許多作業的第一個處於終止狀態。 它也會示範如何使用 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 會啟動在變數中執行 Get-EventLog 命令的 $c 作業。

命令會使用 Using 範圍修飾詞來$c指出變數是在本機電腦上定義的。 使用範圍修飾詞是在 Windows PowerShell 3.0 中引進的。 如需使用範圍修飾詞的詳細資訊，請參閱about_Remote_Variables。

第四個Wait-Job命令會使用 Invoke-Command 在會話中執行命令。 它會使用 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 參數，為遠端電腦上執行的工作設定最長等候時間。

第一個命令會在三部遠端計算機上建立 PSSession（Server01、Server02 和 Server03），然後將 PSSession 物件儲存在 變數中$s。

第二個命令會使用 Invoke-Command 在 中的每個 PSSession 物件中$s執行 Start-Job 。 它會將產生的作業物件儲存在變數中 $jobs 。

第三個命令會使用 Invoke-Command 在中的每個會話$s中執行Wait-Job。 命令 Wait-Job 會判斷所有命令是否在 30 秒內完成。 它會使用 Timeout 參數的值 30 來建立最長等候時間，然後將命令的結果儲存在變數中 $done 。

在此情況下，在 30 秒之後，只有 Server02 計算機上的命令已完成。 Wait-Job 結束等候，傳回 物件，代表已完成的工作，並顯示命令提示字元。

$done變數包含一個工作物件，代表在 Server02 上執行的作業。

範例 5：等候數個作業的其中一個完成

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

此命令會依標識碼識別三個作業，並等到其中任何一個作業處於終止狀態為止。 第一個作業完成時會繼續執行。

範例 6：等候一段時間，然後允許作業在背景繼續

Wait-Job -Name "DailyLog" -Timeout 120

此命令會等候 120 秒（兩分鐘）讓 DailyLog 作業完成。 如果作業在接下來的兩分鐘內未完成，則執行會繼續，而作業會繼續在背景中執行。

範例 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 的 AsJob 參數，搭配在遠端電腦上啟動的工作Invoke-Command。 使用 AsJob 時，作業會在本機電腦上建立，而且結果會自動傳回至本機電腦，即使作業在遠端電腦上執行也一樣。

這個範例會使用 Wait-Job 來判斷在三部 Get-Process 遠端計算機上會話中執行的命令是否處於終止狀態。

第一個命令會在 三部計算機上建立 PSSession 物件，並將其儲存在變數中 $s 。

第二個命令會使用 Invoke-Command 在 Get-Process 中的 $s三個會話中執行。 此命令會 使用 AsJob 參數，以異步方式執行命令做為作業。 此命令會傳回作業物件，就像使用 Start-Job啟動的作業一樣，作業物件會儲存在變數中 $j 。

第三個命令會使用管線運算符 （|） 將作業物件 $j 傳送至 Wait-Job Cmdlet。 Invoke-Command在此情況下不需要命令，因為作業位於本機計算機上。

範例 10：等候標識符為的作業

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

此命令會等候標識碼值為 1 的作業。

參數

-Any

表示此 Cmdlet 會傳回作業物件，並在任何作業完成時繼續執行。 根據預設，在顯示提示之前， Wait-Job 等候所有指定的作業完成。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

指定條件的哈希表。 此 Cmdlet 會等候符合哈希表中所有條件的工作。 輸入哈希表，其中索引鍵是作業屬性，而值是作業屬性值。

此參數僅適用於自定義作業類型，例如工作流程作業和排程工作。 它不適用於標準作業，例如使用 Start-Job Cmdlet 所建立的作業。 如需此參數支援的相關信息，請參閱作業類型的說明主題。

此參數是在 Windows PowerShell 3.0 中引進的。

Type:Hashtable
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

表示此 Cmdlet 會繼續等候處於「已暫停」或「已中斷連線」狀態的工作。 根據預設，當作業處於下列其中一種狀態時， Wait-Job 會傳回或結束等候：

  • 已完成
  • 失敗
  • 已停止
  • 暫止
  • 已中斷連接

此參數是在 Windows PowerShell 3.0 中引進的。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

指定此 Cmdlet 等候之作業的標識子陣列。

標識碼是整數，可唯一識別目前會話中的作業。 比實例標識碼更容易記住和輸入，但只在目前的會話中是唯一的。 您可以輸入一或多個識別碼，並以逗號分隔。 若要尋找作業的識別碼， 請輸入 Get-Job。

Type:Int32[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InstanceId

指定此 Cmdlet 等候之作業實例識別碼的陣列。 預設值為所有作業。

實例標識碼是可唯一識別計算機上作業的 GUID。 若要尋找作業的實體識別碼，請使用 Get-Job。

Type:Guid[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Job

指定此 Cmdlet 等候的作業。 輸入包含作業物件的變數，或取得作業物件的命令。 您也可以使用管線運算符將作業物件傳送至 Wait-Job Cmdlet。 根據預設， Wait-Job 會等候目前會話中建立的所有作業。

Type:Job[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

指定這個 Cmdlet 等候的作業易記名稱。

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-State

指定作業狀態。 此 Cmdlet 只會等候處於指定狀態的工作。 此參數可接受的值為：

  • 未開始
  • 執行中
  • 已完成
  • 失敗
  • 已停止
  • 已封鎖
  • 暫止
  • 已中斷連接
  • 暫停中
  • 停止中

如需作業狀態的詳細資訊，請參閱 JobState 列舉。

Type:JobState
Accepted values:NotStarted, Running, Completed, Failed, Stopped, Blocked, Suspended, Disconnected, Suspending, Stopping, AtBreakpoint
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Timeout

指定每個作業的等候時間上限，以秒為單位。 默認值 -1 表示 Cmdlet 會等到作業完成為止。 時機會在您提交 Wait-Job 命令時開始，而不是 Start-Job 命令。

如果超過這個時間，即使作業仍在執行，等候也會繼續執行。 命令不會顯示任何錯誤訊息。

Type:Int32
Aliases:TimeoutSec
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

輸入

System.Management.Automation.RemotingJob

您可以使用管線將作業物件傳送至此 Cmdlet。

輸出

System.Management.Automation.PSRemotingJob

此 Cmdlet 會傳回工作對象，這些物件代表處於終止狀態的作業。 如果等候結束時，因為超過 Timeout 參數的值，Wait-Job則不會傳回任何物件。

備註

PowerShell 包含下列的 Wait-Job別名：

  • 所有平臺：
    • wjb

根據預設，當作業處於下列其中一種狀態時， Wait-Job 會傳回或結束等候：

  • 已完成
  • 失敗
  • 已停止
  • 暫止
  • 已中斷連接

若要指示 Wait-Job 繼續等候 Suspended 和 Disconnected 作業，請使用 Force 參數。