Package version:

InterfaceMachineInstallPatchesResult

The result summary of an installation operation.

interface MachineInstallPatchesResult {
    errorDetails?: ErrorDetail;
    excludedPatchCount?: number;
    failedPatchCount?: number;
    installationActivityId?: string;
    installedPatchCount?: number;
    lastModifiedDateTime?: Date;
    maintenanceWindowExceeded?: boolean;
    notSelectedPatchCount?: number;
    osType?: string;
    patchServiceUsed?: string;
    pendingPatchCount?: number;
    rebootStatus?: string;
    startDateTime?: Date;
    startedBy?: string;
    status?: string;
}

Properties

errorDetails? excludedPatchCount? failedPatchCount? installationActivityId? installedPatchCount? lastModifiedDateTime? maintenanceWindowExceeded? notSelectedPatchCount? osType? patchServiceUsed? pendingPatchCount? rebootStatus? startDateTime? startedBy? status?

Properties

Optional ReadonlyerrorDetails

errorDetails?: ErrorDetail

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.

Optional ReadonlyexcludedPatchCount

excludedPatchCount?: number

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.

Optional ReadonlyfailedPatchCount

failedPatchCount?: number

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.

Optional ReadonlyinstallationActivityId

installationActivityId?: string

The activity ID of the operation that produced this result. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlyinstalledPatchCount

installedPatchCount?: number

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

Optional ReadonlylastModifiedDateTime

lastModifiedDateTime?: Date

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

Optional ReadonlymaintenanceWindowExceeded

maintenanceWindowExceeded?: boolean

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.

Optional ReadonlynotSelectedPatchCount

notSelectedPatchCount?: number

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.

Optional ReadonlyosType

osType?: string

The operating system type of the machine. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlypatchServiceUsed

patchServiceUsed?: string

Specifies the patch service used for the operation. NOTE: This property will not be serialized. It can only be populated by the server.

Optional ReadonlypendingPatchCount

pendingPatchCount?: number

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.

Optional ReadonlyrebootStatus

rebootStatus?: string

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.

Optional ReadonlystartDateTime

startDateTime?: Date

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

Optional ReadonlystartedBy

startedBy?: string

Indicates if operation was triggered by user or by platform. NOTE: This property will not be serialized. It can only be populated by the server.

Optional Readonlystatus

status?: string

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.

Settings

Member Visibility