Write-Progress

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Muestra una barra de progreso dentro de una ventana de comandos de PowerShell.

Syntax

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

Description

El Write-Progress cmdlet muestra una barra de progreso en una ventana de comandos de PowerShell que muestra el estado de un comando o script en ejecución. Puede seleccionar los indicadores que la barra refleja y el texto que aparece encima y debajo de la barra de progreso.

PowerShell 7.2 agregó la $PSStyle variable automática que se usa para controlar cómo PowerShell muestra cierta información mediante secuencias de escape ANSI. El $PSStyle.Progress miembro permite controlar la representación de la barra de vista de progreso.

  • $PSStyle.Progress.Style: una cadena ANSI que establece el estilo de representación.
  • $PSStyle.Progress.MaxWidth: establece el ancho máximo de la vista. Tiene como valor predeterminado 120. El valor mínimo es 18.
  • $PSStyle.Progress.View: una enumeración con los valores Minimal y Classic. Classic es la representación existente sin cambios. Minimal es una representación mínima de una sola línea. Minimal es el valor predeterminado.

Para obtener más información sobre $PSStyle, vea about_ANSI_Terminals.md.

Nota:

Si el host no admite Virtual Terminal, $PSStyle.Progress.View se establece automáticamente en Classic.

Ejemplos

Ejemplo 1: Mostrar el progreso de un bucle 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 muestra el progreso de un for bucle que cuenta de 1 a 100.

El Write-Progress cmdlet incluye un encabezado Activityde barra de estado , una línea de estado y la variable $i (el contador en el for bucle), que indica la integridad relativa de la tarea.

Ejemplo 2: Mostrar el progreso de los bucles For anidados

$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           = 'Progress'
            PercentComplete  = $j
            CurrentOperation = 'InnerLoop'
        }
        Write-Progress @InnerLoopProgressParameters
        Start-Sleep -Milliseconds 25
    }
}

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

En este ejemplo se establece la vista Classic de progreso en y, a continuación, se muestra el progreso de dos bucles anidados for , cada uno representado por una barra de progreso.

El Write-Progress comando de la segunda barra de progreso incluye el parámetro Id que lo distingue de la primera barra de progreso.

Sin el parámetro Id , las barras de progreso se superponen entre sí en lugar de mostrarse una debajo de la otra.

Ejemplo 3: Mostrar el progreso al buscar una cadena

# 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 muestra el progreso de un comando para buscar la cadena "bios" en el registro de eventos del sistema (system).

El valor del parámetro PercentComplete se calcula dividiendo el número de eventos procesados $i por el número total de eventos recuperados $Events.count y multiplicando ese resultado en 100.

Ejemplo 4: Mostrar el progreso de cada nivel de un proceso anidado

$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

En este ejemplo, puede usar el parámetro ParentId para tener una salida con sangría para mostrar las relaciones de elementos primarios y secundarios en el progreso de cada paso.

Parámetros

-Activity

Especifica la primera línea de texto del título situado encima de la barra de estado. Este texto describe la actividad cuyo progreso se notifica.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Completed

Indica si la barra de progreso está visible. Si se omite este parámetro, Write-Progress muestra información de progreso.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CurrentOperation

Especifica la línea de texto situada debajo de la barra de progreso. En este texto se describe la operación que está teniendo lugar actualmente.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Especifica un identificador que distingue cada barra de progreso. Utilice este parámetro si va a crear más de una barra de progreso en un solo comando. Si las barras de progreso no tienen identificadores diferentes, se superponen en lugar de mostrarse en una serie. No se permiten valores negativos.

Type:Int32
Position:2
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ParentId

Especifica la actividad primaria de la actividad actual. Use el valor -1 si la actividad actual no tiene ninguna actividad primaria.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PercentComplete

Especifica el porcentaje de la actividad que se ha completado. Use el valor -1 si el porcentaje completado es desconocido o no aplicable.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SecondsRemaining

Especifica el número previsto de segundos que quedan hasta que se complete la actividad. Use el valor -1 si el número de segundos restantes es desconocido o no aplicable.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SourceId

Especifica el origen del registro. Puede usarlo en lugar del identificador , pero no se puede usar con otros parámetros como ParentId.

Type:Int32
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Status

Especifica la segunda línea de texto del título situado encima de la barra de estado. Este texto describe el estado actual de la actividad.

Type:String
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

None

No se pueden canalizar objetos a este cmdlet.

Salidas

None

Este cmdlet no devuelve ningún resultado.

Notas

Si la barra de progreso no aparece, compruebe el valor de la $ProgressPreference variable. Si el valor se establece SilentlyContinueen , no se muestra la barra de progreso. Para obtener más información sobre las preferencias de PowerShell, consulte about_Preference_Variables.

Los parámetros del cmdlet corresponden a las propiedades de la clase System.Management.Automation.ProgressRecord . Para obtener más información, vea ProgressRecord (clase).