Microsoft.AzureStackHCI clusters/updates/updateRuns

ARM template resource definition

The clusters/updates/updateRuns resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.AzureStackHCI/clusters/updates/updateRuns resource, add the following JSON to your template.

{
  "type": "Microsoft.AzureStackHCI/clusters/updates/updateRuns",
  "apiVersion": "2023-11-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "duration": "string",
    "lastUpdatedTime": "string",
    "progress": {
      "description": "string",
      "endTimeUtc": "string",
      "errorMessage": "string",
      "lastUpdatedTimeUtc": "string",
      "name": "string",
      "startTimeUtc": "string",
      "status": "string",
      "steps": [
        {
    },
    "state": "string",
    "timeStarted": "string"
  }
}

Property values

clusters/updates/updateRuns

Name Description Value
type The resource type 'Microsoft.AzureStackHCI/clusters/updates/updateRuns'
apiVersion The resource api version '2023-11-01-preview'
name The resource name

See how to set names and types for child resources in JSON ARM templates.
string (required)
location The geo-location where the resource lives string
properties Describes Update Run Properties. UpdateRunProperties

UpdateRunProperties

Name Description Value
duration Duration of the update run. string
lastUpdatedTime Timestamp of the most recently completed step in the update run. string
progress Progress representation of the update run steps. Step
state State of the update run. 'Failed'
'InProgress'
'Succeeded'
'Unknown'

timeStarted Timestamp of the update run was started. string

Step

Name Description Value
description More detailed description of the step. string
endTimeUtc When the step reached a terminal state. string
errorMessage Error message, specified if the step is in a failed state. string
lastUpdatedTimeUtc Completion time of this step or the last completed sub-step. string
name Name of the step. string
startTimeUtc When the step started, or empty if it has not started executing. string
status Status of the step, bubbled up from the ECE action plan for installation attempts. Values are: 'Success', 'Error', 'InProgress', and 'Unknown status'. string
steps Recursive model for child steps of this step. Step[]