Suspend-Job
暫時停止工作流程工作。
Syntax
Suspend-Job
[-Force]
[-Wait]
[-Id] <Int32[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]Suspend-Job
[-Job] <Job[]>
[-Force]
[-Wait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Suspend-Job
[-Force]
[-Wait]
[-Filter] <Hashtable>
[-WhatIf]
[-Confirm]
[<CommonParameters>]Suspend-Job
[-Force]
[-Wait]
[-State] <JobState>
[-WhatIf]
[-Confirm]
[<CommonParameters>]Suspend-Job
[-Force]
[-Wait]
[-InstanceId] <Guid[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]Suspend-Job
[-Force]
[-Wait]
[-Name] <String[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
Suspend-Job Cmdlet 會暫停工作流程作業。 暫止表示暫時中斷或暫停工作流程作業。 此 Cmdlet 可讓正在執行工作流程的使用者暫停工作流程。 它補充 Suspend-Workflowhttps://go.microsoft.com/fwlink/?LinkId=267141 活動，這是暫止工作流程中的命令。
Suspend-Job Cmdlet 只能在工作流程工作上使用。 它不適用於標準背景工作，例如使用 Start-Job Cmdlet 所啟動的背景工作。
若要識別工作流程工作，請尋找工作之 PSJobTypeName 屬性中 PSWorkflowJob 的值。 若要判斷特定自訂工作類型是否支援 Suspend-Job Cmdlet，請參閱自訂工作類型的說明主題。
當您暫停工作流程工作時，工作流程工作會執行至下一個檢查點，接著暫停，然後立即傳回工作流程工作物件。 若要等候暫停在取得作業之前完成，請使用 Suspend-Job 或 Wait-Job Cmdlet 的 Wait 參數。 當工作流程作業暫停時，作業的 State 屬性值為 Suspended。
是否能夠正確暫停需依賴檢查點。 目前的作業狀態、元數據和輸出會儲存在檢查點中，以便繼續工作流程作業，而不會遺失狀態或數據。 如果工作流程作業沒有檢查點，就無法正確暫停。 若要新增檢查點至您正在執行的工作流程，請使用 PSPersist 工作流程一般參數。 您可以使用 Force 參數立即暫停任何工作流程作業，並暫停沒有檢查點的工作流程作業，但動作可能會導致狀態和數據遺失。
在自定義作業類型上使用作業 Cmdlet 之前，例如工作流程工作 (PSWorkflowJob) 匯入支援自定義作業類型的模組，方法是使用 Import-Module Cmdlet 或使用 模組中的 Cmdlet。
此 Cmdlet 是在 Windows PowerShell 3.0 中引進。
範例
範例 1：依名稱暫停工作流程工作
The first command creates the Get-SystemLog workflow. The workflow uses the CheckPoint-Workflow activity to define a checkpoint in the workflow.
#Sample WorkflowWorkflow Get-SystemLog
{
$Events = Get-WinEvent -LogName System
CheckPoint-Workflow
InlineScript {\\Server01\Scripts\Analyze-SystemEvents.ps1 -Events $Events}
}
The second command uses the *AsJob* parameter that is common to all workflows to run the Get-SystemLog workflow as a background job. The command uses the *JobName* workflow common parameter to specify a friendly name for the workflow job.
PS C:\> Get-SystemLog -AsJob -JobName "Get-SystemLogJob"
The third command uses the **Get-Job** cmdlet to get the Get-SystemLogJob workflow job. The output shows that the value of the **PSJobTypeName** property is PSWorkflowJob.
PS C:\> Get-Job -Name Get-SystemLogJob
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
4 Get-SystemLogJob PSWorkflowJob Running True localhost Get-SystemLog
The fourth command uses the **Suspend-Job** cmdlet to suspend the Get-SystemLogJob job. The job runs to the checkpoint and then suspends.
PS C:\> Suspend-Job -Name Get-SystemLogJob
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
4 Get-SystemLogJob PSWorkflowJob Suspended True localhost Get-SystemLog此範例顯示如何暫停工作流程工作。
範例 2：暫停和繼續工作流程工作
The first command suspends the LogWorkflowJob job.The command returns immediately. The output shows that the workflow job is still running, even though it is being suspended.
PS C:\> Suspend-Job -Name LogWorkflowJob
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
67 LogflowJob PSWorkflowJob Running True localhost LogWorkflow
The second command uses the **Get-Job** cmdlet to get the LogWorkflowJob job. The output shows that the workflow job suspended successfully.
PS C:\> Get-Job -Name LogWorkflowJob
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
67 LogflowJob PSWorkflowJob Suspended True localhost LogWorkflow
The third command uses the **Get-Job** cmdlet to get the LogWorkflowJob job and the Resume-Job cmdlet to resume it. The output shows that the workflow job resumed successfully and is now running.
PS C:\> Get-Job -Name LogWorkflowJob | Resume-Job
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
67 LogflowJob PSWorkflowJob Running True localhost LogWorkflow此範例顯示如何暫停及繼續工作流程工作。
範例 3：在遠端計算機上暫停工作流程工作
PS C:\> Invoke-Command -ComputerName Srv01 -Scriptblock {Suspend-Job -Filter @{CustomID="031589"}此命令會使用 Invoke-Command Cmdlet 在 Srv01 遠端電腦上暫停工作流程作業。 Filter 參數的值是指定 CustomID 值的哈希表。 此 CustomID 為工作中繼資料 (PSPrivateMetadata)。
範例 4：等候工作流程工作暫停
PS C:\> Suspend-Job VersionCheck -Wait
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
5 VersionCheck PSWorkflowJob Suspended True localhost LogWorkflow此命令會暫停 VersionCheck 工作流程工作。 命令會使用 Wait 參數以等待工作流程工作暫停。 當工作流程作業執行至下一個檢查點並暫停時，命令會完成並傳回作業物件。
範例 5：強制工作流程工作暫停
PS C:\> Suspend-Job Maintenance -Force此命令會強制暫停 Maintenance 工作流程工作。 維護作業沒有檢查點。 無法正確暫停，而且可能無法正確繼續。
參數
-Confirm
在執行 Cmdlet 前提示您確認。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
指定條件的雜湊表。 此 Cmdlet 會暫停滿足所有條件的作業。 輸入索引鍵為工作屬性且值為工作屬性值的雜湊表。
| Type: | Hashtable |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Force
立即暫停工作流程工作。 此動作可能會導致狀態和數據遺失。
依照預設，Suspend-Job 會讓工作流程工作執行到下一個檢查點，然後暫停工作。 您也可以使用此參數來暫停沒有檢查點的工作流程工作。
| Type: | SwitchParameter |
| Aliases: | F |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Id
指定此 Cmdlet 暫停的作業識別碼。
識別碼是一個整數，可唯一識別目前工作階段中的工作。 記住和輸入比實例標識碼更容易，但只在目前的會話中是唯一的。 您可以輸入一個或多個識別碼，以逗號分隔。 若要尋找作業的標識碼，請使用 Get-Job Cmdlet。
| 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 停止的工作流程作業。 輸入包含工作流程工作的變數，或輸入可取得工作流程工作的命令。 您也可以使用管線將工作流程工作傳送至 Suspend-Job Cmdlet。
| 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 只停止處於指定狀態的工作。 此參數可接受的值為：
- NotStarted
- 執行中
- Completed
- 失敗
- 已停止
- 封鎖
- 暫止
- 已中斷連接
- Suspending
- 停止中
Suspend-Job 只會暫停處於 執行 中狀態的工作流程作業。
如需作業狀態的詳細資訊，請參閱 MSDN 連結庫中的 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 |
-Wait
指出這個 Cmdlet 會隱藏命令提示字元，直到工作流程作業處於暫停狀態為止。 根據預設， Suspend-Job 會立即傳回，即使工作流程作業尚未處於暫停狀態也一樣。
Wait 參數相當於將 Suspend-Job 命令管線傳送至 Wait-Job Cmdlet。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
顯示執行 Cmdlet 後會發生的情況。 Cmdlet 並不會執行。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
輸入
您可以使用管線將所有類型的作業傳送至此 Cmdlet。 不過，如果 Suspend-Job 取得不支援類型的作業，則會傳回終止錯誤。
輸出
此 Cmdlet 會傳回暫停的作業。
備註
用於儲存暫停工作的機制與位置可能會視工作類型不同而改變。 例如，暫停的工作流程工作是預設儲存在一般檔案存放區，但是也可以儲存在資料庫中。
如果您送出狀態不是 Running 的工作流程工作，Suspend-Job 會顯示警告訊息。 若要隱藏警告，請使用 WarningAction 一般參數搭配 SilentlyContinue 值。
如果作業不是支持暫停的類型， Suspend-Job 會傳回終止錯誤。
若要尋找暫止的工作流程工作，包括此 Cmdlet 暫停的工作流程作業，請使用 Get-Job Cmdlet 的 State 參數，取得處於暫止狀態的工作流程作業。
部分工作類型具有可防止 Windows PowerShell 暫停工作的選項或屬性。 如果嘗試暫停作業失敗，請確認作業選項和屬性允許暫停。