Suspend-Job

リファレンス

モジュール:: Microsoft.PowerShell.Core

ワークフロージョブを一時的に停止します。

構文

Suspend-Job
       [-Force]
       [-Wait]
       [-Id] <Int32[]>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Suspend-Job
       [-Job] <Job[]>
       [-Force]
       [-Wait]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Suspend-Job
       [-Force]
       [-Wait]
       [-Name] <String[]>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Suspend-Job
       [-Force]
       [-Wait]
       [-InstanceId] <Guid[]>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Suspend-Job
       [-Force]
       [-Wait]
       [-Filter] <Hashtable>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Suspend-Job
       [-Force]
       [-Wait]
       [-State] <JobState>
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

説明

このコマンドレットは Suspend-Job 、ワークフロージョブを中断します。中断とは、ワークフロージョブを一時的に中断または一時停止することを意味します。ワークフローを実行しているユーザーは、このコマンドレットを使用してワークフローを中断できます。これは、ワークフローを中断するワークフロー内のコマンドである Suspend-Workflowhttps://go.microsoft.com/fwlink/?LinkId=267141 アクティビティを補完します。

このコマンドレットは Suspend-Job ワークフロージョブでのみ機能します。コマンドレットを使用 Start-Job して開始されるジョブなど、標準のバックグラウンドジョブでは機能しません。

ワークフロージョブを識別するには、ジョブの PSJobTypeName プロパティで PSWorkflowJob の値を探します。特定のカスタムジョブの種類でコマンドレットが Suspend-Job サポートされているかどうかを確認するには、カスタムジョブの種類のヘルプトピックを参照してください。

ワークフロージョブを中断すると、ワークフロージョブは次のチェックポイントまで実行された後で中断されます。その後、ワークフロージョブオブジェクトが直ちに返されます。ジョブを取得する前に中断が完了するのを待つには、Wait パラメーターSuspend-JobまたはコマンドレットをWait-Job使用します。ワークフロージョブが中断されると、ジョブの State プロパティの値は Suspended になります。

正しく中断できるかどうかはチェックポイントに依存します。現在のジョブの状態、メタデータ、出力はチェックポイントに保存されるため、状態やデータを失うことなくワークフロージョブを再開できます。ワークフロージョブにチェックポイントがない場合は、正しく中断できません。実行中のワークフローにチェックポイントを追加するには、PSPersist ワークフロー共通パラメーターを使用します。 Force パラメーターを使用すると、ワークフロージョブをすぐに中断したり、チェックポイントを持たないワークフロージョブを中断したりできますが、アクションによって状態とデータが失われる可能性があります。

ワークフロージョブ (PSWorkflowJob) などのカスタムジョブの種類で Job コマンドレットを使用する前に、コマンドレットを使用するか、モジュール内のコマンドレットを使用 Import-Module して、カスタムジョブの種類をサポートするモジュールをインポートします。

このコマンドレットは、Windows PowerShell 3.0 で導入されました。

例

例 1: 名前でワークフロージョブを中断する

この例では、ワークフロージョブを中断する方法を示します。

最初のコマンドによってワークフローが作成されます Get-SystemLog 。ワークフローでは、アクティビティをCheckPoint-Workflow使用してワークフロー内のチェックポイントを定義します。

2 番目のコマンドでは、すべてのワークフローに 共通する AsJob パラメーターを使用して、ワークフローを Get-SystemLog バックグラウンドジョブとして実行します。このコマンドでは、 JobName ワークフロー共通パラメーターを使用して、ワークフロージョブのフレンドリ名を指定します。

3 番目のコマンドでは、コマンドレットを Get-Job 使用してワークフロージョブを Get-SystemLogJob 取得します。出力は、PSJobTypeName プロパティの値が PSWorkflowJob であることを示しています。

4 番目のコマンドでは、コマンドレットを Suspend-Job 使用してジョブを Get-SystemLogJob 中断します。ジョブはチェックポイントまで実行され、中断されます。

#Sample WorkflowWorkflow Get-SystemLog
{
    $Events = Get-WinEvent -LogName System
    CheckPoint-Workflow
    InlineScript {\\Server01\Scripts\Analyze-SystemEvents.ps1 -Events $Events}
}

PS C:\> Get-SystemLog -AsJob -JobName "Get-SystemLogJob"

PS C:\> Get-Job -Name Get-SystemLogJob
Id     Name              PSJobTypeName   State       HasMoreData     Location   Command
--     ----              -------------   -----       -----------     --------   -------
4      Get-SystemLogJob  PSWorkflowJob   Running     True            localhost   Get-SystemLog

PS C:\> Suspend-Job -Name Get-SystemLogJob
Id     Name              PSJobTypeName   State       HasMoreData     Location   Command
--     ----              -------------   -----       -----------     --------   -------
4      Get-SystemLogJob  PSWorkflowJob   Suspended   True            localhost   Get-SystemLog

例 2: ワークフロージョブを中断して再開する

この例では、ワークフロージョブを中断し、再開する方法を示します。

