UpdateSummary interface

Details about ongoing updates and availability of updates on the device.

Extends

Properties

deviceLastScannedDateTime

The last time when a scan was done on the device.

deviceVersionNumber

The current version of the device in format: 1.2.17312.13.",

friendlyDeviceVersionName

The current version of the device in text format.

inProgressDownloadJobId

The job ID of the download job in progress. NOTE: This property will not be serialized. It can only be populated by the server.

inProgressDownloadJobStartedDateTime

The time when the currently running download (if any) started. NOTE: This property will not be serialized. It can only be populated by the server.

inProgressInstallJobId

The job ID of the install job in progress. NOTE: This property will not be serialized. It can only be populated by the server.

inProgressInstallJobStartedDateTime

The time when the currently running install (if any) started. NOTE: This property will not be serialized. It can only be populated by the server.

lastCompletedDownloadJobDateTime

The time when the last Download job was completed (success/cancelled/failed) on the appliance. NOTE: This property will not be serialized. It can only be populated by the server.

lastCompletedInstallJobDateTime

The time when the last Install job was completed (success/cancelled/failed) on the appliance. NOTE: This property will not be serialized. It can only be populated by the server.

lastCompletedScanJobDateTime

The time when the last scan job was completed (success/cancelled/failed) on the appliance.

ongoingUpdateOperation

The current update operation. NOTE: This property will not be serialized. It can only be populated by the server.

rebootBehavior

Indicates if updates are available and at least one of the updates needs a reboot. NOTE: This property will not be serialized. It can only be populated by the server.

totalNumberOfUpdatesAvailable

The number of updates available for the current device version as per the last device scan. NOTE: This property will not be serialized. It can only be populated by the server.

totalNumberOfUpdatesPendingDownload

The total number of items pending download. NOTE: This property will not be serialized. It can only be populated by the server.

totalNumberOfUpdatesPendingInstall

The total number of items pending install. NOTE: This property will not be serialized. It can only be populated by the server.

totalUpdateSizeInBytes

The total size of updates available for download in bytes. NOTE: This property will not be serialized. It can only be populated by the server.

updateTitles

The list of updates available for install. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

name

The object name. NOTE: This property will not be serialized. It can only be populated by the server.

type

The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

deviceLastScannedDateTime

The last time when a scan was done on the device.

deviceLastScannedDateTime?: Date

Property Value

Date

deviceVersionNumber

The current version of the device in format: 1.2.17312.13.",

deviceVersionNumber?: string

Property Value

string

friendlyDeviceVersionName

The current version of the device in text format.

friendlyDeviceVersionName?: string

Property Value

string

inProgressDownloadJobId

The job ID of the download job in progress. NOTE: This property will not be serialized. It can only be populated by the server.

inProgressDownloadJobId?: string

Property Value

string

inProgressDownloadJobStartedDateTime

The time when the currently running download (if any) started. NOTE: This property will not be serialized. It can only be populated by the server.

inProgressDownloadJobStartedDateTime?: Date

Property Value

Date

inProgressInstallJobId

The job ID of the install job in progress. NOTE: This property will not be serialized. It can only be populated by the server.

inProgressInstallJobId?: string

Property Value

string

inProgressInstallJobStartedDateTime

The time when the currently running install (if any) started. NOTE: This property will not be serialized. It can only be populated by the server.

inProgressInstallJobStartedDateTime?: Date

Property Value

Date

lastCompletedDownloadJobDateTime

The time when the last Download job was completed (success/cancelled/failed) on the appliance. NOTE: This property will not be serialized. It can only be populated by the server.

lastCompletedDownloadJobDateTime?: Date

Property Value

Date

lastCompletedInstallJobDateTime

The time when the last Install job was completed (success/cancelled/failed) on the appliance. NOTE: This property will not be serialized. It can only be populated by the server.

lastCompletedInstallJobDateTime?: Date

Property Value

Date

lastCompletedScanJobDateTime

The time when the last scan job was completed (success/cancelled/failed) on the appliance.

lastCompletedScanJobDateTime?: Date

Property Value

Date

ongoingUpdateOperation

The current update operation. NOTE: This property will not be serialized. It can only be populated by the server.

ongoingUpdateOperation?: string

Property Value

string

rebootBehavior

Indicates if updates are available and at least one of the updates needs a reboot. NOTE: This property will not be serialized. It can only be populated by the server.

rebootBehavior?: string

Property Value

string

totalNumberOfUpdatesAvailable

The number of updates available for the current device version as per the last device scan. NOTE: This property will not be serialized. It can only be populated by the server.

totalNumberOfUpdatesAvailable?: number

Property Value

number

totalNumberOfUpdatesPendingDownload

The total number of items pending download. NOTE: This property will not be serialized. It can only be populated by the server.

totalNumberOfUpdatesPendingDownload?: number

Property Value

number

totalNumberOfUpdatesPendingInstall

The total number of items pending install. NOTE: This property will not be serialized. It can only be populated by the server.

totalNumberOfUpdatesPendingInstall?: number

Property Value

number

totalUpdateSizeInBytes

The total size of updates available for download in bytes. NOTE: This property will not be serialized. It can only be populated by the server.

totalUpdateSizeInBytes?: number

Property Value

number

updateTitles

The list of updates available for install. NOTE: This property will not be serialized. It can only be populated by the server.

updateTitles?: string[]

Property Value

string[]

Inherited Property Details

id

The path ID that uniquely identifies the object. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ARMBaseModel.id

name

The object name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ARMBaseModel.name

type

The hierarchical type of the object. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ARMBaseModel.type