A single Windows update that the endpoint has identified as applicable but not yet installed. Includes the update's identity, security classification, size, and current download state so consumers can prioritize and report on it.
Fields
| Field Name | Description |
|---|---|
title - String!
|
The display title of the update as shown to the user. |
description - String!
|
The long-form description of the update, including what it changes. |
updateId - String!
|
A stable identifier for this update across revisions. Together with revisionNumber it identifies an exact published revision of the update. |
revisionNumber - Int!
|
Revision number for this update. Microsoft re-releases an update under the same updateId with an incremented revision when it republishes the package. |
kbArticleIds - [String!]!
|
Knowledge Base article IDs for this update, without the KB prefix (for example "5094126"). An update may be associated with more than one KB article, or with none. |
securityBulletinIds - [String!]!
|
Microsoft Security Response Center bulletin IDs associated with this update (for example "MS17-010"). Empty for non-security updates. |
msrcSeverity - WindowsUpdateMsrcSeverity
|
The MSRC severity rating for this update, or null for non-security updates. See WindowsUpdateMsrcSeverity. |
autoSelectOnWebSites - Boolean!
|
Whether the endpoint would normally select this update automatically. true indicates an "important" update that Windows would offer by default; false indicates an optional / recommended update that requires explicit user opt-in. |
isMandatory - Boolean!
|
Whether the endpoint treats this update as mandatory. When true, the user is not permitted to decline or hide the update; it will be installed regardless of user preference. |
isBeta - Boolean!
|
Whether this is a preview / pre-release update. true for updates published as part of an Insider or beta channel; these typically should not be expected on production endpoints. |
isHidden - Boolean!
|
Whether a user on the endpoint has explicitly hidden this update so that Windows no longer offers to install it. A hidden update is still "pending" — it has not been installed — but the endpoint has been told to stop nagging about it. |
isDownloaded - Boolean!
|
Whether the update payload has already been downloaded to the endpoint and is ready to install on the next reboot or install pass. true means only an install step (and possibly a reboot) is needed. |
isUninstallable - Boolean!
|
Whether the update can be removed by an administrator after it has been installed. false means the change becomes permanent on the endpoint once applied. |
minDownloadSize - Uint64!
|
The minimum number of bytes the endpoint will need to transfer to install this update. Always populated; useful for forecasting bandwidth on remote endpoints. |
maxDownloadSize - Uint64
|
The worst-case number of bytes the endpoint may need to transfer to install this update. null when the size is not known in advance (Windows does not always publish this value). |
supportUrl - String
|
The vendor-provided support URL for this update, if any. |
moreInfoUrls - [String!]!
|
Additional reference URLs published alongside the update. |
lastDeploymentChangeTime - Time
|
The last time the update's deployment metadata changed. Microsoft updates this timestamp when an update is re-released or its applicability rules are updated; a recent change here can explain why an update has suddenly become applicable. |
updateKind - WindowsUpdateKind!
|
What kind of update this is — for example a software patch versus a device driver update. See WindowsUpdateKind. |
deploymentAction - WindowsDeploymentAction!
|
What action the endpoint intends to perform for this update — for example install, optional install, or evaluate-only. See WindowsDeploymentAction. |
Used by
SoftwareUpdatePreferencesWindowstype: Windows-specific software update preferences and the list of updates the endpoint has discovered but has not yet installed.
Example
Example
{
"title": "abc123",
"description": "xyz789",
"updateId": "abc123",
"revisionNumber": 123,
"kbArticleIds": ["xyz789"],
"securityBulletinIds": ["xyz789"],
"msrcSeverity": "CRITICAL",
"autoSelectOnWebSites": true,
"isMandatory": true,
"isBeta": false,
"isHidden": false,
"isDownloaded": false,
"isUninstallable": true,
"minDownloadSize": "8589934592",
"maxDownloadSize": "8589934592",
"supportUrl": "xyz789",
"moreInfoUrls": ["xyz789"],
"lastDeploymentChangeTime": "2021-10-07T18:23:25.829Z",
"updateKind": "SOFTWARE",
"deploymentAction": "NONE"
}