Share via


UpdateRunProperties interface

Details of an Update run

Properties

description

More detailed description of the step.

duration

Duration of the update run.

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.

lastUpdatedTime

Timestamp of the most recently completed step in the update run.

lastUpdatedTimeUtc

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

name

Name of the step.

provisioningState

Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed.

startTimeUtc

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

state

Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state.

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.

timeStarted

Timestamp of the update run was started.

Property Details

description

More detailed description of the step.

description?: string

Property Value

string

duration

Duration of the update run.

duration?: 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

lastUpdatedTime

Timestamp of the most recently completed step in the update run.

lastUpdatedTime?: Date

Property Value

Date

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

provisioningState

Provisioning state of the UpdateRuns proxy resource. Indicates the current lifecycle status of the update operation, such as whether it has been accepted, is in progress, or has completed.

provisioningState?: string

Property Value

string

startTimeUtc

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

startTimeUtc?: Date

Property Value

Date

state

Represents the current state of the update run. Indicates whether the update is in progress, has completed successfully, failed, or is in an unknown state.

state?: string

Property Value

string

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[]

timeStarted

Timestamp of the update run was started.

timeStarted?: Date

Property Value

Date