Cmdlet

Update-ConsoleRun

Module: ConsoleMonster
Inputs: None

Reports an item's running phase or final outcome to a run dashboard.

Syntax

Update-ConsoleRun
[-Duration <TimeSpan>]
-Index <Int32>
[-Message <String>]
[-Phase <String>]
[-Run] <LiveRun>
-State <StatusKind>
[<CommonParameters>]

Parameter set: All Parameter Sets

Description

Index is the zero-based position in New-ConsoleRun's Items. Running starts the item or updates its phase without resetting elapsed time. Pass, Fail, Warn and Skip finish an item once; repeated completions do not print duplicate lines. Updates do not produce pipeline output or change the caller's error handling. For direct worker-thread use the handle exposes Started and Finished methods with the same contracts.

Examples

Example 1

Update-ConsoleRun $run -Index 0 -State Running -Phase 'collecting'; Update-ConsoleRun $run -Index 0 -State Warn -Message 'Response was incomplete'

Start and finish one item

Parameters

-Duration TimeSpan optional: Optional measured duration. Default time since the Running update.
-Index Int32 required: Zero-based item position.
-Message String optional: Full completion detail, retained for the final summary.
-Phase String optional: Literal phase text for a Running update.
-Run LiveRun requiredposition: 0: The handle returned by New-ConsoleRun.
-State StatusKind required: Running, Pass, Fail, Warn or Skip.; Possible values: Pending, Running, Pass, Fail, Warn, Skip, Info

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.