Wait-Job
隱藏命令提示字元，直到會話中執行的一或所有 Windows 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>]Description
Wait-Job Cmdlet 會等候 Windows PowerShell 背景工作在顯示命令提示字元之前完成。 您可以等到任何背景工作完成，或等到所有背景工作完成為止，而且您可以設定作業的等候時間上限。
當作業中的命令完成時，Wait-Job 會顯示命令提示字元，並傳回作業物件，以便您將它傳送至另一個命令。
您可以使用 Wait-Job Cmdlet 來等候背景工作，例如使用 Start-Job Cmdlet 啟動的作業，或是 Invoke-Command Cmdlet 的 AsJob 參數。 如需 Windows PowerShell 背景工作的詳細資訊，請參閱about_Jobs。
從 Windows PowerShell 3.0 開始，Wait-Job Cmdlet 也會等候自定義作業類型，例如工作流程作業和排程工作的實例。 若要啟用 Wait-Job 等候特定類型的作業，請在執行 Get-Job Cmdlet 之前，先將支援自定義作業類型的模組匯入會話，方法是使用 Import-Module Cmdlet 或使用 或取得模組中的 Cmdlet。 如需特定自定義作業類型的相關信息，請參閱自定義作業類型功能的檔。
範例
範例 1：等候所有作業
PS C:\> Get-Job | Wait-Job此命令會等候會話中執行的所有背景工作完成。
範例 2：使用 Start-Job 等候遠端電腦上啟動的工作
PS C:\> $s = New-PSSession Server01, Server02, Server03
PS C:\> Invoke-Command -Session $s -ScriptBlock {Start-Job -Name Date1 -ScriptBlock {Get-Date}}
PS C:\> $done = Invoke-Command -Session $s -Command {Wait-Job -Name Date1}
PS C:\> $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 作業完成。 它會將產生的作業物件集合（陣列）儲存在$done變數中。
第四個命令會使用 $done 變數中作業物件陣列的 Count 屬性，來判斷作業的完成數目。
範例 3：判斷第一個背景工作何時完成
PS C:\> $s = New-PSSession (Get-Content Machines.txt)
PS C:\> $c = 'Get-EventLog -LogName System | where {$_.EntryType -eq "error" --and $_.Source -eq "LSASRV"} | Out-File Errors.txt'
PS C:\> Invoke-Command -Session $s -ScriptBlock {Start-Job -ScriptBlock {$Using:c}
PS C:\> Invoke-Command -Session $s -ScriptBlock {Wait-Job -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 命令會啟動背景工作，以在 $c 變數中執行 Get-EventLog 命令。
命令會使用 Using 範圍修飾詞，指出已在本機計算機上定義$c變數。
使用 範圍修飾詞是在 Windows PowerShell 3.0 中引進的。
如需使用 範圍修飾詞
第四個命令會使用 Invoke-Command，在會話中執行 Wait-Job 命令。 它會使用 Any 參數等到遠端電腦上的第一個作業完成為止。
範例 4：設定遠端電腦上的作業等候時間
PS C:\> $s = New-PSSession Server01, Server02, Server03
PS C:\> $jobs = Invoke-Command -Session $s -ScriptBlock {Start-Job -ScriptBlock {Get-Date}}
PS C:\> $done = Invoke-Command -Session $s -ScriptBlock {Wait-Job -Timeout 30}此範例示範如何使用 Wait-Job 的 Timeout 參數，為遠端電腦上執行的作業設定最長的等候時間。
第一個命令會在三部遠端計算機上建立 PSSession（Server01、Server02 和 Server03），然後將 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：等候數個作業的其中一個完成
PS C:\> Wait-Job -id 1,2,5 -Any此命令會依標識碼識別三個作業，並等到其中任何一個作業完成為止。 當第一個作業完成時，命令提示字元會傳回。
範例 6：等候一段時間，然後允許作業在背景繼續
PS C:\> Wait-Job -Name "DailyLog" -Timeout 120此命令會等候 120 秒（兩分鐘）讓 DailyLog 作業完成。 如果作業在接下來的兩分鐘內未完成，則命令提示字元仍會傳回，而且作業會繼續在背景中執行。
範例 7：依名稱等候作業
PS C:\> Wait-Job -Name "Job3"此命令會使用作業名稱來識別要等候的作業。
範例 8：等候本機電腦上的作業以 Start-Job
PS C:\> $j = Start-Job -ScriptBlock {Get-ChildItem *.ps1| where {$_lastwritetime -gt ((Get-Date) - (New-TimeSpan -Days 7))}}
PS C:\> $j | Wait-Job此範例示範如何使用 Wait-Job Cmdlet 搭配本機電腦上啟動的工作，方法是使用 Start-Job。
這些命令會啟動作業，以取得上周新增或更新的 Windows PowerShell 腳本檔案。
第一個命令會使用 Start-Job，在本機計算機上啟動背景工作。 作業會執行 Get-ChildItem 命令，以取得上周新增或更新 .ps1 擴展名的所有檔案。
第三個命令會使用 Wait-Job 等候作業完成。 當作業完成時，命令會顯示作業物件，其中包含作業的相關信息。
範例 9：使用 Invoke-Command 等候遠端電腦上啟動的工作
PS C:\> $s = New-PSSession Server01, Server02, Server03
PS C:\> $j = Invoke-Command -Session $s -ScriptBlock {Get-Process} -AsJob
PS C:\> $j | Wait-Job此範例示範如何使用 Invoke-Command的 AsJob 參數，搭配遠端電腦上啟動的工作使用 Wait-Job。 使用 AsJob時，作業會在本機電腦上建立，而且即使作業在遠端電腦上執行，結果也會自動傳回至本機計算機。
此範例會使用 Wait-Job，來判斷三部遠端電腦上會話中執行的 Get-Process 命令是否已完成。
第一個命令會在三部計算機上建立 PSSession 物件，並將其儲存在 $s 變數中。
第二個命令會使用 Invoke-Command，在$s的三個會話中執行 Get-Process。 此命令會使用 AsJob 參數，以異步方式執行命令作為背景工作。 此命令會傳回作業物件，就像使用 Start-Job啟動的作業一樣，作業物件會儲存在$j變數中。
第三個命令會使用管線運算符 （|） 將 $j 中的作業物件傳送至 Wait-Job Cmdlet。 在此情況下，不需要 Invoke-Command 命令，因為作業位於本機計算機上。
範例 10：等候標識符為的作業
PS C:\> Get-Job
Id Name State HasMoreData Location Command
-- ---- ----- ----------- -------- -------
1 Job1 Completed True localhost,Server01.. get-service
4 Job4 Completed True localhost dir | where
PS C:\> Wait-Job -Id 1此命令會等候標識碼值為 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 會傳回或結束等候：
- 完成
- 失敗
- 停止
- 暫停
- 斷開
此參數是在 Windows PowerShell 3.0 中引進的。
| 類型: | SwitchParameter |
| Position: | Named |
| 預設值: | None |
| 必要: | False |
| 接受管線輸入: | False |
| 接受萬用字元: | False |
-Id
指定此 Cmdlet 等候之作業的標識子陣列。
標識碼是整數，可唯一識別目前會話中的作業。
比實例標識碼更容易記住和輸入，但只在目前的會話中是唯一的。
您可以輸入一或多個識別碼，並以逗號分隔。
若要尋找作業的識別碼，請輸入 Get-Job。
| 類型: | Int32[] |
| Position: | 0 |
| 預設值: | None |
| 必要: | True |
| 接受管線輸入: | True |
| 接受萬用字元: | False |
-InstanceId
指定此 Cmdlet 等候之作業實例識別碼的陣列。 預設值為所有作業。
實例標識碼是可唯一識別計算機上作業的 GUID。 若要尋找作業的實體識別碼，請使用 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
- 運行
- 完成
- 失敗
- 停止
- 封鎖
- 暫停
- 斷開
- 暫停
- 停止
如需作業狀態的詳細資訊，請參閱 MSDN 連結庫中的 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 不會傳回任何物件。
備註
- 根據預設，當作業處於下列其中一個狀態時，Wait-Job 會傳回或結束等候：
- 完成
- 失敗
- 停止
- 暫停
- 已中斷連線：若要指示 等候作業 繼續等候暫停和中斷連線的工作，請使用 Force 參數。