Skip to content

Commit 8f691d6

Browse files
Merge pull request #2520 from will-patton-microsoft/patch-1
Revise Windows.Management.Update documentation
2 parents 6e64584 + 43371db commit 8f691d6

1 file changed

Lines changed: 37 additions & 3 deletions

File tree

windows.management.update/windows_management_update.md

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,35 @@ namespace Windows.Management.Update
1010
# Windows.Management.Update
1111

1212
## -description
13-
The types in this namespace allow users to opt in or out of receiving Windows Insider Preview builds on their device. The APIs are intended to be used by IoT original equipment manufacturers (OEMs).
13+
The Windows.Management.Update namespace provides APIs for managing Windows Update operations across Windows devices. It serves two distinct purposes:
1414

15-
## -remarks
15+
* **General update management:** Use classes such as [WindowsUpdateManager](./windowsupdatemanager.md), [WindowsUpdateAdministrator](./windowsupdateadministrator), and [WindowsUpdate](./windowsupdate.md) to discover, download, install, and monitor updates on Windows desktop, Server, and IoT devices - covering both Preview and non-Preview builds.
16+
* **IoT Insider Preview enablement:** Use [PreviewBuildsManager](./previewbuildsmanager.md) and [PreviewBuildsState](./previewbuildsstate.md) to opt IoT devices into Windows Insider Preview builds and retrieve registration state. It's expected that the OEM of the device will create a settings page within the [Windows Device Portal](https://learn.microsoft.com/windows/iot-core/manage-your-device/deviceportal) for device configuration properties.
17+
18+
These API groups coexist in the same namespace but target different scenarios. Choose the correct set based on your device type and update requirements.
19+
20+
## -choosing the right API
21+
Use this guide to select the correct classes:
1622

17-
These APIs allow an IoT device to receive Windows Insider Preview builds. It's expected that the OEM of the device will create a settings page within the [Windows Device Portal](/windows/iot-core/manage-your-device/deviceportal) for device configuration properties. At a high level, information from [PreviewBuildsState](./previewbuildsstate.md) will be read by the device, then displayed to the user, and then used to register the user's account to the device. After registration, all settings management will be done online through the Windows Insider Program instead of on the device itself.
23+
* **Discover and install updates on desktop/Server/IoT**[WindowsUpdateManager](./windowsupdatemanager.md) + [WindowsUpdate](./windowsupdate.md)
24+
* **Apply administrative visibility or policy**[WindowsUpdateAdministrator](./windowsupdateadministrator)
25+
* **Monitor update progress without polling** → Subscribe to [WindowsUpdateManager](./windowsupdatemanager.md) events
26+
* **Enable Insider Preview on an IoT device**[PreviewBuildsManager](./previewbuildsmanager.md) + [PreviewBuildsState](./previewbuildsstate.md)
1827

1928
## -examples
2029

30+
This C# example queries for applicable updates and starts installation.
31+
32+
```csharp
33+
var updateManager = WindowsUpdateManager.GetDefault();
34+
var updates = await updateManager.GetApplicableUpdatesAsync();
35+
foreach (var update in updates)
36+
{
37+
Console.WriteLine($"Found update: {update.Title}");
38+
}
39+
await updateManager.StartInstallAsync(updates);
40+
```
41+
2142
This C# example demonstrates how a user can determine whether their device is receiving preview builds, or whether there are problems preventing the device from getting preview builds.
2243

2344
```csharp
@@ -35,5 +56,18 @@ public string GetErrorMessage()
3556
return String.Empty;
3657
}
3758
```
59+
## -remarks
60+
61+
* Use [WindowsUpdateManager](./windowsupdatemanager.md), [WindowsUpdate](./windowsupdate.md), and [WindowsUpdateAdministrator](./windowsupdateadministrator) for general update management on all supported platforms.
62+
* [PreviewBuildsManager](./previewbuildsmanager.md) and [PreviewBuildsState](./previewbuildsstate.md) are **IoT specific** and do not manage general updates on desktop or Server. It's expected that the OEM of the device will create a settings page within the [Windows Device Portal](/windows/iot-core/manage-your-device/deviceportal) for device configuration properties. Information from [PreviewBuildsState](./previewbuildsstate.md) will be read by the device, then displayed to the user, and then used to register the user's account to the device. After registration, all settings management will be done online through the Windows Insider Program instead of on the device itself.
63+
* Platform availability and API contracts are documented in individual class reference pages.
64+
65+
| API Set | Supported Windows Build |
66+
| --------------------------- | :-------------: |
67+
| Preview Builds | 17134 or greater |
68+
| Windows Update Manager | 22621 or greater |
69+
| Windows Update Administrator | 22621 or greater |
70+
| Windows Software Update | 26100 or greater |
3871

3972
## -see-also
73+

0 commit comments

Comments
 (0)