VirtualMachineInstallPatchesResult interface
The result summary of an installation operation.
Properties
| error | The errors that were encountered during execution of the operation. The details array contains the list of them. |
| excluded |
The number of patches that were not installed due to the user blocking their installation. |
| failed |
The number of patches that could not be installed due to some issue. See errors for details. |
| installation |
The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs. |
| installed |
The number of patches successfully installed. |
| maintenance |
Whether the operation ran out of time before it completed all its intended actions. |
| not |
The number of patches that were detected as available for install, but did not meet the operation's criteria. |
| patches | The patches that were installed during the operation. |
| pending |
The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true. |
| reboot |
The reboot state of the VM following completion of the operation. |
| 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 "Failed", "Succeeded", "Unknown" or "CompletedWithWarnings." |
Property Details
error
The errors that were encountered during execution of the operation. The details array contains the list of them.
error?: ApiErrorProperty Value
excludedPatchCount
The number of patches that were not installed due to the user blocking their installation.
excludedPatchCount?: numberProperty Value
number
failedPatchCount
The number of patches that could not be installed due to some issue. See errors for details.
failedPatchCount?: numberProperty Value
number
installationActivityId
The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs.
installationActivityId?: stringProperty Value
string
installedPatchCount
The number of patches successfully installed.
installedPatchCount?: numberProperty Value
number
maintenanceWindowExceeded
Whether the operation ran out of time before it completed all its intended actions.
maintenanceWindowExceeded?: booleanProperty Value
boolean
notSelectedPatchCount
The number of patches that were detected as available for install, but did not meet the operation's criteria.
notSelectedPatchCount?: numberProperty Value
number
patches
The patches that were installed during the operation.
patches?: PatchInstallationDetail[]Property Value
pendingPatchCount
The number of patches that were identified as meeting the installation criteria, but were not able to be installed. Typically this happens when maintenanceWindowExceeded == true.
pendingPatchCount?: numberProperty Value
number
rebootStatus
The reboot state of the VM following completion of the operation.
rebootStatus?: stringProperty Value
string
startDateTime
The UTC timestamp when the operation began.
startDateTime?: DateProperty 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 "Failed", "Succeeded", "Unknown" or "CompletedWithWarnings."
status?: stringProperty Value
string