Resume-Job
中断されたジョブを再開します。
構文
Resume-Job
[-Wait]
[-Id] <Int32[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Resume-Job
[-Job] <Job[]>
[-Wait]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Resume-Job
[-Wait]
[-Name] <String[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Resume-Job
[-Wait]
[-InstanceId] <Guid[]>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Resume-Job
[-Wait]
[-State] <JobState>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Resume-Job
[-Wait]
[-Filter] <Hashtable>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
コマンドレットはResume-Job
、コマンドレットや about_Suspend ワークフロー アクティビティを使用してSuspend-Job
、中断されたワークフロー ジョブを再開します。 ワークフロー ジョブが再開されると、ジョブ エンジンは、チェックポイントなどの保存されたリソースの状態、メタデータ、出力を再構築します。 ジョブは、状態やデータを失うことなく再起動されます。
ジョブの状態が [中断済み] から [実行中] に変更されます。
パラメーター Resume-Job
を使用して、名前、ID、インスタンス ID、またはコマンドレットによって返されるジョブ オブジェクトなどのパイプでジョブを Get-Job
選択します Resume-Job
。 プロパティ フィルターを使用して再開するジョブを選択することもできます。
既定では、 Resume-Job
すべてのジョブがまだ再開されていない可能性がある場合でも、すぐに返されます。 指定したすべてのジョブが再開されるまでコマンド プロンプトを非表示にするには、Wait パラメーターを使用します。
このコマンドレットは Resume-Job
、ワークフロー ジョブなどのカスタム ジョブの種類でのみ機能します。 コマンドレットを使用 Start-Job
して開始されるジョブなど、標準のバックグラウンド ジョブでは機能しません。 サポートされていない種類のジョブを送信すると、 Resume-Job
終了エラーが生成され、実行が停止します。
ワークフロー ジョブを識別するには、ジョブの PSJobTypeName プロパティで PSWorkflowJob の値を探します。 特定のカスタム ジョブの種類でコマンドレットが Resume-Job
サポートされているかどうかを確認するには、カスタム ジョブの種類のヘルプ トピックを参照してください。
カスタム ジョブの種類で Job コマンドレットを使用する前に、コマンドレットを使用 Import-Module
するか、モジュールのコマンドレットを取得または使用して、カスタム ジョブの種類をサポートするモジュールをインポートします。
このコマンドレットは、Windows PowerShell 3.0 で導入されました。
例
例 1: ID でジョブを再開する
この例のコマンドは、ジョブが中断状態のワークフロー ジョブであることを確認した後、このジョブを再開します。 最初のコマンドでは、コマンドレットを Get-Job
使用してジョブを取得します。 出力には、ジョブが中断されたワークフロー ジョブであることが示されます。 2 番目のコマンドでは、コマンドレットの Id パラメーターをResume-Job
使用して、ID 値が 4 のジョブを再開します。
PS C:\> Get-Job EventJob
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
4 EventJob PSWorkflowJob Suspended True Server01 \\Script\Share\Event.ps1
PS C:\> Resume-Job -Id 4
例 2: 名前でジョブを再開する
このコマンドでは、Name パラメーターを使用して、ローカル コンピューターで複数のワークフロー ジョブを再開します。
PS C:\> Resume-Job -Name WorkflowJob, InventoryWorkflow, WFTest*
例 3: カスタム プロパティ値を使用する
このコマンドは、カスタム プロパティ値を使用して、再開するワークフロー ジョブを識別します。 Filter パラメーターを使用して、CustomID プロパティによってワークフロー ジョブを識別します。 また、State パラメーターを使用して、ワークフロー ジョブの再開を試みる前に、ワークフロー ジョブが中断されていることを確認します。
PS C:\> Resume-Job -Filter @{CustomID="T091291"} -State Suspended
例 4: リモート コンピューターで中断されているすべてのジョブを再開する
このコマンドは、Srv01 リモート コンピューター上のすべての中断されているジョブを再開します。
PS C:\> Invoke-Command -ComputerName Srv01 -ScriptBlock {Get-Job -State Suspended | Resume-Job}
このコマンドは、コマンドレットを Invoke-Command
使用して Srv01 コンピューターでコマンドを実行します。 リモート コマンドは、コマンドレットの State パラメーターを Get-Job
使用して、コンピューター上のすべての中断されたジョブを取得します。 パイプライン 演算子 (|
) は、中断されたジョブをコマンドレットに Resume-Job
送信して再開します。
例 5: ジョブの再開を待機する
このコマンドでは、Wait パラメーターを使用してResume-Job
、指定されたすべてのジョブが再開された後にのみ戻ります。 Wait パラメーターは、スクリプトが続行する前にジョブが再開されることを前提とするスクリプトで特に便利です。
PS C:\> Resume-Job -Name WorkflowJob, InventoryWorkflow, WFTest* -Wait
例 6: それ自体を中断するワークフローを再開する
このコード サンプルは、ワークフロー内の Suspend-Workflow
アクティビティを示しています。
Test-Suspend
Server01 コンピューター上のワークフロー。 ワークフローを実行すると、ワークフローによってアクティビティが Get-Date
実行され、結果が変数に $a
格納されます。 次に、アクティビティを実行します Suspend-Workflow
。 応答として、チェックポイントを受け取り、ワークフローを中断して、ワークフロー ジョブ オブジェクトを返します。 Suspend-Workflow
は、ワークフローがジョブとして明示的に実行されていない場合でも、ワークフロー ジョブ オブジェクトを返します。
Resume-Job
は Job8 で Test-Suspend
ワークフローを再開します。 Wait パラメーターを使用して、ジョブが再開されるまでコマンド プロンプトを保持します。
このコマンドレットは Receive-Job
、ワークフローの結果を取得します Test-Suspend
。 ワークフローの最後のコマンドは、ワークフローが中断される前に変数に保存$a
された現在の日付と時刻から日付と時刻までの経過時間を表す TimeSpan オブジェクトを返します。
#SampleWorkflow
Workflow Test-Suspend
{
$a = Get-Date
Suspend-Workflow
(Get-Date)- $a
}
PS C:\> Test-Suspend -PSComputerName Server01
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
8 Job8 PSWorkflowJob Suspended True Server01 Test-Suspend
PS C:\> Resume-Job -Name "Job8" -Wait
Id Name PSJobTypeName State HasMoreData Location Command
-- ---- ------------- ----- ----------- -------- -------
8 Job8 PSWorkflowJob Running True Server01 Test-Suspend
PS C:\> Receive-Job -Name Job8
Days : 0
Hours : 0
Minutes : 0
Seconds : 19
Milliseconds : 823
Ticks : 198230041
TotalDays : 0.000229432917824074
TotalHours : 0.00550639002777778
TotalMinutes : 0.330383401666667
TotalSeconds : 19.8230041
TotalMilliseconds : 19823.0041
PSComputerName : Server01
この Resume-Job
コマンドレットを使用すると、アクティビティを使用して中断されたワークフロー ジョブを Suspend-Workflow
再開できます。 このアクティビティは、ワークフロー内からワークフローを中断します。 ワークフローでのみ有効です。
詳細については Suspend-Workflow
、「about_Suspend-Workflow](../PSWorkflow/about/about_Suspend-Workflow.md)。
パラメーター
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Filter
条件のハッシュ テーブルを指定します。 このコマンドレットは、ハッシュ テーブル内のすべての条件を満たすジョブを再開します。 ジョブのプロパティをキー、ジョブのプロパティ値を値とするハッシュ テーブルを入力します。
Type: | Hashtable |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Id
このコマンドレットが再開するジョブの ID の配列を指定します。
ID は、現在のセッションのジョブを一意に識別する整数です。 インスタンス ID よりも覚えて入力する方が簡単ですが、現在のセッションでのみ一意です。 1 つ以上の ID をコンマで区切って入力できます。 ジョブの ID を検索するには、次を実行 Get-Job
します。
Type: | Int32[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InstanceId
このコマンドレットが再開するジョブのインスタンス ID の配列を指定します。 既定値はすべてのジョブです。
インスタンス ID は、コンピューター上のジョブを一意に識別する GUID です。 ジョブのインスタンス ID を検索するには、次を実行 Get-Job
します。
Type: | Guid[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Job
再開するジョブを指定します。 ジョブが格納されている変数、またはジョブを取得するコマンドを入力します。 コマンドレットにジョブを Resume-Job
パイプすることもできます。
Type: | Job[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
このコマンドレットが再開するジョブのフレンドリ名の配列を指定します。 1 つまたは複数のジョブ名を入力します。 ワイルドカード文字を使用できます。
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-State
再開するジョブの状態を指定します。 このパラメーターの有効値は、次のとおりです。
- NotStarted
- 実行中
- 完了しました
- 失敗
- 停止済み
- ブロック
- Suspended
- [Disconnected](切断済み)
- Suspending
- 停止中
このコマンドレットは、中断状態のジョブのみを再開します。
ジョブの状態の詳細については、「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
このコマンドレットは、すべてのジョブ結果が再起動されるまでコマンド プロンプトを抑制することを示します。 既定では、このコマンドレットはすぐに使用可能な結果を返します。
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
入力
このコマンドレットには、すべての種類のジョブをパイプ処理できます。 Resume-Job
サポートされていない型のジョブを取得すると、終了エラーが返されます。
出力
None, System.Management.Automation.Job
このコマンドレットは、PassThru パラメーターを使用する場合に再開しようとするジョブを返します。 それ以外の場合、このコマンドレットによる出力はありません。
メモ
Windows PowerShell には、次のエイリアスが Resume-Job
含まれています。
rujb
Resume-Job
は、中断されているジョブのみを再開できます。 ジョブを別の状態で送信する場合は、Resume-Job
ジョブに対して再開操作を実行しますが、ジョブを再開できなかったことを通知する警告が生成されます。 警告を抑制するには、WarningAction 共通パラメーターを値 SilentlyContinue と共に使用します。ジョブが再開をサポートする型ではない場合 (ワークフロー ジョブ (PSWorkflowJob) など)、
Resume-Job
終了エラーが返されます。中断されているジョブを保存するメカニズムと保存先の場所は、ジョブの種類によって異なる可能性があります。 たとえば、中断されているワークフロー ジョブは、既定でフラット ファイル ストアに保存されますが、SQL データベースに保存することもできます。
ジョブを再開すると、ジョブの状態が [中断済み] から [実行中] に 変わります。 実行中のジョブ (このコマンドレットによって再開されたものも含む) を見つけるには、コマンドレットの State パラメーターを
Get-Job
使用して、実行中の状態のジョブを取得します。一部のジョブの種類には、Windows PowerShell によるジョブの中断が許可されないオプションまたはプロパティを持つもあります。 ジョブの中断が失敗した場合は、ジョブのオプションとプロパティで中断が許可されていることを確認します。
関連リンク
PowerShell
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示