Remove-Job
Use Remove-Job to delete a job from the session, discarding any output it still holds.
Documentation: Microsoft Learn — PowerShell module reference
Syntax
See the command anatomy
Read the command and its supplied arguments. This example requires real PowerShell or its module; this diagram does not execute it.
Remove-Job [-Job] <Job[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]- Stage 1Remove-Job
-Job -Force -WhatIf -Confirm
Try it
PowerShell example · browser support is limited.
Execution scope: The full example below requires PowerShell outside this browser. You can edit this runner to use the supported practice commands; unsupported syntax returns an explanation.
Follow the objects
Run the command to inspect each stage.
Examples
Get-Job -State Completed
Show reference output
Sample output · fictional data, shaped like the real thing
Id Name PSJobTypeName State HasMoreData Location Command -- ---- ------------- ----- ----------- -------- -------
Get-Job -Force
Show reference output
Sample output · fictional data, shaped like the real thing
Id Name PSJobTypeName State HasMoreData Location Command -- ---- ------------- ----- ----------- -------- -------
Parameters
Parameter definitions:
-Job-Force-WhatIf-Confirm
Practical use and troubleshooting
Practical scenario: Use Remove-Job when you need to delete a job from the session, discarding any output it still holds. Review syntax and sample output, then try an example in the browser lab. Start with one identified target and inspect the returned values before extending the operation to a list. Keep the identity in your report so you can trace each result back to the object or path that produced it.
Common error and fix: Removing a running job can fail unless an appropriate force option is used. Decide whether the job should stop, collect required output, and then remove the correct job object. In an unattended script, capture this failure with its original error record and record which target failed. An empty result and an unsuccessful query must remain distinguishable in the final report.
See also: Stop-Job. Stop-Job requests that a job stop; Remove-Job removes its job object from the session. Removing metadata is not a substitute for deciding how to handle running work. Read the linked command before substituting it; similar names do not imply identical inputs or output.
Recap
Remove-Job Use Remove-Job to delete a job from the session, discarding any output it still holds.
Next: Stop-Job