Update-Help
在计算机上下载和安装最新的帮助文件。
语法
Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[[-SourcePath] <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-LiteralPath <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]说明
该 Update-Help cmdlet 下载 PowerShell 模块的最新帮助文件，并将其安装在计算机上。 无需重启 PowerShell 才能使更改生效。 可以使用 Get-Help cmdlet 立即查看新的帮助文件。
Update-Help 检查计算机上的帮助文件的版本。 如果没有模块的帮助文件，或者帮助文件已过时，请 Update-Help 下载最新的帮助文件。 可以从 Internet 或文件共享下载并安装帮助文件。
如果没有参数，请 Update-Help 更新会话中模块的帮助文件，以及支持可更新帮助的所有已安装模块。 包括已安装但未在当前会话中加载的模块。 PowerShell 模块存储在环境变量中列出的 $env:PSModulePath 位置。
有关详细信息，请参阅 about_Updatable_Help。
可以使用 Module 参数更新特定模块的帮助文件。 使用 UICulture 参数下载多种语言和区域设置的帮助文件。
可以在未连接到 Internet 的计算机上使用 Update-Help 。 使用 Save-Help cmdlet 从 Internet 下载帮助文件，并将其保存在文件系统位置，例如共享文件夹或文件系统目录。 然后使用 SourcePath 参数 Update-Help 从文件系统位置下载更新的帮助文件，并将其安装在计算机上。
通过将 cmdlet 添加到 Update-Help PowerShell 配置文件，可以自动执行帮助更新。 默认情况下， Update-Help 每台计算机每天只运行一次。 若要重写每天一次的限制，请使用 Force 参数。
cmdlet Update-Help 在 Windows PowerShell 3.0 中引入。
重要
Update-Help 需要管理权限。
必须是计算机上的 Administrators 组的成员才能更新 PowerShell Core 模块的帮助文件。
若要下载或更新 PowerShell 安装目录中模块的帮助文件 ($PSHOME\Modules) （包括 PowerShell Core 模块），请使用“以管理员身份运行”选项启动 PowerShell。
例如：Start-Process powershell.exe -Verb RunAs。
还可以通过使用Windows PowerShell集成脚本环境 (ISE) “帮助”菜单中的“更新Windows PowerShell帮助”菜单项来更新帮助文件。
更新Windows PowerShell帮助项运行不带参数的 Update-Help cmdlet。
若要更新目录中模块$PSHOME的帮助，请使用“以管理员身份运行”选项启动Windows PowerShell ISE。
示例
示例 1：更新所有模块的帮助文件
该 Update-Help cmdlet 更新支持可更新帮助的已安装模块的帮助文件。 用户界面 (UI) 区域性语言在操作系统中设置。
Update-Help示例 2：更新指定模块的帮助文件
该 Update-Help cmdlet 仅更新以 Microsoft.PowerShell 开头的模块名称的帮助文件。
Update-Help -Module Microsoft.PowerShell*示例 3：更新不同语言的帮助文件
该 Update-Help cmdlet 更新所有模块的日语 (ja-JP) 和英语 (en-US) 帮助文件。
如果模块不提供指定 UI 区域性的帮助文件，则会显示模块和 UI 区域性的错误消息。 在此示例中，错误消息指示找不到模块 Microsoft.PowerShell.Utility 的 ja-JP 帮助文件。
Update-Help -UICulture ja-JP, en-US
Update-Help : Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with UI culture(s) {ja-JP}
No UI culture was found that matches the following pattern: ja-JP.示例 4：自动更新帮助文件
此示例创建计划作业，该作业每天凌晨 3：00 更新所有模块的帮助。
$jobParams = @{
Name = 'UpdateHelpJob'
Credential = 'Domain01\User01'
ScriptBlock = '{Update-Help}'
Trigger = (New-JobTrigger -Daily -At "3 AM")
}
Register-ScheduledJob @jobParams
Id Name JobTriggers Command Enabled
-- ---- ----------- ------- -------
1 UpdateHelpJob 1 Update-Help True该 Register-ScheduledJob cmdlet 创建运行命令的计划 Update-Help 作业。 该命令使用 Credential 参数通过计算机上的 Administrators 组成员的凭据运行 Update-Help 。 Trigger 参数的值是一个New-JobTrigger命令，用于创建作业触发器，该触发器每天凌晨 3：00 启动作业。
若要运行 Register-ScheduledJob 该命令，请使用 “以管理员身份运行 ”选项启动 PowerShell。 PowerShell 会提示输入 凭据 参数中指定的用户密码。 凭据随计划作业一起存储。 作业运行时不会提示你。
可以使用 Get-ScheduledJob cmdlet 查看计划作业、使用 Set-ScheduledJob cmdlet 更改作业，并使用 Unregister-ScheduledJob cmdlet 将其删除。 你还可以在以下路径中查看和管理任务计划程序内的计划作业：
Task Scheduler Library\Microsoft\Windows\PowerShell\ScheduledJobs.
示例 5：从文件共享更新多台计算机上的帮助文件
在此示例中，更新的帮助文件从 Internet 下载并保存在文件共享中。 需要具有访问文件共享和安装更新的权限的用户凭据。 使用文件共享时，可以更新防火墙后面的计算机或未连接到 Internet。
PS> Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
PS> Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}该 Save-Help 命令下载支持可更新帮助的所有模块的最新帮助文件。
DestinationPath 参数将文件保存在文件共享中\\Server01\Share\PSHelp。 Credential 参数指定有权访问文件共享的用户。
该 Invoke-Command cmdlet 在多台计算机上运行远程 Update-Help 命令。 ComputerName 参数从 Servers.txt 文件中获取远程计算机的列表。 ScriptBlock 参数运行Update-Help命令，并使用 SourcePath 参数指定包含更新帮助文件的文件共享。 Credential 参数指定可以访问文件共享并运行远程Update-Help命令的用户。
示例 6：获取更新的帮助文件列表
该 Update-Help cmdlet 更新指定模块的帮助。 该 cmdlet 使用 Verbose 通用参数显示已更新的帮助文件列表。 可以使用 Verbose 查看所有帮助文件的输出或特定模块的帮助文件。
如果没有 Verbose 参数， Update-Help 则不显示命令的结果。 详细参数输出可用于验证是否已更新帮助文件，或者是否安装了最新版本。
Update-Help -Module Microsoft.PowerShell.Utility -Verbose示例 7：查找支持可更新帮助的模块
此示例列出了支持可更新帮助的模块。 该命令使用模块的 HelpInfoUri 属性标识支持可更新帮助的模块。 HelpInfoUri 属性包含运行 cmdlet 时重定向的Update-Help地址。
Get-Module -ListAvailable | Where-Object -Property HelpInfoUri
Directory: C:\program files\powershell\6\Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Manifest 6.1.0.0 CimCmdlets Core {Get-CimAssociatedInstance... }
Manifest 1.2.2.0 Microsoft.PowerShell.Archive Desk {Compress-Archive... }
Manifest 6.1.0.0 Microsoft.PowerShell.Diagnostics Core {Get-WinEvent, New-WinEvent}
Directory: C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Manifest 2.0.1.0 Appx Core,Desk {Add-AppxPackage, ... }
Script 1.0.0.0 AssignedAccess Core,Desk {Clear-AssignedAccess, ... }
Manifest 1.0.0.0 BitLocker Core,Desk {Unlock-BitLocker, ... }示例 8：更新的帮助文件清单
在此示例中，脚本 Get-UpdateHelpVersion.ps1 会为每个模块及其版本号创建可更新帮助文件的清单。
该脚本使用模块的 HelpInfoUri 属性标识支持可更新帮助的模块。 对于支持可更新帮助的模块，脚本查找并分析帮助信息文件 (*helpinfo.xml) 查找最新的版本号。
该脚本使用 PSCustomObject 类和哈希表创建自定义输出对象。
# Get-UpdateHelpVersion.ps1
Param(
[parameter(Mandatory=$False)]
[String[]]
$Module
)
$HelpInfoNamespace = @{helpInfo='https://schemas.microsoft.com/powershell/help/2010/05'}
if ($Module) { $Modules = Get-Module $Module -ListAvailable | where {$_.HelpInfoUri} }
else { $Modules = Get-Module -ListAvailable | where {$_.HelpInfoUri} }
foreach ($mModule in $Modules)
{
$mDir = $mModule.ModuleBase
if (Test-Path $mdir\*helpinfo.xml)
{
$mName=$mModule.Name
$mNodes = dir $mdir\*helpinfo.xml -ErrorAction SilentlyContinue |
Select-Xml -Namespace $HelpInfoNamespace -XPath "//helpInfo:UICulture"
foreach ($mNode in $mNodes)
{
$mCulture=$mNode.Node.UICultureName
$mVer=$mNode.Node.UICultureVersion
[PSCustomObject]@{"ModuleName"=$mName; "Culture"=$mCulture; "Version"=$mVer}
}
}
}
ModuleName Culture Version
---------- ------- -------
ActiveDirectory en-US 3.0.0.0
ADCSAdministration en-US 3.0.0.0
ADCSDeployment en-US 3.0.0.0
ADDSDeployment en-US 3.0.0.0
ADFS en-US 3.0.0.0参数
-Confirm
提示你在运行 cmdlet 之前进行确认。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
指定有权访问 SourcePath 指定的文件系统位置的用户的凭据。 仅当命令中使用了 SourcePath 或 LiteralPath 参数时，此参数才有效。
使用 Credential 参数可以在远程计算机上使用 SourcePath 参数运行Update-Help命令。 通过提供显式凭据，可以在远程计算机上运行该命令，并在第三台计算机上访问文件共享，而不会遇到访问被拒绝错误或使用 CredSSP 身份验证来委托凭据。
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
指示此 cmdlet 不遵循每天一次的限制，跳过版本检查，并下载超过 1 GB 限制的文件。
如果没有此参数， Update-Help 则每 24 小时仅运行一次。 每个模块的下载量限制为 1 GB 的未压缩内容，并且仅当下载内容比计算机上的现有文件更新时，才会安装帮助文件。
每日一次限制可保护托管帮助文件的服务器，并使你能够将命令添加到 Update-Help PowerShell 配置文件，而不会产生重复连接或下载的资源成本。
若要在没有 Force 参数的情况下，为多个 UI 区域性中的模块更新帮助，请将所有 UI 区域性包括在相同的命令中，例如：
Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FullyQualifiedModule
指定以 ModuleSpecification 对象形式指定的名称的模块。 这些模块在 ModuleSpecification 构造函数 的“备注”部分中介绍 (哈希表) 。
例如， FullyQualifiedModule 参数接受采用以下格式指定的模块名称：
@{ModuleName = "modulename"; ModuleVersion = "version_number"}
或
@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}.
ModuleName 和 ModuleVersion 是必需的，但 Guid 是可选的。
不能在与 Module 参数相同的命令中指定 FullyQualifiedModule 参数。
| Type: | ModuleSpecification[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LiteralPath
指定更新的帮助文件的文件夹，而不是从 Internet 下载它们。 如果使用 Save-Help cmdlet 将帮助文件下载到目录，请使用此参数或 SourcePath。
可以将目录对象（如从 Get-Item cmdlet Get-ChildItem ）管道到 Update-Help。
与 SourcePath 的值不同， LiteralPath 的值完全按类型化使用。 不会将任何字符解释为通配字符。 如果路径包括转义符，请将其括在单引号中。 单引号指示 PowerShell 不要将任何字符解释为转义序列。
| Type: | String[] |
| Aliases: | PSPath |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Module
为指定模块更新帮助。 在逗号分隔列表中输入一个或多个模块名称或名称模式，或指定在每个行中列出一个模块名称的文件。 允许使用通配符。 可以将 cmdlet 中的 Get-Module 模块管道到 Update-Help cmdlet。
指定的模块必须安装在计算机上，但不必将其导入到当前会话中。 可以在会话中指定任何模块，也可以指定安装在环境变量中列出的 $env:PSModulePath 位置的任何模块。
(所有) 尝试更新计算机上安装的所有模块的帮助的值 * 。
包含不支持可更新帮助的模块。 当命令遇到不支持可更新帮助的模块时，此值可能会生成错误。 而是在没有参数的情况下运行 Update-Help 。
cmdlet 的 Update-HelpModule 参数不接受模块文件或模块清单文件的完整路径。 若要更新不在 $env:PSModulePath 某个位置的模块的帮助，请在运行 Update-Help 命令之前将模块导入当前会话。
| Type: | String[] |
| Aliases: | Name |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-Recurse
对指定目录中的帮助文件执行递归搜索。 仅当命令使用 SourcePath 参数时，此参数才有效。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SourcePath
指定一个文件系统文件夹，用于 Update-Help 获取更新的帮助文件，而不是从 Internet 下载它们。 输入文件夹的路径。 请勿指定文件名或文件扩展名。 可以将文件夹（如 cmdlet 中的Get-ItemGet-ChildItem文件夹）管道到 Update-Help。
默认情况下， Update-Help 从 Internet 下载更新的帮助文件。 使用 Save-Help cmdlet 将更新的帮助文件下载到目录时，请使用 SourcePath。
若要指定 SourcePath 的默认值，请转到组策略、计算机配置和设置 Update-Help 的默认源路径。 此组策略设置可防止用户使用 Update-Help Internet 下载帮助文件。
有关详细信息，请参阅 about_Group_Policy_Settings。
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UICulture
指定用于获取更新帮助文件的 UI 区域性值 Update-Help 。 输入一个或多个语言代码，例如 es-ES、包含区域性对象的变量或获取区域性对象的命令，例如 Get-Culture 或 Get-UICulture 命令。 不允许通配符，也不能提交部分语言代码，例如 de。
默认情况下， Update-Help 获取操作系统的 UI 区域性集中的帮助文件。 如果指定 UICulture 参数， Update-Help 则仅查找指定 UI 区域性的帮助。
仅当模块为指定的 UI 区域性提供帮助文件时，使用 UICulture 参数的命令才会成功。 如果命令因不支持指定的 UI 区域性而失败，则会显示错误消息。
| Type: | CultureInfo[] |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseDefaultCredentials
指示 Update-Help 使用当前用户的凭据运行命令，包括 Internet 下载。 默认情况下，在没有显式凭据的情况下运行该命令。
仅当 Web 下载使用 NT LAN Manager (NTLM) 、协商或基于 Kerberos 的身份验证时，此参数才有效。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
显示在此 cmdlet 运行的情况下将会发生什么。 cmdlet 未运行。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
输入
可以通过管道将目录路径传递给 Update-Help。
可以通过管道将模块对象从 Get-Module cmdlet 传递给 Update-Help。
输出
None
Update-Help 不生成任何输出。
备注
若要更新 PowerShell Core 模块的帮助，其中包含随 PowerShell 一起安装的命令或目录中的任何模块 $PSHOME\Modules ，请使用“ 以管理员身份运行”选项启动 PowerShell。
只有计算机上的 Administrators 组成员可以更新 PowerShell Core 模块的帮助、与 PowerShell 一起安装的命令以及文件夹中的模块 $PSHOME\Modules 。 如果没有更新帮助文件的权限，可以联机阅读帮助文件。 例如 Get-Help Update-Help -Online。
模块是可更新帮助的最小单位。 无法更新特定 cmdlet 的帮助。 若要查找包含特定 cmdlet 的模块，请使用 cmdlet 的 Get-CommandModuleName 属性，例如(Get-Command Update-Help).ModuleName。
由于帮助文件安装在模块目录中，因此 Update-Help cmdlet 只能为计算机上安装的模块安装更新的帮助文件。 但是，该 Save-Help cmdlet 可以为未安装在计算机上的模块保存帮助。
如果 Update-Help 找不到模块的更新的帮助文件，或者找不到指定语言的更新帮助，则它会以无提示方式继续，而不会显示错误消息。 若要查看状态和进度的详细信息，请使用 Verbose 参数。
cmdlet Update-Help 在 Windows PowerShell 3.0 中引入。 它不适用于早期版本的Windows PowerShell。 在Windows PowerShell 2.0 和 Windows PowerShell 3.0 的计算机上，使用 Update-Help Windows PowerShell 3.0 会话中的 cmdlet 下载和更新帮助文件。 帮助文件可用于 Windows PowerShell 2.0 和 Windows PowerShell 3.0。
和 Update-HelpSave-Help cmdlet 使用以下端口下载帮助文件：用于 HTTP 的端口 80 和用于 HTTPS 的端口 443。
Update-Help 支持所有模块和 PowerShell Core 管理单元。它不支持任何其他管理单元。
若要更新环境变量中 $env:PSModulePath 未列出的位置的模块的帮助，请将模块导入当前会话，然后运行 Update-Help 命令。 在没有参数的情况下运行 Update-Help ，或使用 Module 参数指定模块名称。 和 Save-Help cmdlet 的 Update-HelpModule 参数不接受模块文件或模块清单文件的完整路径。
所有模块都支持可更新帮助。 有关在创作的模块中支持 可更新帮助的说明，请参阅支持可更新帮助。
Save-Help Windows 预安装环境不支持 cmdlet Update-Help (Windows PE) 。