Suspend-Job

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

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

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

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

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

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

Polecenie cmdlet Suspend-Job zawiesza zadania przepływu pracy. Wstrzymanie oznacza tymczasowe przerwanie lub wstrzymanie zadania przepływu pracy. To polecenie cmdlet umożliwia użytkownikom, którzy uruchamiają przepływy pracy, aby zawiesić przepływ pracy. Uzupełnia działanie suspend-workflowhttps://go.microsoft.com/fwlink/?LinkId=267141, które jest poleceniem w przepływie pracy, który zawiesza przepływ pracy.

Polecenie cmdlet Suspend-Job działa tylko w przypadku zadań przepływu pracy. Nie działa w przypadku standardowych zadań w tle, takich jak te, które są uruchamiane przy użyciu polecenia cmdlet Start-Job.

Aby zidentyfikować zadanie przepływu pracy, poszukaj wartości zadania PSWorkflowJob w PSJobTypeName właściwości zadania. Aby określić, czy określony niestandardowy typ zadania obsługuje polecenie cmdlet Suspend-Job, zobacz tematy pomocy dla niestandardowego typu zadania.

Po zawieszeniu zadania przepływu pracy zadanie przepływu pracy jest uruchamiane do następnego punktu kontrolnego, zawiesza się i natychmiast zwraca obiekt zadania przepływu pracy. Aby poczekać na zakończenie zawieszenia przed pobraniem zadania, użyj parametru WaitSuspend-Job lub polecenia cmdlet Wait-Job. Po zawieszeniu zadania przepływu pracy wartość właściwości State zadania jest zawieszona.

Wstrzymywanie poprawnie opiera się na punktach kontrolnych. Bieżący stan zadania, metadane i dane wyjściowe są zapisywane w punkcie kontrolnym, dzięki czemu zadanie przepływu pracy można wznowić bez utraty stanu lub danych. Jeśli zadanie przepływu pracy nie ma punktów kontrolnych, nie można go poprawnie zawiesić. Aby dodać punkty kontrolne do uruchomionego przepływu pracy, użyj wspólnego parametru PSPersist przepływu pracy. Możesz użyć parametru Force, aby natychmiast zawiesić dowolne zadanie przepływu pracy i wstrzymać zadanie przepływu pracy, które nie ma punktów kontrolnych, ale akcja może spowodować utratę stanu i danych.

Przed użyciem polecenia cmdlet zadania w niestandardowym typie zadania, takim jak zadanie przepływu pracy (psWorkflowJob) zaimportuj moduł obsługujący niestandardowy typ zadania za pomocą polecenia cmdlet Import-Module lub polecenia cmdlet w module.

To cmdlet zostało wprowadzone w Windows PowerShell 3.0.

W tym przykładzie pokazano, jak zawiesić zadanie przepływu pracy.

Pierwsze polecenie tworzy przepływ pracy Get-SystemLog. Przepływ pracy używa działania CheckPoint-Workflow do zdefiniowania punktu kontrolnego w przepływie pracy.

Drugie polecenie używa parametru AsJob, który jest wspólny dla wszystkich przepływów pracy w celu uruchomienia przepływu pracy Get-SystemLog jako zadania w tle. Polecenie używa wspólnego parametru JobName przepływu pracy, aby określić przyjazną nazwę zadania przepływu pracy.

Trzecie polecenie używa polecenia cmdlet Get-Job w celu pobrania zadania przepływu pracy LogflowJob. Dane wyjściowe pokazują, że wartość właściwości PSJobTypeName to PSWorkflowJob.

Czwarte polecenie używa polecenia cmdlet Suspend-Job do zawieszenia zadania LogflowJob. Zadanie jest uruchamiane w punkcie kontrolnym, a następnie zawiesza się.

#Sample Workflow
workflow Get-SystemLog
{
    $Events = Get-WinEvent -LogName System
    CheckPoint-Workflow
    inlinescript {\\Server01\Scripts\Analyze-SystemEvents.ps1 -Events $Events}
}
Get-SystemLog -AsJob -JobName "LogflowJob"
Get-Job -Name LogflowJob

Id   Name          PSJobTypeName   State       HasMoreData     Location   Command
--   ----          -------------   -----       -----------     --------   -------
4    LogflowJob    PSWorkflowJob   Running     True            localhost   Get-SystemLog

Suspend-Job -Name LogflowJob

Id   Name          PSJobTypeName   State       HasMoreData     Location   Command
--   ----          -------------   -----       -----------     --------   -------
4    LogflowJob    PSWorkflowJob   Suspended   True            localhost   Get-SystemLog

