VirtualMachineInstallPatchesResult interface

Package:

@azure/arm-compute

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. NOTE: This property will not be serialized. It can only be populated by the server.
excludedPatchCount	The number of patches that were not installed due to the user blocking their installation. NOTE: This property will not be serialized. It can only be populated by the server.
failedPatchCount	The number of patches that could not be installed due to some issue. See errors for details. NOTE: This property will not be serialized. It can only be populated by the server.
installationActivityId	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.
installedPatchCount	The number of patches successfully installed. NOTE: This property will not be serialized. It can only be populated by the server.
maintenanceWindowExceeded	Whether the operation ran out of time before it completed all its intended actions. NOTE: This property will not be serialized. It can only be populated by the server.
notSelectedPatchCount	The number of patches that were detected as available for install, but did not meet the operation's criteria. NOTE: This property will not be serialized. It can only be populated by the server.
patches	The patches that were installed during the operation. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
rebootStatus	The reboot state of the VM following completion of the operation. 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 "Failed", "Succeeded", "Unknown" or "CompletedWithWarnings." NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

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

ApiError

excludedPatchCount

The number of patches that were not installed due to the user blocking their installation. NOTE: This property will not be serialized. It can only be populated by the server.

excludedPatchCount?: number

Property Value

number

failedPatchCount

The number of patches that could not be installed due to some issue. See errors for details. NOTE: This property will not be serialized. It can only be populated by the server.

failedPatchCount?: number

Property Value

number

installationActivityId

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.

installationActivityId?: string

Property Value

string

installedPatchCount

The number of patches successfully installed. NOTE: This property will not be serialized. It can only be populated by the server.

installedPatchCount?: number

Property Value

number

maintenanceWindowExceeded

Whether the operation ran out of time before it completed all its intended actions. NOTE: This property will not be serialized. It can only be populated by the server.

maintenanceWindowExceeded?: boolean

Property Value

boolean

notSelectedPatchCount

The number of patches that were detected as available for install, but did not meet the operation's criteria. NOTE: This property will not be serialized. It can only be populated by the server.

notSelectedPatchCount?: number

Property Value

number

patches

The patches that were installed during the operation. NOTE: This property will not be serialized. It can only be populated by the server.

patches?: PatchInstallationDetail[]

Property Value

PatchInstallationDetail[]

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. NOTE: This property will not be serialized. It can only be populated by the server.

pendingPatchCount?: number

Property Value

number

rebootStatus

The reboot state of the VM following completion of the operation. NOTE: This property will not be serialized. It can only be populated by the server.

rebootStatus?: string

Property Value

string

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 "Failed", "Succeeded", "Unknown" or "CompletedWithWarnings." NOTE: This property will not be serialized. It can only be populated by the server.

status?: string

Property Value

string