Compartilhar via

Suspend-Job

Módulo:
Microsoft.PowerShell.Core Module

Interrompe temporariamente os trabalhos de fluxo de trabalho.

Sintaxe

SessionIdParameterSet (Default) 

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

JobParameterSet 

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

NameParameterSet 

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

InstanceIdParameterSet 

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

FilterParameterSet 

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

StateParameterSet 

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

Description

O cmdlet Suspend-Job suspende trabalhos de fluxo de trabalho. Suspender significa interromper ou pausar temporariamente um trabalho de fluxo de trabalho. Esse cmdlet permite que os usuários que estão executando fluxos de trabalho suspendam o fluxo de trabalho. Ele complementa a atividade dehttps://go.microsoft.com/fwlink/?LinkId=267141 de Fluxo de Trabalho de Suspensão, que é um comando no fluxo de trabalho que suspende o fluxo de trabalho.

O cmdlet Suspend-Job funciona apenas em trabalhos de fluxo de trabalho. Ele não funciona em trabalhos em segundo plano padrão, como aqueles iniciados usando o cmdlet Start-Job.

Para identificar um trabalho de fluxo de trabalho, procure um valor de PSWorkflowJob na propriedade PSJobTypeName do trabalho. Para determinar se um determinado tipo de trabalho personalizado dá suporte ao cmdlet Suspend-Job, consulte os tópicos de ajuda para o tipo de trabalho personalizado.

Quando você suspende um trabalho de fluxo de trabalho, o trabalho de fluxo de trabalho é executado no próximo ponto de verificação, suspende e retorna imediatamente um objeto de trabalho de fluxo de trabalho. Para aguardar a conclusão da suspensão antes de obter o trabalho, use o parâmetro Wait de Suspend-Job ou o cmdlet Wait-Job. Quando o trabalho de fluxo de trabalho é suspenso, o valor da propriedade State do trabalho é Suspenso.

A suspensão correta depende de pontos de verificação. O estado atual do trabalho, os metadados e a saída são salvos no ponto de verificação para que o trabalho de fluxo de trabalho possa ser retomado sem perda de estado ou dados. Se o trabalho de fluxo de trabalho não tiver pontos de verificação, ele não poderá ser suspenso corretamente. Para adicionar pontos de verificação a um fluxo de trabalho que você está executando, use o parâmetro comum PSPersist fluxo de trabalho. Você pode usar o parâmetro Force para suspender qualquer trabalho de fluxo de trabalho imediatamente e suspender um trabalho de fluxo de trabalho que não tenha pontos de verificação, mas a ação pode causar perda de estado e dados.

Antes de usar um cmdlet job em um tipo de trabalho personalizado, como um trabalho de fluxo de trabalho (PSWorkflowJob) importe o módulo que dá suporte ao tipo de trabalho personalizado, usando o cmdlet Import-Module ou usando ou usando um cmdlet no módulo.

Esse cmdlet foi introduzido no Windows PowerShell 3.0.

Exemplos

Exemplo 1: suspender um trabalho de fluxo de trabalho por nome

Este exemplo mostra como suspender um trabalho de fluxo de trabalho.

O primeiro comando cria o fluxo de trabalho Get-SystemLog. O fluxo de trabalho usa a atividade CheckPoint-Workflow para definir um ponto de verificação no fluxo de trabalho.

O segundo comando usa o parâmetro AsJob que é comum a todos os fluxos de trabalho para executar o fluxo de trabalho Get-SystemLog como um trabalho em segundo plano. O comando usa o parâmetro comum JobName fluxo de trabalho para especificar um nome amigável para o trabalho de fluxo de trabalho.

O terceiro comando usa o cmdlet Get-Job para obter o trabalho de fluxo de trabalho LogflowJob. A saída mostra que o valor da propriedade PSJobTypeName é PSWorkflowJob.

O quarto comando usa o cmdlet Suspend-Job para suspender o trabalho de LogflowJob. O trabalho é executado no ponto de verificação e, em seguida, é suspenso.

#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

Exemplo 2: Suspender e retomar um trabalho de fluxo de trabalho

Este exemplo mostra como suspender e retomar um trabalho de fluxo de trabalho.

O primeiro comando suspende o trabalho LogWorkflowJob. O comando retorna imediatamente. A saída mostra que o trabalho de fluxo de trabalho ainda está em execução, mesmo que esteja sendo suspenso.

O segundo comando usa o cmdlet Get-Job para obter o trabalho LogWorkflowJob. A saída mostra que o trabalho de fluxo de trabalho foi suspenso com êxito.

O terceiro comando usa o cmdlet Get-Job para obter o trabalho LogWorkflowJob e o cmdlet Resume-Job para retomá-lo. A saída mostra que o trabalho de fluxo de trabalho foi retomado com êxito e agora está em execução.

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

Exemplo 3: suspender um trabalho de fluxo de trabalho em um computador remoto

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

Esse comando usa o cmdlet Invoke-Command para suspender um trabalho de fluxo de trabalho no computador remoto Srv01. O valor do parâmetro Filter é uma tabela de hash que especifica um valor CustomID. Este CustomID são metadados de trabalho (PSPrivateMetadata).

Exemplo 4: Aguardar a suspensão do trabalho de fluxo de trabalho

Suspend-Job VersionCheck -Wait

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

