HOME > Job系コマンドレット > Remove-Job
Remove-Job
Remove-Jobは、ジョブを削除するコマンドです。
エイリアスrjb
解説
不要なジョブを削除します。
ジョブオブジェクト、ジョブID、ジョブ名を指定してジョブを削除できます。
構文
- （構文）
- Remove-Job [-Id] <int[]> [<CommonParameters>] Remove-Job [-Job] <Job[]> [<CommonParameters>] Remove-Job [-InstanceId] <guid[]> [<CommonParameters>] Remove-Job [-Name] <string[]> [<CommonParameters>] Remove-Job [-Filter] <hashtable> [<CommonParameters>] Remove-Job [-State] <状態> [<CommonParameters>] Remove-Job [<CommonParameters>]
| パラメータ | 説明 |
|---|---|
| -Job オブジェクト | 削除するジョブオブジェクトを直接指定する |
| -Force | 強制的にジョブを削除する |
| -Name ジョブ名 | 削除するジョブの名前を指定する ※ワイルドカード文字も使用可 （例）Remove-Job -Name "TestJob" |
| -InstanceId GUID | 削除するジョブのインスタンスID（GUID）を指定する |
| -Id ジョブID | 削除するジョブのIDを指定する ※複数のIDをコンマ区切りで指定可 （例）Remove-Job -Id 1, 2, 3 |
| -State | 特定の状態のジョブを削除する （Running, Completed, Failed, Stopped等） （例）Remove-Job -State Completed |
| -Command コマンド | 特定のコマンドを含むジョブを削除する |
| -Filter フィルター | カスタムジョブタイプに対して、条件を指定してジョブを削除する |
| -WhatIf | 実行はせずに実行結果の確認のみ行う |
| -Confirm | 実行前に確認メッセージの表示を行う |
共通的なパラメータは「共通パラメータ」をご覧ください。
サンプル
ジョブIDを指定してジョブを削除する
$job = Start-Job -ScriptBlock { Get-Process }
Wait-Job -Job $job
Remove-Job -Id $job.Id
ジョブオブジェクトを指定してジョブを削除する
$job = Start-Job -ScriptBlock { Get-Process }
Wait-Job -Job $job
Remove-Job -Job $job
すべてのジョブを削除する
Get-Job | Remove-Job
"Get-Process" コマンドを含むジョブを削除
Remove-Job -Command "Get-Process"
コマンドのヘルプを表示する
Get-Help Remove-Job
備考
- 実行中のジョブを削除すると不整合が起きる可能性があるのでご注意ください。
- ジョブが他のジョブに依存している場合は削除の順番にご注意ください。
関連項目
- Job系コマンドレット
- Get-Job：ジョブの情報を取得する
- Start-Job：ジョブを開始する
- Stop-Job：ジョブを終了する
- Wait-Job：ジョブの停止を待機する
- Receive-Job：ジョブの結果を取得する
- Remove-Job：ジョブを削除する
- Debug-Job：ジョブをデバッグする
