UpdateRun interface
Details of an Update run
- Extends
Properties
| description | More detailed description of the step. |
| duration | Duration of the update run. |
| end |
When the step reached a terminal state. |
| error |
Error message, specified if the step is in a failed state. |
| expected |
Expected execution time of a given step. This is optionally authored in the update action plan and can be empty. |
| last |
Timestamp of the most recently completed step in the update run. |
| last |
Completion time of this step or the last completed sub-step. |
| location | The geo-location where the resource lives |
| name |
Name of the step. |
| provisioning |
Provisioning state of the UpdateRuns proxy resource. NOTE: This property will not be serialized. It can only be populated by the server. |
| start |
When the step started, or empty if it has not started executing. |
| state | State of the update run. |
| 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. |
| time |
Timestamp of the update run was started. |
Inherited Properties
| id | Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server. |
| name | The name of the resource NOTE: This property will not be serialized. It can only be populated by the server. |
| system |
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server. |
| type | The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server. |
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
location
The geo-location where the resource lives
location?: string
Property Value
string
namePropertiesProgressName
Name of the step.
namePropertiesProgressName?: string
Property Value
string
provisioningState
Provisioning state of the UpdateRuns proxy resource. NOTE: This property will not be serialized. It can only be populated by the server.
provisioningState?: string
Property Value
string
startTimeUtc
When the step started, or empty if it has not started executing.
startTimeUtc?: Date
Property Value
Date
state
State of the update run.
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
timeStarted
Timestamp of the update run was started.
timeStarted?: Date
Property Value
Date
Inherited Property Details
id
Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" NOTE: This property will not be serialized. It can only be populated by the server.
id?: string
Property Value
string
Inherited From ProxyResource.id
name
The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
name?: string
Property Value
string
Inherited From ProxyResource.name
systemData
Azure Resource Manager metadata containing createdBy and modifiedBy information. NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemData
Property Value
Inherited From ProxyResource.systemData
type
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.
type?: string
Property Value
string
Inherited From ProxyResource.type