Windows.Management.Update 命名空间
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
Windows.Management.Update 命名空间提供用于跨 Windows 设备管理 Windows 更新作的 API。 它提供多种不同的用途:
- 常规更新管理:使用 WindowsUpdateManager、WindowsUpdateAdministrator 和 WindowsUpdate 等类发现、下载、安装和监视Windows桌面、服务器和 IoT 设备上的更新,涵盖预览版和非预览版版本。
- Windows软件更新提供程序平台:使用 WindowsSoftwareUpdateProvider、WindowsSoftwareUpdate、WindowsSoftwareUpdateProviderStatus 和 WindowsUpdateManager 的软件更新成员,为与 Windows 更新 Orchestrator 集成的应用创作和托管更新提供程序。 提供程序在扫描期间发现特定软件的更新,然后在业务流程协调程序计划这些软件时执行操作(下载、安装、部署、重启),并重用与Windows 更新相同的计划、重新启动协调和策略。
- IoT Insider Preview 启用:使用 PreviewBuildsManager 和 PreviewBuildsState 选择 IoT 设备进入Windows Insider Preview 版本并检索注册状态。 预计设备的 OEM 将在设备配置属性的 Windows Device Portal 中创建设置页。
这些 API 组共存在同一命名空间中,但面向不同的方案。 根据设备类型和更新要求选择正确的集。
类
枚举
示例
扫描并枚举适用的更新
此 C# 示例创建 WindowsUpdateManager,启动扫描,并在扫描完成后枚举适用的更新。
using System;
using Windows.Management.Update;
var updateManager = new WindowsUpdateManager("MyClientId");
updateManager.ScanCompleted += (manager, args) =>
{
foreach (WindowsUpdate update in manager.GetApplicableUpdates())
{
Console.WriteLine($"Applicable update: {update.Title}");
}
};
// Scan as if the user selected "Check for updates".
updateManager.StartScan(userInitiated: true);
创作软件更新提供程序
借助 Windows 软件更新提供程序平台,可以将自定义更新源插入 Windows 更新 Orchestrator。 每次操作在 SYSTEM 上下文中调用一次提供程序: 在扫描 期间,它会生成 WindowsSoftwareUpdate 对象并提交它们;在 操作 期间,它通过 WindowsSoftwareUpdateProviderStatus 报告进度和最终结果。
以下代码片段显示了 C#、C++/WinRT 和 PowerShell 中的核心流。 完整、可构建的提供程序示例(包括 provider.json 清单、代码签名和注册步骤)在 microsoft/windows-uop 存储库中发布。
C#
using System.Collections.Generic;
using Windows.Management.Update;
// Scan: report the updates this provider offers.
void PerformScan(string providerId, IEnumerable<WindowsSoftwareUpdate> updates)
{
var status = new WindowsSoftwareUpdateProviderStatus(providerId);
WindowsSoftwareUpdateResult result = status.SetScanResult(true, 0, 0, updates);
}
// Action: report progress, then the final result.
void PerformAction(string providerId)
{
var status = new WindowsSoftwareUpdateProviderStatus(providerId);
for (ulong i = 0; i <= 100; i += 10)
{
status.SetActionProgress(i, 100);
}
var actionResult = new WindowsSoftwareUpdateProviderActionResult(
WindowsSoftwareUpdateActionResult.Succeeded,
WindowsSoftwareUpdateRestartReason.None,
resultCode: 0,
extendedError: 0);
status.SetActionResult(actionResult);
}
C++/WinRT
#include <winrt/Windows.Management.Update.h>
#include <winrt/Windows.Foundation.Collections.h>
using namespace winrt::Windows::Management::Update;
using namespace winrt::Windows::Foundation::Collections;
// Scan: report the updates this provider offers.
void PerformScan(winrt::hstring const& providerId, IVector<WindowsSoftwareUpdate> const& updates)
{
WindowsSoftwareUpdateProviderStatus status{ providerId };
auto result = status.SetScanResult(true, S_OK, 0, updates);
}
// Action: report progress, then the final result.
void PerformAction(winrt::hstring const& providerId)
{
WindowsSoftwareUpdateProviderStatus status{ providerId };
for (uint64_t i = 0; i <= 100; i += 10)
{
status.SetActionProgress(i, 100);
}
WindowsSoftwareUpdateProviderActionResult actionResult{
WindowsSoftwareUpdateActionResult::Succeeded,
WindowsSoftwareUpdateRestartReason::None,
0, // resultCode
0 }; // extendedError
status.SetActionResult(actionResult);
}
PowerShell
# Scan: report the updates this provider offers.
$providerStatus = [Windows.Management.Update.WindowsSoftwareUpdateProviderStatus]::new($ProviderId)
$statusResult = $providerStatus.SetScanResult($true, 0, 0, $UpdateCollection)
# Action: report progress, then the final result.
$providerStatus = [Windows.Management.Update.WindowsSoftwareUpdateProviderStatus]::new($ProviderId)
for ($i = 0; $i -le 100; $i += 10) {
[void]$providerStatus.SetActionProgress($i, 100)
}
$actionResult = [Windows.Management.Update.WindowsSoftwareUpdateProviderActionResult]::new(
[Windows.Management.Update.WindowsSoftwareUpdateActionResult]::Succeeded,
[Windows.Management.Update.WindowsSoftwareUpdateRestartReason]::None,
0, # resultCode
0) # extendedError
[void]$providerStatus.SetActionResult($actionResult)
确定 Insider Preview 生成状态(IoT)
此 C# 示例演示了用户如何确定其设备是否正在接收预览版本,或者是否存在阻止设备获取预览版本的问题。
public string GetErrorMessage()
{
PreviewBuildsManager manager = PreviewBuildsManager.GetDefault();
if (manager != null)
{
PreviewBuildsState state = manager.GetCurrentState();
if (state.Properties.ContainsKey("ErrorMessage"))
{
return state.Properties["ErrorMessage"].ToString();
}
}
return String.Empty;
}
注解
- 在所有受支持的平台上使用 WindowsUpdateManager、 WindowsUpdate 和 WindowsUpdateAdministrator 进行常规更新管理。
- 使用 WindowsSoftwareUpdateProvider、WindowsSoftwareUpdateProviderStatus、WindowsSoftwareUpdate 和 WindowsUpdateManager 的软件更新成员创作和托管应用的更新提供程序(Windows 更新业务流程平台)。 有关提供程序创作、载入、签名和注册指南以及完整的 C#、C++ 和 PowerShell 示例,请参阅 microsoft/windows-uop 存储库。
- PreviewBuildsManager 和 PreviewBuildsState 特定于 IoT ,不管理桌面或服务器上的常规更新。 预计设备的 OEM 将在设备配置属性的 Windows Device Portal 中创建设置页。 预览版BuildsState 中的信息将由设备读取,然后向用户显示,然后用于将用户帐户注册到设备。 注册后,所有设置管理将通过Windows 预览体验计划而不是设备本身联机完成。
- 平台可用性和 API 协定记录在各个类引用页中。
| API 集 | 支持的Windows生成 |
|---|---|
| 预览版本 | 17134 或更高版本 |
| Windows 更新管理器 | 22621 或更高版本 |
| Windows 更新管理员 | 22621 或更高版本 |
| Windows软件更新 | 26100 或更高版本 |