W tym przykładzie pokazano, jak wstrzymać i wznowić zadanie przepływu pracy.

Pierwsze polecenie zawiesza zadanie LogWorkflowJob. Polecenie zwraca natychmiast. Dane wyjściowe pokazują, że zadanie przepływu pracy jest nadal uruchomione, mimo że jest zawieszone.

Drugie polecenie używa polecenia cmdlet Get-Job w celu pobrania zadania LogWorkflowJob. Dane wyjściowe pokazują, że zadanie przepływu pracy zostało pomyślnie zawieszone.

Trzecie polecenie używa polecenia cmdlet Get-Job w celu pobrania zadania LogWorkflowJob i polecenia cmdlet Resume-Job w celu wznowienia go. Dane wyjściowe pokazują, że zadanie przepływu pracy zostało wznowione pomyślnie i jest teraz uruchomione.

Suspend-Job -Name LogWorkflowJob

Id   Name          PSJobTypeName      State         HasMoreData     Location      Command
--   ----          -------------      -----         -----------     --------      -------
67   LogflowJob    PSWorkflowJob      Running       True            localhost     LogWorkflow

Get-Job -Name LogWorkflowJob

Id   Name          PSJobTypeName      State         HasMoreData     Location      Command
--   ----          -------------      -----         -----------     --------      -------
67   LogflowJob    PSWorkflowJob      Suspended     True            localhost     LogWorkflow

Get-Job -Name LogWorkflowJob | Resume-Job

Id     Name          PSJobTypeName      State       HasMoreData     Location      Command
--     ----          -------------      -----       -----------     --------      -------
67     LogflowJob    PSWorkflowJob      Running     True            localhost     LogWorkflow

Invoke-Command -ComputerName Srv01 -ScriptBlock {Suspend-Job -Filter @{CustomID="031589"}

To polecenie używa polecenia cmdlet Invoke-Command do zawieszenia zadania przepływu pracy na komputerze zdalnym Srv01. Wartość parametru Filter jest tabelą skrótów określającą wartość CustomID. Ten CustomID to metadane zadania (PSPrivateMetadata).

Suspend-Job VersionCheck -Wait

Id     Name          PSJobTypeName      State         HasMoreData     Location      Command
--     ----          -------------      -----         -----------     --------      -------
 5     VersionCheck  PSWorkflowJob      Suspended     True            localhost     LogWorkflow

To polecenie zawiesza zadanie przepływu pracy VersionCheck. Polecenie używa parametru Wait, aby poczekać, aż zadanie przepływu pracy zostanie zawieszone. Gdy zadanie przepływu pracy zostanie uruchomione do następnego punktu kontrolnego i zostanie wstrzymane, polecenie zakończy działanie i zwróci obiekt zadania.

Suspend-Job Maintenance -Force

To polecenie zawiesza zadanie przepływu pracy konserwacji wymuszone. Zadanie konserwacji nie ma punktów kontrolnych. Nie można go poprawnie zawiesić i może nie zostać wznowiony poprawnie.

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Do tego polecenia cmdlet można przekazać potoki wszystkich typów zadań. Jeśli jednak Suspend-Job pobiera zadanie nieobsługiwanego typu, zwraca błąd zakończenia.

To polecenie cmdlet zwraca wstrzymane zadania.

Program Windows PowerShell zawiera następujące aliasy dla Suspend-Job:

• sujb

Mechanizm i lokalizacja zapisywania zawieszonego zadania mogą się różnić w zależności od typu zadania. Na przykład zawieszone zadania przepływu pracy są domyślnie zapisywane w magazynie plików prostych, ale mogą być również zapisywane w bazie danych.

Jeśli prześlesz zadanie przepływu pracy, które nie znajduje się w stanie Uruchomiono, Suspend-Job wyświetli komunikat ostrzegawczy. Aby pominąć ostrzeżenie, użyj WarningAction wspólnego parametru z wartością SilentlyContinue.

Jeśli zadanie nie jest typem obsługującym wstrzymanie, Suspend-Job zwraca błąd zakończenia.

Aby znaleźć wstrzymane zadania przepływu pracy, w tym te, które zostały zawieszone przez to polecenie cmdlet, użyj parametru stanu polecenia cmdlet Get-Job, aby pobrać zadania przepływu pracy w stanie Wstrzymanie.

Niektóre typy zadań mają opcje lub właściwości uniemożliwiające wstrzymanie zadania przez program Windows PowerShell. Jeśli próba zawieszenia zadania nie powiedzie się, sprawdź, czy opcje i właściwości zadania zezwalają na wstrzymanie.