Sdílet prostřednictvím

Remove-Job

  • Reference
Modul:
Microsoft.PowerShell.Core

Odstraní úlohu PowerShellu na pozadí.

Syntax

Remove-Job
      [-Id] <Int32[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-Job
      [-Job] <Job[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-Job
      [-Name] <String[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-Job
      [-Filter] <Hashtable>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-Job
      [-InstanceId] <Guid[]>
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-Job
      [-State] <JobState>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Remove-Job
      [-Command <String[]>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Rutina Remove-Job odstraní úlohy PowerShellu Start-Job na pozadí, které byly spuštěny rutinou nebo rutinami, jako Invoke-Command jsou ty, které podporují parametr AsJob .

Pomocí příkazu Remove-Job můžete odstranit všechny úlohy nebo odstranit vybrané úlohy. Úlohy se identifikují podle názvu, ID, ID instance, příkazu nebo stavu. Nebo je možné odeslat objekt úlohy v kanálu do Remove-Job. Bez parametrů nebo hodnot parametrů nemá Remove-Job žádný vliv.

Vzhledem k tomu, Že PowerShell 3.0, Remove-Job může odstranit vlastní typy úloh, jako jsou naplánované úlohy a úlohy pracovních postupů. Například Remove-Job odstraní naplánovanou úlohu, všechny instance naplánované úlohy na disku a výsledky všech aktivovaných instancí úloh.

Pokud se pokusíte odstranit spuštěnou úlohu, Remove-Job selže. Pomocí rutiny Stop-Job zastavte spuštěnou úlohu. Nebo pomocí Remove-Job parametru Force odstraňte spuštěnou úlohu.

Úlohy zůstanou v globální mezipaměti úloh, dokud neodstraníte úlohu na pozadí nebo nezavřete relaci PowerShellu.

Příklady

Příklad 1: Odstranění úlohy pomocí jejího názvu

V tomto příkladu se k odstranění úlohy podle názvu používá proměnná a kanál.

$batch = Get-Job -Name BatchJob
$batch | Remove-Job

Get-Job pomocí parametru Name určí úlohu BatchJob. Objekt úlohy je uložený v $batch proměnné . Objekt v nástroji $batch se odešle kanálem do Remove-Job.

Alternativou je použití parametru Job , například Remove-Job -Job $batch.

Příklad 2: Odstranění všech úloh v relaci

V tomto příkladu se odstraní všechny úlohy v aktuální relaci PowerShellu.

Get-job | Remove-Job

Get-Job získá všechny úlohy v aktuální relaci PowerShellu. Objekty úlohy se odesílají kanálem do Remove-Job.

Příklad 3: Odstranění úloh NotStarted

Tento příklad odstraní všechny úlohy z aktuální relace PowerShellu, které se nespustily.

Remove-Job -State NotStarted

Remove-Job pomocí parametru State určuje stav úlohy.

Příklad 4: Odstranění úloh pomocí popisného názvu

Tento příklad odstraní všechny úlohy z aktuální relace s popisnými názvy, které končí na batch*, včetně spuštěných úloh.

Remove-Job -Name *batch -Force

Remove-Job používá parametr Name k určení vzoru názvu úlohy. Vzor obsahuje zástupný znak hvězdička (*) pro vyhledání všech názvů úloh, které končí dávkovou. Parametr Force odstraní spuštěné úlohy.

Příklad 5: Odstranění úlohy vytvořené Invoke-Command

Tento příklad odebere úlohu, která byla spuštěna ve vzdáleném počítači pomocí parametru Invoke-CommandAsJob .

Vzhledem k tomu, že příklad používá parametr AsJob , vytvoří se objekt úlohy v místním počítači. Úloha ale běží na vzdáleném počítači. Výsledkem je, že ke správě úlohy použijete místní příkazy.

$job = Invoke-Command -ComputerName Server01 -ScriptBlock {Get-Process} -AsJob
$job | Remove-Job

Invoke-Command spustí úlohu na počítači Server01 . Parametr AsJob spustí ScriptBlock jako úlohu na pozadí. Objekt úlohy je uložený v $job proměnné . Objekt $job proměnné se odešle kanálem do Remove-Job.

Příklad 6: Odstranění úlohy vytvořené Invoke-Command a Start-Job

Tento příklad ukazuje, jak odebrat úlohu ve vzdáleném počítači, který byl spuštěn pomocí příkazu Invoke-Command ke spuštění Start-Job. Objekt úlohy se vytvoří ve vzdáleném počítači a ke správě úlohy se používají vzdálené příkazy. Při spuštění vzdáleného Start-Job příkazu je vyžadováno trvalé připojení.

$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 vytvoří relaci PSSession, trvalé připojení, k počítači Server01 . Připojení se uloží do $S proměnné .

Invoke-Command se připojí k relaci uložené v $S. ScriptBlock používá Start-Job ke spuštění vzdálené úlohy. Úloha spustí Get-Process příkaz a pomocí parametru Name zadá popisný název úlohy MyJob.

Invoke-Command$S použije relaci a spustí Remove-Job. Parametr Name určuje, že se odstraní úloha s názvem MyJob .

Příklad 7: Odstranění úlohy pomocí id instance

Tento příklad odebere úlohu na základě jejího Id instance.

$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 spustí úlohu na pozadí a objekt úlohy se uloží do $job proměnné .

Objekt v nástroji $job se odešle kanálem do Format-List. Parametr Property používá hvězdičku (*) k určení, že se všechny vlastnosti objektu zobrazí v seznamu.

Remove-Job používá parametr InstanceId k určení úlohy, která se má odstranit.

Parametry

-Command

Odstraní úlohy, které v příkazu obsahují zadaná slova. Můžete zadat pole oddělené čárkami.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Confirm

Před spuštěním se zobrazí výzva k potvrzení Remove-Job .

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Filter

Odstraní úlohy, které splňují všechny podmínky stanovené v přidružené tabulce hash. Zadejte zatřiďovací tabulku, kde klíče jsou vlastnosti úlohy a hodnoty jsou hodnoty vlastností úlohy.

Tento parametr funguje pouze u vlastních typů úloh, jako jsou úlohy pracovního postupu a naplánované úlohy. Nefunguje u standardních úloh na pozadí, jako jsou úlohy vytvořené pomocí Start-Job.

Tento parametr je zavedený v PowerShellu 3.0.

Type:Hashtable
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Force

Odstraní úlohu, i když je ve stavu Spuštěno. Pokud není parametr Force zadaný, Remove-Job neodstraní spuštěné úlohy.

Type:SwitchParameter
Aliases:F
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Odstraní úlohy na pozadí se zadaným ID. Můžete zadat pole oddělené čárkami. ID úlohy je jedinečné celé číslo, které identifikuje úlohu v rámci aktuální relace.

K vyhledání ID úlohy použijte příkaz Get-Job bez parametrů.

Type:Int32[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InstanceId

Odstraní úlohy se zadaným ID instance. Můžete zadat pole oddělené čárkami. InstanceId je jedinečný identifikátor GUID, který identifikuje úlohu.

Pokud chcete zjistit ID instance úlohy, použijte Get-Job.

Type:Guid[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Job

Určuje úlohy, které se mají odstranit. Zadejte proměnnou, která obsahuje úlohy, nebo příkaz, který získá úlohy. Můžete zadat pole oddělené čárkami.

Objekty úloh můžete posílat v kanálu do Remove-Job.

Type:Job[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Odstraní pouze úlohy se zadaným popisným názvem. Zástupné cardy jsou povolené. Můžete zadat pole oddělené čárkami.

Popisné názvy úloh nemusí být jedinečné, a to ani v rámci relace PowerShellu. Při odstraňování souborů podle názvu použijte parametry WhatIf a Confirm .

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-State

Odstraní pouze úlohy se zadaným stavem. Pokud chcete odstranit úlohy se stavem Spuštěno, použijte parametr Force .

Akceptované hodnoty:

  • AtBreakpoint
  • Blokované
  • Dokončeno
  • Odpojeno
  • Neúspěšný
  • NotStarted
  • Spuštěno
  • Zastaveno
  • Zastavování
  • Dočasně blokován.
  • Pozastavování
Type:JobState
Accepted values:AtBreakpoint, Blocked, Completed, Disconnected, Failed, NotStarted, Running, Stopped, Stopping, Suspended, Suspending
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Ukazuje, co by se stalo při Remove-Job spuštění. Rutina se nespustí.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Vstupy

Job

Objekt úlohy můžete odeslat dolů kanálem do Remove-Job.

Výstupy

None

Remove-Job negeneruje žádný výstup.

Poznámky

Úloha PowerShellu vytvoří nový proces. Po dokončení úlohy se proces ukončí. Při Remove-Job spuštění se stav úlohy odebere.

Pokud se úloha zastaví před dokončením a její proces se neukončí, proces se vynutil ukončení.