about_Checkpoint-Workflow

BREVE DESCRIÇÃO

Descreve a atividade Checkpoint-Workflow, que usa um ponto de verificação em um fluxo de trabalho.

DESCRIÇÃO LONGA

A atividade Checkpoint-Workflow usa um ponto de verificação, que salva o estado e os dados no fluxo de trabalho. Se o fluxo de trabalho for suspenso ou interrompido, ele poderá ser retomado a partir do ponto de verificação mais recente, em vez de precisar ser reiniciado.

A atividade Checkpoint-Workflow é válida apenas em um fluxo de trabalho.

SINTAXE

Workflow <Verb-Noun>
{
    Checkpoint-Workflow
}

A atividade Checkpoint-Workflow não aceita nenhum parâmetro, incluindo parâmetros comuns e parâmetros comuns do fluxo de trabalho.

Você pode colocar o ponto de verificação Checkpoint-Activity em qualquer lugar em um fluxo de trabalho após a instrução CmdletBinding ou Param. No entanto, ao colocar pontos de verificação, considere o custo de desempenho de coletar os dados e gravá-los em disco no computador que está executando o fluxo de trabalho.

Certifique-se de que o tempo necessário para executar novamente uma seção do fluxo de trabalho se ela for interrompida é maior do que o tempo necessário para gravar o estado do ponto de verificação e os dados no disco.

Considere a possibilidade de tomar pontos de verificação após etapas críticas para que o fluxo de trabalho possa ser retomado em vez de reiniciado. Por exemplo, tome um ponto de verificação após comandos que não são idempotentes.

SOBRE OS PONTOS DE VERIFICAÇÃO

Um ponto de verificação é um instantâneo do estado atual do fluxo de trabalho, incluindo os valores atuais das variáveis e qualquer saída gerada até esse ponto, e o salva no disco.

Se um fluxo de trabalho for interrompido, intencionalmente ou não, o Fluxo de Trabalho do Windows PowerShell usará automaticamente os dados no ponto de verificação mais recente para recuperar e retomar o fluxo de trabalho.

Quando você executa o fluxo de trabalho como um trabalho, como usando o parâmetro comum de fluxo de trabalho AsJob, os pontos de verificação do fluxo de trabalho são mantidos até que você exclua o trabalho, como usando o cmdlet Remove-Job. Caso contrário, os pontos de verificação do fluxo de trabalho serão excluídos quando o fluxo de trabalho for concluído.

OUTRAS TÉCNICAS DE CHECKPOINT

Além da atividade Checkpoint-Workflow, o Fluxo de Trabalho do Windows PowerShell oferece suporte a outras técnicas de checkpoint, incluindo as seguintes:

  • Parâmetro comum do fluxo de trabalho PSPersist
  • Parâmetro comum da atividade PSPersist
  • Variável PSPersistPreference (em um fluxo de trabalho)

Para obter mais informações sobre como adicionar um ponto de verificação a um fluxo de trabalho, consulte "Como adicionar pontos de verificação a um fluxo de trabalho".

Exemplos

O fluxo de trabalho a seguir inclui uma chamada para a atividade Checkpoint-Workflow depois de concluir uma função de longa execução e um script que compartilha dados.

Workflow Test-Workflow
{
    $a = Invoke-LongRunningFunction
    InlineScript { \\Server\Share\Get-DataPacks.ps1 $Using:a}
    Checkpoint-Workflow

    Invoke-LongRunningFunction
    {
        ...
    }
}

Consulte Também