VirtualMachineAssessPatchesResult interface

Describes the properties of an AssessPatches result.

Properties

assessmentActivityId

The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. NOTE: This property will not be serialized. It can only be populated by the server.

availablePatches

The list of patches that have been detected as available for installation. NOTE: This property will not be serialized. It can only be populated by the server.

criticalAndSecurityPatchCount

The number of critical or security patches that have been detected as available and not yet installed. NOTE: This property will not be serialized. It can only be populated by the server.

error

The errors that were encountered during execution of the operation. The details array contains the list of them. NOTE: This property will not be serialized. It can only be populated by the server.

otherPatchCount

The number of all available patches excluding critical and security. NOTE: This property will not be serialized. It can only be populated by the server.

rebootPending

The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. NOTE: This property will not be serialized. It can only be populated by the server.

startDateTime

The UTC timestamp when the operation began. NOTE: This property will not be serialized. It can only be populated by the server.

status

The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

assessmentActivityId

The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. NOTE: This property will not be serialized. It can only be populated by the server.

assessmentActivityId?: string

Property Value

string

availablePatches

The list of patches that have been detected as available for installation. NOTE: This property will not be serialized. It can only be populated by the server.

availablePatches?: VirtualMachineSoftwarePatchProperties[]

Property Value

criticalAndSecurityPatchCount

The number of critical or security patches that have been detected as available and not yet installed. NOTE: This property will not be serialized. It can only be populated by the server.

criticalAndSecurityPatchCount?: number

Property Value

number

error

The errors that were encountered during execution of the operation. The details array contains the list of them. NOTE: This property will not be serialized. It can only be populated by the server.

error?: ApiError

Property Value

otherPatchCount

The number of all available patches excluding critical and security. NOTE: This property will not be serialized. It can only be populated by the server.

otherPatchCount?: number

Property Value

number

rebootPending

The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred. NOTE: This property will not be serialized. It can only be populated by the server.

rebootPending?: boolean

Property Value

boolean

startDateTime

The UTC timestamp when the operation began. NOTE: This property will not be serialized. It can only be populated by the server.

startDateTime?: Date

Property Value

Date

status

The overall success or failure status of the operation. It remains "InProgress" until the operation completes. At that point it will become "Unknown", "Failed", "Succeeded", or "CompletedWithWarnings." NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string