Windows.Management.Update 命名空间

Windows.Management.Update 命名空间提供用于跨 Windows 设备管理 Windows 更新作的 API。 它提供多种不同的用途:

这些 API 组共存在同一命名空间中,但面向不同的方案。 根据设备类型和更新要求选择正确的集。

类

名称 说明
PreviewBuildsManager

管理设备的预览版本状态。

PreviewBuildsState

包含用于连接设备以将设备与Windows 预览体验计划关联的信息。

WindowsSoftwareUpdate

表示提供程序向 Windows 更新 Orchestrator 报告的单个软件更新,包括其标识、版本、大小、应用它所需的操作以及其当前状态。

WindowsSoftwareUpdateActionInfo

描述提供程序如何通过指定要调用的文件、其参数和操作类型来执行单个更新操作。

WindowsSoftwareUpdateActionProgress

描述当前正在 WindowsSoftwareUpdate 上执行的操作的进度。

WindowsSoftwareUpdateActionResultInfo

描述 WindowsSoftwareUpdate 最近完成的操作的结果。

WindowsSoftwareUpdateAppPackageInfo

介绍 AppPackageWindowsSoftwareUpdate 安装的 MSIX/AppX 应用程序包。

WindowsSoftwareUpdateApprovalInfo

描述 批准 WindowsSoftwareUpdate 继续的条件。

WindowsSoftwareUpdateExecutionInfo

描述提供程序运行以应用可执行文件或 PowerShell WindowsSoftwareUpdate 的操作集。

WindowsSoftwareUpdateIdentity

标识 WindowsSoftwareUpdate 所面向的已安装产品(通过 MSI 代码示例或 MSIX 程序包系列名称)。

WindowsSoftwareUpdateLocalizationInfo

提供特定语言中 WindowsSoftwareUpdate 的本地化标题、说明和详细信息 URL。

WindowsSoftwareUpdateOptionalActionInfo

介绍 WindowsSoftwareUpdate 的可选“close-and-deploy”、“close-and-install”和“close-and-restart”操作变体,即必须先关闭目标应用程序时运行的操作。

WindowsSoftwareUpdateOptionalInfo

携带 WindowsSoftwareUpdate 的可选元数据,包括其类别、本地化内容和符合性计时。

WindowsSoftwareUpdateProvider

表示磁盘上的Windows软件更新提供程序包,并提供向 Windows 更新 Orchestrator 验证、注册和注销它的操作。

WindowsSoftwareUpdateProviderActionResult

描述提供程序报告软件更新操作的结果,包括结果、任何必需的重启和错误信息。

WindowsSoftwareUpdateProviderPayloadFileInfo

描述属于 WindowsSoftwareUpdateProvider 的单个有效负载文件,包括其哈希和代码签名信任状态。

WindowsSoftwareUpdateProviderStatus

提供程序用于将结果报告回Windows 更新 Orchestrator 的通道:扫描结果、操作进度和操作结果。 它还会在业务流程协调程序请求取消时通知提供程序。

WindowsSoftwareUpdateResult

表示软件更新操作的结果,例如提交扫描结果、报告进度或报告操作结果。

WindowsSoftwareUpdateScanResult

表示软件更新扫描的结果,包括是否成功以及发现的 WindowsSoftwareUpdate 对象。

WindowsSoftwareUpdateVersion

表示 WindowsSoftwareUpdate 的四部分版本号(主版本号、次要版本号、修订版主版本号和修订版次要版本号)。

WindowsUpdate

WindowsUpdate 是一个属性包,描述单个挂起或正在进行的更新 — 其标识和元数据、分类标志、End-User 许可协议(EULA)状态、截止时间以及当前对其执行的操作的进度和结果。

WindowsUpdateActionCompletedEventArgs

相应 WindowsUpdateManager.ActionCompleted 事件的事件数据。

WindowsUpdateActionProgress

由 WindowsUpdate 和 WindowsUpdateProgressChangedEventArgs 的 ActionProgress 属性返回。

WindowsUpdateActionResult

由 WindowsUpdate.ActionResult 属性返回。

WindowsUpdateAdministrator

