Step interface

Package:

@azure/arm-azurestackhci

Progress representation of the update run steps.

Properties

description	More detailed description of the step.
endTimeUtc	When the step reached a terminal state.
errorMessage	Error message, specified if the step is in a failed state.
expectedExecutionTime	Expected execution time of a given step. This is optionally authored in the update action plan and can be empty.
lastUpdatedTimeUtc	Completion time of this step or the last completed sub-step.
name	Name of the step.
startTimeUtc	When the step started, or empty if it has not started executing.
status	Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.
steps	Recursive model for child steps of this step.

Property Details

description

More detailed description of the step.

description?: string

Property Value

string

endTimeUtc

When the step reached a terminal state.

endTimeUtc?: Date

Property Value

Date

errorMessage

Error message, specified if the step is in a failed state.

errorMessage?: string

Property Value

string

expectedExecutionTime

Expected execution time of a given step. This is optionally authored in the update action plan and can be empty.

expectedExecutionTime?: string

Property Value

string

lastUpdatedTimeUtc

Completion time of this step or the last completed sub-step.

lastUpdatedTimeUtc?: Date

Property Value

Date

name

Name of the step.

name?: string

Property Value

string

startTimeUtc

When the step started, or empty if it has not started executing.

startTimeUtc?: Date

Property Value

Date

status

Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'.

status?: string

Property Value

string

steps

Recursive model for child steps of this step.

steps?: Step[]

Property Value

Step[]