Write-Progress

  • Riferimento
Modulo:
Microsoft.PowerShell.Utility

Visualizza una barra di stato all'interno di una finestra di comando di PowerShell.

Sintassi

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

Descrizione

Il Write-Progress cmdlet visualizza una barra di stato in una finestra di comando di PowerShell che illustra lo stato di un comando o di uno script in esecuzione. È possibile selezionare i singoli indicatori e il testo visualizzato sopra e sotto l'indicatore di stato.

PowerShell 7.2 ha aggiunto la $PSStyle variabile automatica usata per controllare il modo in cui PowerShell visualizza determinate informazioni usando sequenze di escape ANSI. Il $PSStyle.Progress membro consente di controllare il rendering della barra di avanzamento della visualizzazione.

  • $PSStyle.Progress.Style - Stringa ANSI che imposta lo stile di rendering.
  • $PSStyle.Progress.MaxWidth - Imposta la larghezza massima della visualizzazione. Il valore predefinito è 120. Il valore minimo è 18.
  • $PSStyle.Progress.View - Enumerazione con valori Minimal e Classic. Classic è il rendering esistente senza modifiche. Minimal è un rendering minimo a riga singola. Minimal è l'impostazione predefinita.

Per altre informazioni su $PSStyle, vedere about_ANSI_Terminals.md.

Nota

Se l'host non supporta il terminale virtuale, $PSStyle.Progress.View viene impostato automaticamente su Classic.

Esempio

Esempio 1: Visualizzare lo stato di avanzamento di un ciclo For

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

Questo comando visualizza lo stato di avanzamento di un for ciclo che conta da 1 a 100.

Il Write-Progress cmdlet include un'intestazione Activitydella barra di stato , una riga di stato e la variabile (il contatore $i nel for ciclo), che indica la completezza relativa dell'attività.

Esempio 2: Visualizzare lo stato di avanzamento dei cicli For annidati

$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

In questo esempio viene impostata la visualizzazione Classic dello stato di avanzamento su e quindi viene visualizzato lo stato di avanzamento di due cicli annidati for , ognuno rappresentato da un indicatore di stato.

Il Write-Progress comando per la seconda barra di stato include il parametro Id che lo distingue dalla prima barra di stato.

Senza il parametro Id , le barre di stato verranno sovrapposte l'una all'altra anziché essere visualizzate una sotto l'altra.

Esempio 3: Visualizzare lo stato di avanzamento durante la ricerca di una stringa

# 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
}

Questo comando visualizza lo stato di avanzamento di un comando per individuare la stringa "bios" nel registro eventi di sistema.

Il valore del parametro PercentComplete viene calcolato dividendo il numero di eventi elaborati $i dal numero totale di eventi recuperati $Events.count e moltiplicando il risultato per 100.

Esempio 4: Visualizzare lo stato di avanzamento per ogni livello di un processo annidato

$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

In questo esempio è possibile usare il parametro ParentId per avere un output rientrato per visualizzare le relazioni padre-figlio nello stato di avanzamento di ogni passaggio.

Parametri

-Activity

Specifica la prima riga di testo dell'intestazione sopra la barra di stato. Il testo descrive l'attività di cui è segnalato lo stato di avanzamento.

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

-Completed

Indica se l'indicatore di stato è visibile. Se questo parametro viene omesso, Write-Progress visualizza le informazioni sullo stato di avanzamento.

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

-CurrentOperation

Specifica la riga di testo sotto l'indicatore di stato. Questo testo descrive l'operazione attualmente in corso.

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

-Id

Specifica un ID che distingue ogni indicatore di stato dagli altri. Usare questo parametro quando occorre creare più indicatori di stato in un unico comando. Se le barre di stato non hanno ID diversi, vengono sovrapposti anziché essere visualizzati in una serie. I valori negativi non sono consentiti.

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

-ParentId

Specifica l'attività padre dell'attività corrente. Usare il valore -1 se l'attività corrente non ha attività padre.

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

-PercentComplete

Specifica la percentuale dell'attività completata. Usare il valore -1 se la percentuale di completamento è sconosciuta o non applicabile.

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

-SecondsRemaining

Specifica il numero previsto di secondi rimanenti per il completamento dell'attività. Usare il valore -1 se il numero di secondi rimanenti è sconosciuto o non applicabile.

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

-SourceId

Specifica l'origine del record. È possibile usarlo al posto dell'ID, ma non può essere usato con altri parametri come ParentId.

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

-Status

Specifica la seconda riga di testo dell'intestazione sopra la barra di stato. Il testo descrive lo stato corrente dell'attività.

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

Input

None

Non è possibile inviare tramite pipe oggetti a questo cmdlet.

Output

None

Questo cmdlet non restituisce output.

Note

Se la barra di stato non viene visualizzata, controllare il valore della $ProgressPreference variabile. Se il valore è impostato su SilentlyContinue, l'indicatore di stato non viene visualizzato. Per altre informazioni sulle preferenze di PowerShell, vedere about_Preference_Variables.

I parametri del cmdlet corrispondono alle proprietà della classe System.Management.Automation.ProgressRecord . Per altre informazioni, vedere Classe ProgressRecord.