使注册的管理员能够控制设备上的Windows 更新活动 — 在显式批准后对扫描、更新和更新操作进行限制,以及请求或取消重启。

WindowsUpdateApprovalData

允许在通过 ApprovWindowsUpdate 批准更新时配置其他元数据。

WindowsUpdateAttentionRequiredInfo

表示 WindowsUpdateAttentionRequiredReason 和时间戳的元组。

WindowsUpdateAttentionRequiredReasonChangedEventArgs

相应 WindowsUpdateManager.AttentionRequiredReasonChanged 事件的事件数据。

WindowsUpdateGetAdministratorResult

表示调用 GetRegisteredAdministrator 的结果。

WindowsUpdateItem

表示有关以前完成的更新的属性包。

WindowsUpdateManager

提供设备上的更新活动的统一视图。 使用 WindowsUpdateManager 启动扫描、枚举应用于设备的更新、查看最近完成的更新,以及通过事件监视扫描、工作和进度活动 ,而无需轮询。

从 Windows 软件更新提供程序平台开始,WindowsUpdateManager 还会枚举已注册的软件更新提供程序并执行软件更新扫描。

WindowsUpdateManagerScanOptions

Windows.Management.Update 命名空间提供用于跨 Windows 设备管理 Windows 更新作的 API。 它提供多种不同的用途:

这些 API 组共存在同一命名空间中,但面向不同的方案。 根据设备类型和更新要求选择正确的集。

WindowsUpdateProgressChangedEventArgs

相应 WindowsUpdateManager.ProgressChanged 事件的事件数据。

WindowsUpdateRestartRequestOptions

表示可以配置的字段的属性包,然后传递给 RequestRestart。

WindowsUpdateScanCompletedEventArgs

相应 WindowsUpdateManager.ScanCompleted 事件的事件数据。

枚举

名称 说明
WindowsSoftwareUpdateActionResult

定义常量,该常量指定提供程序通过 WindowsSoftwareUpdateProviderActionResult 报告的软件更新操作的结果。

WindowsSoftwareUpdateActionType

定义常量,该常量指定提供程序在其生命周期内移动 WindowsSoftwareUpdate 所执行的操作。

WindowsSoftwareUpdateArchitecture

定义指定 WindowsSoftwareUpdateAppPackageInfo 适用的处理器体系结构的常量。

WindowsSoftwareUpdateCategory

定义按它提供的有效负载类型对 WindowsSoftwareUpdate 进行分类的常量。

WindowsSoftwareUpdateIdentityType

定义常量,该常量指定如何标识 WindowsSoftwareUpdateIdentity 的目标产品。

WindowsSoftwareUpdateInstallationType

定义用于指定如何在设备上安装 WindowsSoftwareUpdate 的常量。

WindowsSoftwareUpdateProviderRegistrationType

定义指定 WindowsSoftwareUpdateProvider 的注册状态的常量。

WindowsSoftwareUpdateProviderTrustState

定义指定 WindowsSoftwareUpdateProvider 或其有效负载文件之一的代码签名信任状态的常量。

WindowsSoftwareUpdateProviderType

定义指定如何调用已注册的 WindowsSoftwareUpdateProvider 来执行扫描和更新操作的常量。

WindowsSoftwareUpdateRestartReason

定义一个常量,该常量指定完成软件更新操作需要重启的原因。

WindowsUpdateAdministratorOptions

定义常量,该常量指定调用方在注册 到 RegisterForAdministration 时想要控制的管理员选项。

WindowsUpdateAdministratorStatus

定义指定状态代码的常量,以指示Windows更新管理员的注册/注销是否成功。

WindowsUpdateAttentionRequiredReason

定义常量,该常量指定更新在继续之前需要注意的原因。

WindowsUpdateManagerScanMode

定义常量,用于指定调用 WindowsUpdateManager.PerformScan 时如何执行软件更新扫描。

示例

扫描并枚举适用的更新

此 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; 
} 

注解

API 集 支持的Windows生成
预览版本 17134 或更高版本
Windows 更新管理器 22621 或更高版本
Windows 更新管理员 22621 或更高版本
Windows软件更新 26100 或更高版本

另请参阅