Share via

Update interface

Package:
@azure/arm-azurestackhci

Update details

Extends
ProxyResource

Properties

additionalProperties

Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.
availabilityType

Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification.
componentVersions

An array of component versions for a Solution Bundle update, and an empty array otherwise.
description

Description of the update.
displayName

Display name of the Update
healthCheckDate

Last time the package-specific checks were run.
healthCheckResult

An array of PrecheckResult objects.
healthState

Overall health state for update-specific health checks.
installedDate

Date that the update was installed.
location

The geo-location where the resource lives
minSbeVersionRequired

Minimum Sbe Version of the update.
packagePath

Path where the update package is available.
packageSizeInMb

Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.
packageType

Customer-visible type of the update.
prerequisites

If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.
provisioningState

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

Publisher of the update package.
rebootRequired

Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process.
releaseLink

Link to release notes for the update.
state

Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered.
updateStateProperties

Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.
version

Version of the update.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

The name of the resource
systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Property Details

additionalProperties

Extensible KV pairs serialized as a string. This is currently used to report the stamp OEM family and hardware model information when an update is flagged as Invalid for the stamp based on OEM type.

additionalProperties?: string

Property Value

string

availabilityType

Indicates how the update content is made available for download. This determines whether the update is sourced locally, from an online repository, or requires user notification.

availabilityType?: string

Property Value

string

componentVersions

An array of component versions for a Solution Bundle update, and an empty array otherwise.

componentVersions?: PackageVersionInfo[]

Property Value

PackageVersionInfo[]

description

Description of the update.

description?: string

Property Value

string

displayName

Display name of the Update

displayName?: string

Property Value

string

healthCheckDate

Last time the package-specific checks were run.

healthCheckDate?: Date

Property Value

Date

healthCheckResult

An array of PrecheckResult objects.

healthCheckResult?: PrecheckResult[]

Property Value

PrecheckResult[]

healthState

Overall health state for update-specific health checks.

healthState?: string

Property Value

string

installedDate

Date that the update was installed.

installedDate?: Date

Property Value

Date

location

The geo-location where the resource lives

location?: string

Property Value

string

minSbeVersionRequired

Minimum Sbe Version of the update.

minSbeVersionRequired?: string

Property Value

string

packagePath

Path where the update package is available.

packagePath?: string

Property Value

string

packageSizeInMb

Size of the package. This value is a combination of the size from update metadata and size of the payload that results from the live scan operation for OS update content.

packageSizeInMb?: number

Property Value

number

packageType

Customer-visible type of the update.

packageType?: string

Property Value

string

prerequisites

If update State is HasPrerequisite, this property contains an array of objects describing prerequisite updates before installing this update. Otherwise, it is empty.

prerequisites?: UpdatePrerequisite[]

Property Value

UpdatePrerequisite[]

provisioningState

Provisioning state of the Updates 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

publisher

Publisher of the update package.

publisher?: string

Property Value

string

rebootRequired

Indicates whether a reboot is required after the update or operation. Helps determine if a system restart is necessary to complete the process.

rebootRequired?: string

Property Value

string

Link to release notes for the update.

releaseLink?: string

Property Value

string

state

Represents the current state of the update as it relates to this stamp. This includes phases such as preparation, installation, scanning, and error handling, providing insight into the update's progress and any issues encountered.

state?: string

Property Value

string

updateStateProperties

Additional information regarding the state of the update. See definition of UpdateStateProperties type below for more details on this property.

updateStateProperties?: UpdateStateProperties

Property Value

UpdateStateProperties

version

Version of the update.

version?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource

name?: string

Property Value

string

Inherited From ProxyResource.name

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

systemData?: SystemData

Property Value

SystemData

Inherited From ProxyResource.systemData

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

type?: string

Property Value

string

Inherited From ProxyResource.type