< Back

Update-Progress

Sat Jan 18, 2020 7:42 pm

NAME Update-Progress



SYNOPSIS

Updates the progress of the currently running stage.





SYNTAX

Update-Progress [-Progress] <Int32> [-CurrentOperation] <String> [<CommonParameters>]





DESCRIPTION

Updates the progress and the current operation of the currently running stage,

reflecting these changes in the script's progress bar (if any).





PARAMETERS

-Progress <Int32>

The progress (in percentage) of the stage.



Required? true

Position? 1

Default value 0

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-CurrentOperation <String>

The current operation being performed by the stage.



Required? true

Position? 2

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





This operation will not succeed unless a stage is currently running.



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Update-Progress 15 "Updating firmware"



Update the currently running stage's progress to 15% and its current operation to

"Updating firmware"











RELATED LINKS