VirtualMachineAssessPatchesResult interface
Describes the properties of an AssessPatches result.
Properties
| assessment |
The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. |
| available |
The list of patches that have been detected as available for installation. |
| critical |
The number of critical or security patches that have been detected as available and not yet installed. |
| error | The errors that were encountered during execution of the operation. The details array contains the list of them. |
| other |
The number of all available patches excluding critical and security. |
| reboot |
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. |
| start |
The UTC timestamp when the operation began. |
| 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." |
Property Details
assessmentActivityId
The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
assessmentActivityId?: string
Property Value
string
availablePatches
The list of patches that have been detected as available for installation.
availablePatches?: VirtualMachineSoftwarePatchProperties[]
Property Value
criticalAndSecurityPatchCount
The number of critical or security patches that have been detected as available and not yet installed.
criticalAndSecurityPatchCount?: number
Property Value
number
error
The errors that were encountered during execution of the operation. The details array contains the list of them.
error?: ApiError
Property Value
otherPatchCount
The number of all available patches excluding critical and security.
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.
rebootPending?: boolean
Property Value
boolean
startDateTime
The UTC timestamp when the operation began.
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."
status?: string
Property Value
string