Write-Progress

Sintaxe

Write-Progress
     [[-Activity] <String>]
     [[-Status] <String>]
     [[-Id] <Int32>]
     [-PercentComplete <Int32>]
     [-SecondsRemaining <Int32>]
     [-CurrentOperation <String>]
     [-ParentId <Int32>]
     [-Completed]
     [-SourceId <Int32>]
     [<CommonParameters>]

Description

O Write-Progress cmdlet exibe uma barra de progresso em uma janela de comando do PowerShell que descreve o status de um comando ou script em execução. Você pode selecionar os indicadores que a barra reflete e o texto que aparece acima e abaixo da barra de progresso.

O PowerShell 7.2 adicionou a $PSStyle variável automática usada para controlar como o PowerShell exibe determinadas informações usando sequências de escape ANSI. O $PSStyle.Progress membro permite que você controle a renderização da barra de exibição de progresso.

• $PSStyle.Progress.Style - Uma string ANSI definindo o estilo de renderização.
• $PSStyle.Progress.MaxWidth - Define a largura máxima da vista. O padrão é 120. O valor mínimo é 18.
• $PSStyle.Progress.View - Um enum com valores, Minimal e Classic. Classic é a renderização existente sem alterações. Minimal é uma renderização mínima de linha única. Minimal é a predefinição.

Para obter mais informações sobre $PSStyleo , consulte about_ANSI_Terminals.md.

Exemplos

Exemplo 1: Exibir o progresso de um loop For

for ($i = 1; $i -le 100; $i++ ) {
    Write-Progress -Activity "Search in Progress" -Status "$i% Complete:" -PercentComplete $i
    Start-Sleep -Milliseconds 250
}

Este comando exibe o progresso de um for loop que conta de 1 a 100.

O Write-Progress cmdlet inclui um título Activityde barra de status, uma linha de status e a variável $i (o contador no for loop), que indica a relativa completude da tarefa.

Exemplo 2: Exibir o progresso dos loops For aninhados

$PSStyle.Progress.View = 'Classic'

for($I = 0; $I -lt 10; $I++ ) {
    $OuterLoopProgressParameters = @{
        Activity         = 'Updating'
        Status           = 'Progress->'
        PercentComplete  = $I * 10
        CurrentOperation = 'OuterLoop'
    }
    Write-Progress @OuterLoopProgressParameters
    for($j = 1; $j -lt 101; $j++ ) {
        $InnerLoopProgressParameters = @{
            ID               = 1
            Activity         = 'Updating'
            Status           = 'Inner Progress'
            PercentComplete  = $j
            CurrentOperation = 'InnerLoop'
        }
        Write-Progress @InnerLoopProgressParameters
        Start-Sleep -Milliseconds 25
    }
}

Updating
Progress ->
 [ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo]
OuterLoop
Updating
Inner Progress
 [oooooooooooooooooo                                                   ]
InnerLoop

Este exemplo define o modo de exibição progress como Classic e exibe o progresso de dois loops aninhados for , cada um representado por uma barra de progresso.

O Write-Progress comando para a segunda barra de progresso inclui o parâmetro Id que a distingue da primeira barra de progresso.

Sem o parâmetro Id , as barras de progresso seriam sobrepostas umas às outras em vez de serem exibidas uma abaixo da outra.

Exemplo 3: Exibir o progresso ao procurar uma cadeia de caracteres

# Use Get-WinEvent to get the events in the System log and store them in the $Events variable.
$Events = Get-WinEvent -LogName system
# Pipe the events to the ForEach-Object cmdlet.
$Events | ForEach-Object -Begin {
    # In the Begin block, use Clear-Host to clear the screen.
    Clear-Host
    # Set the $i counter variable to zero.
    $i = 0
    # Set the $out variable to an empty string.
    $out = ""
} -Process {
    # In the Process script block search the message property of each incoming object for "bios".
    if($_.message -like "*bios*")
    {
        # Append the matching message to the out variable.
        $out=$out + $_.Message
    }
    # Increment the $i counter variable which is used to create the progress bar.
    $i = $i+1
    # Determine the completion percentage
    $Completed = ($i/$Events.count) * 100
    # Use Write-Progress to output a progress bar.
    # The Activity and Status parameters create the first and second lines of the progress bar
    # heading, respectively.
    Write-Progress -Activity "Searching Events" -Status "Progress:" -PercentComplete $Completed
} -End {
    # Display the matching messages using the out variable.
    $out
}

Este comando exibe o progresso de um comando para localizar a string "bios" no log de eventos do sistema.

O valor do parâmetro PercentComplete é calculado dividindo o número de eventos que foram processados $i pelo número total de eventos recuperados $Events.count e, em seguida, multiplicando esse resultado por 100.

Exemplo 4: Exibir o progresso para cada nível de um processo aninhado

$PSStyle.Progress.View = 'Classic'

foreach ( $i in 1..10 ) {
  Write-Progress -Id 0 "Step $i"
  foreach ( $j in 1..10 ) {
    Write-Progress -Id 1 -ParentId 0 "Step $i - Substep $j"
    foreach ( $k in 1..10 ) {
      Write-Progress -Id 2  -ParentId 1 "Step $i - Substep $j - iteration $k"
      Start-Sleep -Milliseconds 150
    }
  }
}

Step 1
     Processing
    Step 1 - Substep 2
         Processing
        Step 1 - Substep 2 - Iteration 3
             Processing

Neste exemplo, você pode usar o parâmetro ParentId para ter saída recuada para mostrar relações pai-filho no progresso de cada etapa.

Parâmetros

-Activity

-Completed

-CurrentOperation

-Id

-ParentId

-PercentComplete

-SecondsRemaining

-SourceId

-Status

Entradas

None

Não é possível canalizar objetos para este cmdlet.

Saídas

None

Este cmdlet não retorna nenhuma saída.

Notas

Se a barra de progresso não aparecer, verifique o valor da $ProgressPreference variável. Se o valor estiver definido como SilentlyContinue, a barra de progresso não será exibida. Para obter mais informações sobre as preferências do PowerShell, consulte about_Preference_Variables.

Os parâmetros do cmdlet correspondem às propriedades da classe System.Management.Automation.ProgressRecord . Para obter mais informações, consulte Classe ProgressRecord.

Ligações Relacionadas

• Write-Debug
• Write-Error
• Write-Host
• Write-Output
• Write-Progress
• Write-Verbose
• Write-Warning