Esse comando suspende o trabalho de fluxo de trabalho VersionCheck. O comando usa o parâmetro Wait para aguardar até que o trabalho de fluxo de trabalho seja suspenso. Quando o trabalho de fluxo de trabalho é executado no próximo ponto de verificação e é suspenso, o comando termina e retorna o objeto de trabalho.

Exemplo 5: Forçar um trabalho de fluxo de trabalho a ser suspenso

Suspend-Job Maintenance -Force

Esse comando suspende o trabalho de fluxo de trabalho de manutenção à força. O trabalho de Manutenção não tem pontos de verificação. Ele não pode ser suspenso corretamente e pode não ser retomado corretamente.

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Filter

Especifica uma tabela hash de condições. Esse cmdlet suspende trabalhos que atendem a todas as condições. Insira uma tabela de hash na qual as chaves são propriedades do trabalho e os valores são valores de propriedade do trabalho.

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

FilterParameterSet
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Force

Suspende o trabalho de fluxo de trabalho imediatamente. Essa ação pode causar uma perda de estado e dados.

Por padrão, Suspend-Job permite que o trabalho de fluxo de trabalho seja executado até o próximo ponto de verificação e, em seguida, suspenda-o. Você também pode usar esse parâmetro para suspender trabalhos de fluxo de trabalho que não têm pontos de verificação.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:F

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Id

Especifica as IDs de trabalhos que este cmdlet suspende.

A ID é um número inteiro que identifica exclusivamente o trabalho na sessão atual. É mais fácil lembrar e digitar do que a ID da instância, mas ela é exclusiva apenas na sessão atual. Você pode digitar uma ou mais IDs, separadas por vírgulas. Para localizar a ID de um trabalho, use o cmdlet Get-Job.

Propriedades do parâmetro

Tipo:

Int32[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

SessionIdParameterSet
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-InstanceId

Especifica as IDs de instância de trabalhos que este cmdlet suspende. O padrão é obter todos os trabalhos.

Uma ID de instância é um GUID que identifica exclusivamente o trabalho no computador. Para localizar a ID de instância de um trabalho, use Get-Job.

Propriedades do parâmetro

Tipo:

Guid[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

InstanceIdParameterSet
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Job

Especifica os trabalhos de fluxo de trabalho que esse cmdlet interrompe. Insira uma variável que contenha os trabalhos de fluxo de trabalho ou um comando que obtém os trabalhos de fluxo de trabalho. Você também pode redirecionar trabalhos de fluxo de trabalho para o cmdlet Suspend-Job.

Propriedades do parâmetro

Tipo:

Job[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

JobParameterSet
Cargo:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Name

Especifica nomes amigáveis de trabalhos que este cmdlet suspende. Insira um ou mais nomes de trabalho de fluxo de trabalho. Há suporte para caracteres curinga.

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

NameParameterSet
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-State

Especifica um estado de trabalho. Esse cmdlet interrompe apenas os trabalhos no estado especificado. Os valores aceitáveis para este parâmetro são:

  • NotStarted
  • Correndo
  • Concluído
  • Falha
  • Parado
  • Bloqueado
  • Suspenso
  • Desconectado
  • Suspensão
  • Parar

Suspend-Job suspende apenas trabalhos de fluxo de trabalho no estado Executando.

Para obter mais informações sobre os estados dos trabalhos, consulte Enumeração de JobState.

Propriedades do parâmetro

Tipo:JobState
Valor padrão:None
Valores aceitos:NotStarted, Running, Completed, Failed, Stopped, Blocked, Suspended, Disconnected, Suspending, Stopping, AtBreakpoint
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

StateParameterSet
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Wait

Indica que esse cmdlet suprime o prompt de comando até que o trabalho de fluxo de trabalho esteja no estado suspenso. Por padrão, Suspend-Job retorna imediatamente, mesmo que o trabalho de fluxo de trabalho ainda não esteja no estado suspenso.

O parâmetro Wait é equivalente a canalizar um comando Suspend-Job para o cmdlet Wait-Job.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

Job

Você pode canalizar todos os tipos de trabalhos para este cmdlet. No entanto, se Suspend-Job obter um trabalho de um tipo sem suporte, ele retornará um erro de encerramento.

Saídas

Job

Esse cmdlet retorna os trabalhos que ele suspendeu.

Observações

O Windows PowerShell inclui os seguintes aliases para Suspend-Job:

  • sujb

O mecanismo e o local para salvar um trabalho suspenso podem variar dependendo do tipo de trabalho. Por exemplo, trabalhos de fluxo de trabalho suspensos são salvos em um repositório de arquivos simples por padrão, mas também podem ser salvos em um banco de dados.

Se você enviar um trabalho de fluxo de trabalho que não esteja no estado em execução, Suspend-Job exibirá uma mensagem de aviso. Para suprimir o aviso, use o WarningAction parâmetro comum com um valor de SilentlyContinue.

Se um trabalho não for de um tipo que dê suporte à suspensão, Suspend-Job retornará um erro de encerramento.

Para localizar os trabalhos de fluxo de trabalho suspensos, incluindo aqueles que foram suspensos por esse cmdlet, use o parâmetro State do cmdlet Get-Job para obter trabalhos de fluxo de trabalho no estado Suspenso.

Alguns tipos de trabalho têm opções ou propriedades que impedem o Windows PowerShell de suspender o trabalho. Se as tentativas de suspender o trabalho falharem, verifique se as opções de trabalho e as propriedades permitem a suspensão.