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 the way the update content can be downloaded.
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.
notifyMessage	Brief message with instructions for updates of AvailabilityType Notify.
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.
progressPercentage	Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.
provisioningState	Provisioning state of the Updates proxy resource. NOTE: This property will not be serialized. It can only be populated by the server.
publisher	Publisher of the update package.
rebootRequired
releaseLink	Link to release notes for the update.
state	State of the update as it relates to this stamp.
version	Version of the update.

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.
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.
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

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 the way the update content can be downloaded.

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

notifyMessage

Brief message with instructions for updates of AvailabilityType Notify.

notifyMessage?: 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[]

progressPercentage

Progress percentage of ongoing operation. Currently this property is only valid when the update is in the Downloading state, where it maps to how much of the update content has been downloaded.

progressPercentage?: number

Property Value

number

provisioningState

Provisioning state of the Updates proxy resource. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

publisher

Publisher of the update package.

publisher?: string

Property Value

string

rebootRequired

rebootRequired?: string

Property Value

string

releaseLink

Link to release notes for the update.

releaseLink?: string

Property Value

string

state

State of the update as it relates to this stamp.

state?: string

Property Value

string

version

Version of the update.

version?: string

Property Value

string

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

SystemData

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