Partager via

Write-Progress

  • Référence
Module:
Microsoft.PowerShell.Utility

Affiche une barre de progression dans une fenêtre de commande PowerShell.

Syntaxe

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

Description

L’applet de commande Write-Progress affiche une barre de progression dans une fenêtre de commande PowerShell qui représente l’état d’une commande ou d’un script en cours d’exécution. Vous pouvez sélectionner les indicateurs que la barre reflète et le texte qui apparaît au-dessus et au-dessous de la barre de progression.

Exemples

Exemple 1 : Afficher la progression d’une boucle For

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

Cette commande affiche la progression d’une boucle For qui compte entre 1 et 100.

L’applet de commande Write-Progress inclut un titre de barre d’état Activity, une ligne d’état et la variable $i (le compteur dans la boucle For), qui indique l’exhaustivité relative de la tâche.

Exemple 2 : Afficher la progression des boucles For imbriquées

for($I = 1; $I -lt 101; $I++ )
{
    Write-Progress -Activity Updating -Status 'Progress->' -PercentComplete $I -CurrentOperation OuterLoop
    for($j = 1; $j -lt 101; $j++ )
    {
        Write-Progress -Id 1 -Activity Updating -Status 'Progress' -PercentComplete $j -CurrentOperation InnerLoop
    }
}

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

Cet exemple montre comment afficher la progression de deux boucles For imbriquées, chacune étant représentée par une barre de progression.

La commande Write-Progress de la deuxième barre de progression inclut le paramètre ID qui le distingue de la première barre de progression.

Sans le paramètre ID, les barres de progression sont superposées les unes sur les autres au lieu d’être affichées l’une en dessous de l’autre.

Exemple 3 : Afficher la progression lors de la recherche d’une chaîne

# 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 a 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
    # 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 ($i/$Events.count*100)
} -End {
    # Display the matching messages using the out variable.
    $out
}

Cette commande affiche la progression d’une commande pour rechercher la chaîne « bios » dans le journal des événements système.

La valeur du paramètre PercentComplete est calculée en divisant le nombre d’événements qui ont été traités par le nombre total d’événements récupérés , puis en multipliant ce résultat par 100.

Exemple 4 : Afficher la progression pour chaque niveau d’un processus imbriqué

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 -m 150
    }
  }
}

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

Dans cet exemple, vous pouvez utiliser le paramètre ParentId pour avoir une sortie mise en retrait pour afficher les relations parent/enfant dans la progression de chaque étape.

Paramètres

-Activity

Spécifie la première ligne de texte dans le titre au-dessus de la barre d’état. Ce texte décrit l’activité dont la progression est signalée.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Completed

Indique si la barre de progression est visible. Si ce paramètre est omis, Write-Progress affiche des informations de progression.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CurrentOperation

Spécifie la ligne de texte sous la barre de progression. Ce texte décrit l’opération en cours.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Id

Spécifie un ID qui distingue chaque barre de progression des autres. Utilisez ce paramètre lorsque vous créez plusieurs barres de progression dans une seule commande. Si les barres de progression n’ont pas d’ID différents, elles sont superposées au lieu d’être affichées dans une série. Les valeurs négatives ne sont pas autorisées.

Type:Int32
Position:2
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ParentId

Spécifie l’activité parente de l’activité actuelle. Utilisez la valeur -1 si l’activité actuelle n’a aucune activité parente.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PercentComplete

Spécifie le pourcentage de l’activité terminée. Utilisez la valeur -1 si le pourcentage terminé est inconnu ou non applicable.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SecondsRemaining

Spécifie le nombre projeté de secondes restant jusqu’à ce que l’activité soit terminée. Utilisez la valeur -1 si le nombre de secondes restant est inconnu ou non applicable.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-SourceId

Spécifie la source de l’enregistrement. Vous pouvez l’utiliser à la place de ID, mais ne peut pas être utilisé avec d’autres paramètres comme ParentId.

Type:Int32
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Status

Spécifie la deuxième ligne de texte dans le titre au-dessus de la barre d’état. Ce texte décrit l’état actuel de l’activité.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

None

Vous ne pouvez pas diriger l’entrée vers cette applet de commande.

Sorties

None

Write-Progress ne génère aucune sortie.

Notes

Si la barre de progression n’apparaît pas, vérifiez la valeur de la variable $ProgressPreference. Si la valeur est définie sur SilentlyContinue, la barre de progression n’est pas affichée. Pour plus d’informations sur les préférences PowerShell, consultez about_Preference_Variables.

Les paramètres de l’applet de commande correspondent aux propriétés de la classe System.Management.Automation.ProgressRecord. Pour plus d’informations, consultez classe ProgressRecord.