< Back

Complete-Stage

Sat Jan 18, 2020 7:42 pm

NAME Complete-Stage



SYNOPSIS

Marks the currently running stage as completed.





SYNTAX

Complete-Stage [[-CurrentOperation] <String>] [<CommonParameters>]





DESCRIPTION

Marks the currently running stage as completed, updating its current operation in the

process. This is useful when the script should exit earlier then the end of the final

stage (e.g. when the script prepares an interactive environment and the final stage

drops into this environment - the script should be deemed complete even though the

final stage is still waiting on the interactive environment to be closed).





PARAMETERS

-CurrentOperation <String>

The current operation being performed by the stage.



Required? false

Position? 1

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:\\>Complete-Stage "Running from remote at $Address"



Manually mark the currently running stage as complete, updating its current operation

to "Running from remote at $Address"











RELATED LINKS