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.

inProgressDownloadJobStartedDateTime

The time when the currently running download (if any) started.

inProgressInstallJobId

The job ID of the install job in progress.

inProgressInstallJobStartedDateTime

The time when the currently running install (if any) started.

lastCompletedDownloadJobDateTime

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

lastCompletedDownloadJobId

JobId of the last ran download job.(Can be success/cancelled/failed)

lastCompletedInstallJobDateTime

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

lastCompletedInstallJobId

JobId of the last ran install job.(Can be success/cancelled/failed)

lastCompletedScanJobDateTime

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

lastDownloadJobStatus

JobStatus of the last ran download job.

lastInstallJobStatus

JobStatus of the last ran install job.

lastSuccessfulInstallJobDateTime

The time when the Last Install job was completed successfully on the appliance

lastSuccessfulScanJobTime

Time when the last scan job is successfully completed.

ongoingUpdateOperation

The current update operation.

rebootBehavior

Indicates if updates are available and at least one of the updates needs a reboot.

totalNumberOfUpdatesAvailable

The number of updates available for the current device version as per the last device scan.

totalNumberOfUpdatesPendingDownload

The total number of items pending download.

totalNumberOfUpdatesPendingInstall

The total number of items pending install.

totalTimeInMinutes

The total time in Minutes

totalUpdateSizeInBytes

The total size of updates available for download in bytes.

updates

The list of updates available for install.

updateTitles

The list of updates available for install.

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

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.

inProgressDownloadJobId?: string

Property Value

string

inProgressDownloadJobStartedDateTime

The time when the currently running download (if any) started.

inProgressDownloadJobStartedDateTime?: Date

Property Value

Date

inProgressInstallJobId

The job ID of the install job in progress.

inProgressInstallJobId?: string

Property Value

string

inProgressInstallJobStartedDateTime

The time when the currently running install (if any) started.

inProgressInstallJobStartedDateTime?: Date

Property Value

Date

lastCompletedDownloadJobDateTime

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

lastCompletedDownloadJobDateTime?: Date

Property Value

Date

lastCompletedDownloadJobId

JobId of the last ran download job.(Can be success/cancelled/failed)

lastCompletedDownloadJobId?: string

Property Value

string

lastCompletedInstallJobDateTime

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

lastCompletedInstallJobDateTime?: Date

Property Value

Date

lastCompletedInstallJobId

JobId of the last ran install job.(Can be success/cancelled/failed)

lastCompletedInstallJobId?: string

Property Value

string

lastCompletedScanJobDateTime

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

lastCompletedScanJobDateTime?: Date

Property Value

Date

lastDownloadJobStatus

JobStatus of the last ran download job.

lastDownloadJobStatus?: string

Property Value

string

lastInstallJobStatus

JobStatus of the last ran install job.

lastInstallJobStatus?: string

Property Value

string

lastSuccessfulInstallJobDateTime

The time when the Last Install job was completed successfully on the appliance

lastSuccessfulInstallJobDateTime?: Date

Property Value

Date

lastSuccessfulScanJobTime

Time when the last scan job is successfully completed.

lastSuccessfulScanJobTime?: Date

Property Value

Date

ongoingUpdateOperation

The current update operation.

ongoingUpdateOperation?: string

Property Value

string

rebootBehavior

Indicates if updates are available and at least one of the updates needs a reboot.

rebootBehavior?: string

Property Value

string

totalNumberOfUpdatesAvailable

The number of updates available for the current device version as per the last device scan.

totalNumberOfUpdatesAvailable?: number

Property Value

number

totalNumberOfUpdatesPendingDownload

The total number of items pending download.

totalNumberOfUpdatesPendingDownload?: number

Property Value

number

totalNumberOfUpdatesPendingInstall

The total number of items pending install.

totalNumberOfUpdatesPendingInstall?: number

Property Value

number

totalTimeInMinutes

The total time in Minutes

totalTimeInMinutes?: number

Property Value

number

totalUpdateSizeInBytes

The total size of updates available for download in bytes.

totalUpdateSizeInBytes?: number

Property Value

number

updates

The list of updates available for install.

updates?: UpdateDetails[]

Property Value

updateTitles

The list of updates available for install.

updateTitles?: 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

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