Suspend-Job

Módulo:

Microsoft.PowerShell.Core

Interrompe temporariamente os trabalhos de fluxo de trabalho.

Sintaxe

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

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

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

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

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

Suspend-Job
       [-Force]
       [-Wait]
       [-Name] <String[]>
       [-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

The first command creates the Get-SystemLog workflow. The workflow uses the CheckPoint-Workflow activity to define a checkpoint in the workflow.
#Sample WorkflowWorkflow Get-SystemLog
{
    $Events = Get-WinEvent -LogName System
    CheckPoint-Workflow
    InlineScript {\\Server01\Scripts\Analyze-SystemEvents.ps1 -Events $Events}
}

The second command uses the *AsJob* parameter that is common to all workflows to run the Get-SystemLog workflow as a background job. The command uses the *JobName* workflow common parameter to specify a friendly name for the workflow job.
PS C:\> Get-SystemLog -AsJob -JobName "Get-SystemLogJob"

The third command uses the **Get-Job** cmdlet to get the Get-SystemLogJob workflow job. The output shows that the value of the **PSJobTypeName** property is PSWorkflowJob.
PS C:\> Get-Job -Name Get-SystemLogJob
Id     Name              PSJobTypeName   State       HasMoreData     Location   Command
--     ----              -------------   -----       -----------     --------   -------
4      Get-SystemLogJob  PSWorkflowJob   Running     True            localhost   Get-SystemLog

The fourth command uses the **Suspend-Job** cmdlet to suspend the Get-SystemLogJob job. The job runs to the checkpoint and then suspends.
PS C:\> Suspend-Job -Name Get-SystemLogJob
Id     Name              PSJobTypeName   State       HasMoreData     Location   Command
--     ----              -------------   -----       -----------     --------   -------
4      Get-SystemLogJob  PSWorkflowJob   Suspended   True            localhost   Get-SystemLog

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

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

The first command suspends the LogWorkflowJob job.The command returns immediately. The output shows that the workflow job is still running, even though it is being suspended.
PS C:\> Suspend-Job -Name LogWorkflowJob
Id     Name          PSJobTypeName      State         HasMoreData     Location             Command
--     ----          -------------      -----         -----------     --------             -------
67     LogflowJob    PSWorkflowJob      Running       True            localhost            LogWorkflow

The second command uses the **Get-Job** cmdlet to get the LogWorkflowJob job. The output shows that the workflow job suspended successfully.
PS C:\> Get-Job -Name LogWorkflowJob
Id     Name          PSJobTypeName      State         HasMoreData     Location             Command
--     ----          -------------      -----         -----------     --------             -------
67     LogflowJob    PSWorkflowJob      Suspended     True            localhost            LogWorkflow

The third command uses the **Get-Job** cmdlet to get the LogWorkflowJob job and the Resume-Job cmdlet to resume it. The output shows that the workflow job resumed successfully and is now running.
PS C:\> Get-Job -Name LogWorkflowJob | Resume-Job
Id     Name          PSJobTypeName      State         HasMoreData     Location             Command
--     ----          -------------      -----         -----------     --------             -------
67     LogflowJob    PSWorkflowJob      Running       True            localhost            LogWorkflow

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

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

PS C:\> 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

PS C:\> 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

PS C:\> 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 a confirmação antes de executar o cmdlet.

Tipo:	SwitchParameter
Aliases:	cf
Cargo:	Named
Valor padrão:	False
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Filter

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

Tipo:	Hashtable
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	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.

Tipo:	SwitchParameter
Aliases:	F
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-Id

Especifica as IDs de trabalhos que este cmdlet suspende.

A ID é um 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.

Tipo:	Int32[]
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-InstanceId

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

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

Tipo:	Guid[]
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	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.

Tipo:	Job[]
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	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.

Tipo:	String[]
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	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
• Executando
• Concluído
• Falhou
• Parado
• Bloqueado
• Suspenso
• Desconectado
• Suspender
• Parar

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

Para obter mais informações sobre estados de trabalho, consulte de Enumeração JobState na biblioteca MSDN.

Tipo:	JobState
Valores aceitos:	NotStarted, Running, Completed, Failed, Stopped, Blocked, Suspended, Disconnected, Suspending, Stopping, AtBreakpoint
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	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 à canalização de um comando de trabalho suspenso para o cmdlet de trabalho de espera .

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	None
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

-WhatIf

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

Tipo:	SwitchParameter
Aliases:	wi
Cargo:	Named
Valor padrão:	False
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

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 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.

Links Relacionados

• Get-Job
• Receive-Job
• Remove-Job
• Resume-Job
• Start-Job
• Stop-Job
• Suspend-Job
• Wait-Job