Remove-Job
PowerShell バックグラウンド ジョブを削除します。
構文
SessionIdParameterSet (既定)
Remove-Job
[-Id] <Int32[]>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
JobParameterSet
Remove-Job
[-Job] <Job[]>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
NameParameterSet
Remove-Job
[-Name] <String[]>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
InstanceIdParameterSet
Remove-Job
[-InstanceId] <Guid[]>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
FilterParameterSet
Remove-Job
[-Filter] <Hashtable>
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
StateParameterSet
Remove-Job
[-State] <JobState>
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CommandParameterSet
Remove-Job
[-Command <String[]>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Remove-Job コマンドレットは、Start-Job コマンドレットまたは AsJob パラメーターをサポートするInvoke-Commandなどのコマンドレットによって開始された PowerShell バックグラウンド ジョブを削除します。
Remove-Jobを使用すると、すべてのジョブを削除したり、選択したジョブを削除したりできます。 ジョブは、 名前、 ID、 InstanceId、 Command、または State によって識別されます。 または、ジョブ オブジェクトをパイプラインから送信して Remove-Jobできます。 パラメーターまたはパラメーター値がない場合、 Remove-Job は効果がありません。
PowerShell 3.0 以降、 Remove-Job は、スケジュールされたジョブやワークフロー ジョブなどのカスタム ジョブの種類を削除できます。 たとえば、 Remove-Job は、スケジュールされたジョブ、ディスク上のスケジュールされたジョブのすべてのインスタンス、およびトリガーされたすべてのジョブ インスタンスの結果を削除します。
実行中のジョブを削除しようとすると、 Remove-Job は失敗します。 実行中のジョブを停止するには、 Stop-Job コマンドレットを使用します。 または、実行中のジョブを削除するには、Force パラメーターでRemove-Jobを使用します。
バックグラウンド ジョブを削除するか、PowerShell セッションを閉じるまで、ジョブはグローバル ジョブ キャッシュに残ります。
例
例 1: 名前を使用してジョブを削除する
この例では、変数とパイプラインを使用して、名前でジョブを削除します。
$batch = Get-Job -Name BatchJob
$batch | Remove-Job
Get-Job では、 Name パラメーターを使用してジョブ BatchJob を指定します。 ジョブ オブジェクトは、$batch 変数に格納されます。
$batch内のオブジェクトは、パイプラインからRemove-Jobに送信されます。
別の方法として、 job パラメーター ( Remove-Job -Job $batch など) を使用します。
例 2: セッション内のすべてのジョブを削除する
この例では、現在の PowerShell セッション内のすべてのジョブが削除されます。
Get-Job | Remove-Job
Get-Job は、現在の PowerShell セッション内のすべてのジョブを取得します。 ジョブ オブジェクトはパイプラインに送信され、 Remove-Jobされます。
例 3: NotStarted ジョブを削除する
次の使用例は、開始されていない現在の PowerShell セッションからすべてのジョブを削除します。
Remove-Job -State NotStarted
Remove-Job では、 State パラメーターを使用してジョブの状態を指定します。
例 4: フレンドリ名を使用してジョブを削除する
次の使用例は、実行中のジョブを含め、 batch* で終わるフレンドリ名を持つすべてのジョブを現在のセッションから削除します。
Remove-Job -Name *batch -Force
Remove-Job では、 Name パラメーターを使用してジョブ名パターンを指定します。 パターンには、バッチで終わるすべてのジョブ名を検索するアスタリスク (*) ワイルドカードが含まれています。
Force パラメーターは、実行中のジョブを削除します。
例 5: Invoke-Command によって作成されたジョブを削除する
次の使用例は、asJob パラメーターを指定してInvoke-Commandを使用してリモート コンピューターで開始されたジョブを削除します。
この例では AsJob パラメーターを使用するため、ジョブ オブジェクトはローカル コンピューターに作成されます。 ただし、ジョブはリモート コンピューターで実行されます。 その結果、ローカル コマンドを使用してジョブを管理します。
$job = Invoke-Command -ComputerName Server01 -ScriptBlock {Get-Process} -AsJob
$job | Remove-Job
Invoke-Command
は Server01 コンピューターでジョブを実行します。
AsJob パラメーターは、バックグラウンド ジョブとして ScriptBlock を実行します。 ジョブ オブジェクトは、$job 変数に格納されます。
$job変数オブジェクトは、パイプラインからRemove-Jobに送信されます。
例 6: Invoke-Command および Start-Job によって作成されたジョブを削除する
この例では、Start-Jobを実行するためにInvoke-Commandを使用して開始されたリモート コンピューター上のジョブを削除する方法を示します。 ジョブ オブジェクトはリモート コンピューターに作成され、リモート コマンドを使用してジョブを管理します。 リモート Start-Job コマンドを実行するときは、永続的な接続が必要です。
$S = New-PSSession -ComputerName Server01
Invoke-Command -Session $S -ScriptBlock {Start-Job -ScriptBlock {Get-Process} -Name MyJob}
Invoke-Command -Session $S -ScriptBlock {Remove-Job -Name MyJob}
New-PSSessionは、Server01 コンピューターへの永続的な接続である PSSession を作成します。 接続は $S 変数に保存されます。
Invoke-Command は、 $Sに保存されたセッションに接続します。
ScriptBlock では、Start-Jobを使用してリモート ジョブを開始します。 ジョブは Get-Process コマンドを実行し、 Name パラメーターを使用してフレンドリ ジョブ名 MyJob を指定します。
Invoke-Command では、 $S セッションが使用され、 Remove-Jobが実行されます。
Name パラメーターは、MyJob という名前のジョブが削除されることを指定します。
例 7: InstanceId を使用してジョブを削除する
この例では、 InstanceId に基づいてジョブを削除します。
$job = Start-Job -ScriptBlock {Get-Process powershell}
$job | Format-List -Property *
Remove-Job -InstanceId ad02b942-8007-4407-87f3-d23e71955872
State : Completed
HasMoreData : True
StatusMessage :
Location : localhost
Command : Get-Process powershell
JobStateInfo : Completed
Finished : System.Threading.ManualResetEvent
InstanceId : ad02b942-8007-4407-87f3-d23e71955872
Id : 3
Name : Job3
ChildJobs : {Job4}
PSBeginTime : 7/26/2019 11:36:56
PSEndTime : 7/26/2019 11:36:57
PSJobTypeName : BackgroundJob
Output : {}
Error : {}
Progress : {}
Verbose : {}
Debug : {}
Warning : {}
Information : {}
Start-Job はバックグラウンド ジョブを開始し、ジョブ オブジェクトは $job 変数に保存されます。
$job内のオブジェクトは、パイプラインからFormat-Listに送信されます。
Property パラメーターは、アスタリスク (*) を使用して、オブジェクトのすべてのプロパティを一覧に表示することを指定します。
Remove-Job では、 InstanceId パラメーターを使用して、削除するジョブを指定します。
パラメーター
-Command
指定した単語をコマンドに含むジョブを削除します。 コンマ区切りの配列を入力できます。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
CommandParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Confirm
Remove-Jobを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | Cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Filter
関連付けられているハッシュ テーブルで確立されたすべての条件を満たすジョブを削除します。 キーがジョブ プロパティで、値がジョブ プロパティ値であるハッシュ テーブルを入力します。
このパラメーターは、ワークフロー ジョブやスケジュールされたジョブなどのカスタム ジョブの種類でのみ機能します。
Start-Jobを使用して作成されたジョブなど、標準のバックグラウンド ジョブでは機能しません。
このパラメーターは、PowerShell 3.0 で導入されました。
パラメーターのプロパティ
| 型: | Hashtable |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
FilterParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Force
ジョブの状態が 実行中の場合でも、ジョブを削除します。
Force パラメーターが指定されていない場合、Remove-Jobは実行中のジョブを削除しません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | F |
パラメーター セット
SessionIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
JobParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
InstanceIdParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
NameParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
FilterParameterSet
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Id
指定した ID を持つバックグラウンド ジョブを削除 します。コンマ区切りの配列を入力できます。 ジョブの ID は、現在のセッション内のジョブを識別する一意の整数です。
ジョブの ID を検索するには、パラメーターを指定せずに Get-Job を使用します。
パラメーターのプロパティ
| 型: | Int32[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
SessionIdParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-InstanceId
指定した InstanceId を持つジョブを削除します。 コンマ区切りの配列を入力できます。 InstanceId は、ジョブを識別する一意の GUID です。
ジョブの InstanceId を検索するには、 Get-Jobを使用します。
パラメーターのプロパティ
| 型: | Guid[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
InstanceIdParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Job
削除するジョブを指定します。 ジョブを含む変数、またはジョブを取得するコマンドを入力します。 コンマ区切りの配列を入力できます。
ジョブ オブジェクトをパイプラインの下に送信して、 Remove-Jobできます。
パラメーターのプロパティ
| 型: | Job[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
JobParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | True |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Name
指定したフレンドリ名を持つジョブのみを削除します。 ワイルドカードを使用できます。 コンマ区切りの配列を入力できます。
PowerShell セッション内であっても、ジョブのフレンドリ名が一意であるとは限りません。 名前でファイルを削除する場合は、 WhatIf パラメーターと Confirm パラメーターを使用します。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
NameParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-State
指定された状態のジョブのみを削除します。 実行中 の状態のジョブを削除するには、 Force パラメーターを使用します。
受け入れ可能な値:
- AtBreakpoint
- Blocked
- 完了
- 接続解除済
- 失敗
- 未開始
- Running
- 停止済み
- 停車
- 一時停止されています
- 中断中
パラメーターのプロパティ
| 型: | JobState |
| 規定値: | None |
| 指定可能な値: | AtBreakpoint, Blocked, Completed, Disconnected, Failed, NotStarted, Running, Stopped, Stopping, Suspended, Suspending |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
StateParameterSet
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-WhatIf
Remove-Job が実行された場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| エイリアス: | wi |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットは、共通パラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable をサポートします。 詳細については、about_CommonParametersを参照してください。
入力
Job
Job オブジェクトをこのコマンドレットにパイプできます。
出力
None
このコマンドレットは出力を返しません。
メモ
PowerShell には、Remove-Jobの次のエイリアスが含まれています。
- すべてのプラットフォーム:
rjb
PowerShell ジョブによって新しいプロセスが作成されます。 ジョブが完了すると、プロセスが終了します。
Remove-Jobが実行されると、ジョブの状態が削除されます。
ジョブが完了する前に停止し、そのプロセスが終了していない場合、プロセスは強制的に終了されます。