Microsoft.AzureStackHCI clusters/updates/updateRuns 2023-08-01

Bicep 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 Bicep to your template.

resource symbolicname 'Microsoft.AzureStackHCI/clusters/updates/updateRuns@2023-08-01' = {
  parent: resourceSymbolicName
  location: 'string'
  name: '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

Microsoft.AzureStackHCI/clusters/updates/updateRuns

Name Description Value
location The geo-location where the resource lives string
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: clusters/updates
properties Describes Update Run Properties. UpdateRunProperties

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

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

ARM template resource definition

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

Usage Examples

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-08-01",
  "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

Microsoft.AzureStackHCI/clusters/updates/updateRuns

Name Description Value
apiVersion The api version '2023-08-01'
location The geo-location where the resource lives string
name The resource name string (required)
properties Describes Update Run Properties. UpdateRunProperties
type The resource type 'Microsoft.AzureStackHCI/clusters/updates/updateRuns'

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

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

Terraform (AzAPI provider) resource definition

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

  • Resource groups 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 Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.AzureStackHCI/clusters/updates/updateRuns@2023-08-01"
  name = "string"
  parent_id = "string"
  location = "string"
  body = {
    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

Microsoft.AzureStackHCI/clusters/updates/updateRuns

Name Description Value
location The geo-location where the resource lives string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: clusters/updates
properties Describes Update Run Properties. UpdateRunProperties
type The resource type "Microsoft.AzureStackHCI/clusters/updates/updateRuns@2023-08-01"

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

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
  • Last updated on