最初のコマンドは、LogWorkflowJob ジョブを中断します。コマンドはすぐに返されます。出力は、ワークフロージョブが中断されているにもかかわらず、まだ実行中であることを示しています。

2 番目のコマンドでは、コマンドレットを Get-Job 使用して LogWorkflowJob ジョブを取得します。出力は、ワークフロージョブが正常に中断されたことを示しています。

3 番目のコマンドでは、コマンドレットを Get-Job 使用して LogWorkflowJob ジョブを取得し、コマンドレットを Resume-Job 使用して再開します。出力は、ワークフロージョブが正常に再開され、現在実行されていることを示しています。

PS C:\> Suspend-Job -Name LogWorkflowJob
Id     Name          PSJobTypeName      State         HasMoreData     Location             Command
--     ----          -------------      -----         -----------     --------             -------
67     LogflowJob    PSWorkflowJob      Running       True            localhost            LogWorkflow

PS C:\> Get-Job -Name LogWorkflowJob
Id     Name          PSJobTypeName      State         HasMoreData     Location             Command
--     ----          -------------      -----         -----------     --------             -------
67     LogflowJob    PSWorkflowJob      Suspended     True            localhost            LogWorkflow

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 使用して、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

コマンドレットの実行前に確認を求めるメッセージが表示されます。

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

-Force

ワークフロージョブを即座に中断します。このアクションにより、状態とデータが失われる可能性があります。

既定では、Suspend-Jobワークフロージョブを次のチェックポイントまで実行し、中断します。このパラメーターを使用すると、チェックポイントがないワークフロージョブも中断できます。

Type:	SwitchParameter
Aliases:	F
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
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

このコマンドレットが停止するワークフロージョブを指定します。ワークフロージョブが格納されている変数、またはワークフロージョブを取得するコマンドを入力します。ワークフロージョブをコマンドレットに Suspend-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
停止中

Suspend-Jobは、実行中の状態のワークフロージョブのみを中断します。

ジョブの状態の詳細については、「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

このコマンドレットは、ワークフロージョブが中断状態になるまでコマンドプロンプトを抑制することを示します。既定では、 Suspend-Job ワークフロージョブがまだ中断状態でない場合でも、直ちに返されます。

Wait パラメーターは、コマンドをSuspend-Jobコマンドレットにパイプ処理することとWait-Job同じです。

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

入力

Job

このコマンドレットには、すべての種類のジョブをパイプ処理できます。ただし、 Suspend-Job サポートされていない型のジョブを取得すると、終了エラーが返されます。

出力

Job

このコマンドレットは、中断したジョブを返します。

メモ

Windows PowerShell には、次のエイリアスが Suspend-Job含まれています。

sujb

中断されているジョブを保存するメカニズムと保存先の場所は、ジョブの種類によって異なる可能性があります。たとえば、中断されているワークフロージョブは、既定でフラットファイルストアに保存されますが、データベースに保存することもできます。

実行中の状態ではないワークフロージョブを送信すると、 Suspend-Job 警告メッセージが表示されます。警告を抑制するには、WarningAction 共通パラメーターを値 SilentlyContinue と共に使用します。

ジョブが中断をサポートする型でない場合は、 Suspend-Job 終了エラーを返します。

中断されたワークフロージョブ (このコマンドレットによって中断されたものも含む) を検索するには、コマンドレットの State パラメーターをGet-Job使用して、中断状態のワークフロージョブを取得します。

一部のジョブの種類には、Windows PowerShell によるジョブの中断が許可されないオプションまたはプロパティを持つもあります。ジョブの中断が失敗した場合は、ジョブのオプションとプロパティで中断が許可されていることを確認します。

Suspend-Job

構文

説明

例

例 1: 名前でワークフロージョブを中断する

例 2: ワークフロージョブを中断して再開する

例 3: リモートコンピューターでワークフロージョブを中断する

例 4: ワークフロージョブが一時停止するのを待つ

例 5: ワークフロージョブを強制的に中断する

パラメーター

-Confirm

-Filter

-Force

-Id

-InstanceId

-Job

-Name

-State

-Wait

-WhatIf

入力

出力

メモ

フィードバック

その他のリソース

Suspend-Job

構文

説明

例

例 1: 名前でワークフロー ジョブを中断する

例 2: ワークフロー ジョブを中断して再開する

例 3: リモート コンピューターでワークフロー ジョブを中断する

例 4: ワークフロー ジョブが一時停止するのを待つ

例 5: ワークフロー ジョブを強制的に中断する

パラメーター

-Confirm

-Filter

-Force

-Id

-InstanceId

-Job

-Name

-State

-Wait

-WhatIf

入力

出力

メモ

関連リンク

フィードバック

その他のリソース

例 1: 名前でワークフロージョブを中断する

例 2: ワークフロージョブを中断して再開する

例 3: リモートコンピューターでワークフロージョブを中断する

例 4: ワークフロージョブが一時停止するのを待つ

例 5: ワークフロージョブを強制的に中断する