Update-Help
下載最新的說明檔並安裝於電腦上。
Syntax
Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[[-SourcePath] <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-LiteralPath <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
Cmdlet Update-Help 會下載 PowerShell 模組的最新說明檔，並將其安裝在您的電腦上。 您不需要重新開機 PowerShell，才能使變更生效。 您可以使用 Get-Help Cmdlet 立即檢視新的說明檔。
Update-Help 會檢查電腦上的說明檔版本。 如果您沒有模組的說明檔，或您的說明檔已過期，請 Update-Help 下載最新的說明檔。 您可以從網際網路或檔案共用下載並安裝說明檔。
如果沒有參數， Update-Help 請更新會話中模組的說明檔，以及支援可更新說明的所有已安裝模組。 包含已安裝但未載入目前會話中的模組。 PowerShell 模組會儲存在環境變數中列出的 $env:PSModulePath 位置。 如需詳細資訊，請參閱 about_Updatable_Help。
您可以使用 Module 參數來更新特定模組的說明檔。 使用 UICulture 參數，以多種語言和地區設定下載說明檔。
您也可以在未連線到網際網路的電腦上使用 Update-Help 。 首先，使用 Save-Help Cmdlet 從網際網路下載說明檔案，並將其儲存在系統無法連線到網際網路的共用資料夾中。 然後使用 的 Update-HelpSourcePath參數，從共用下載更新的說明檔，並將其安裝在電腦上。
您可以將 Cmdlet 新增 Update-Help 至 PowerShell 設定檔，以自動化協助更新。 根據預設， Update-Help 每部電腦上每天只會執行一次。 若要覆寫每天一次的限制，請使用 Force 參數。
Cmdlet Update-Help 是在 Windows PowerShell 3.0 中引進。
重要
Update-Help 需要 PowerShell 6.0 和更新版本中的系統管理許可權。
PowerShell 6.1 和更新版本會將預設 的 Scope 設定為 CurrentUser 。
在 PowerShell 6.1 之前， 無法使用 Scope 參數。
您必須是電腦上的 Administrators 群組成員，才能更新核心 PowerShell 模組的說明檔。
若要下載或更新 PowerShell 安裝目錄中模組的說明檔， () $PSHOME\Modules ，包括 PowerShell Core 模組，請使用 [ 以系統管理員身分執行 ] 選項啟動 PowerShell。
例如：Start-Process pwsh.exe -Verb RunAs。
範例
範例 1：更新所有模組的說明檔
Cmdlet Update-Help 會更新支援可更新說明之已安裝模組的說明檔。 使用者介面 (UI) 文化特性語言是在作業系統中設定。
Update-Help範例 2：更新指定模組的說明檔
Cmdlet Update-Help 只會針對以 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：從檔案共用更新多部電腦上的說明檔案
在此範例中，更新的說明檔會從網際網路下載，並儲存在檔案共用中。 需要使用者認證，才能存取檔案共用並安裝更新。 使用檔案共用時，可以更新防火牆後方或未連線到網際網路的電腦。
Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}此命令 Save-Help 會下載所有支援可更新說明之模組的最新說明檔。
DestinationPath參數會將檔案儲存在檔案共用中 \\Server01\Share\PSHelp 。 Credential參數會指定有權存取檔案共用的使用者。
Cmdlet Invoke-Command 會在多部電腦上執行遠端 Update-Help 命令。 ComputerName參數會從Servers.txt檔案取得遠端電腦的清單。 ScriptBlock參數會 Update-Help 執行 命令，並使用SourcePath參數來指定包含更新說明檔的檔案共用。 Credential參數會指定可存取檔案共用並執行遠端 Update-Help 命令的使用者。
範例 5：取得更新的說明檔清單
Cmdlet Update-Help 會更新指定模組的說明。 Cmdlet 會使用 Verbose 通用參數來顯示已更新的說明檔清單。 您可以使用 詳細資訊 來檢視特定模組之所有說明檔或說明檔的輸出。
如果沒有 Verbose 參數， Update-Help 就不會顯示命令的結果。 Verbose參數輸出有助於確認說明檔是否已更新，或是否已安裝最新版本。
Update-Help -Module Microsoft.PowerShell.Utility -Verbose範例 6：尋找支援可更新說明的模組
此範例會列出支援可更新說明的模組。 此命令會使用模組的 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, ... }範例 7：清查更新的說明檔
在此範例中，腳本 Get-UpdateHelpVersion.ps1 會針對每個模組及其版本號碼建立可更新說明檔案的清查。
腳本會使用模組的 HelpInfoUri 屬性來識別支援可更新說明的模組。 對於支援可更新說明的模組，腳本會尋找並剖析說明資訊檔， (*helpinfo.xml) 尋找最新版本號碼。
腳本會使用 PSCustomObject 類別和雜湊表來建立自訂輸出物件。
# Get-UpdateHelpVersion.ps1
Param(
[parameter(Mandatory=$False)]
[String[]]
$Module
)
$HelpInfoNamespace = @{helpInfo='http://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 驗證來委派認證。
輸入使用者名稱，例如User01或Domain01\User01，或輸入 Cmdlet 產生的 Get-CredentialPSCredential物件。 如果您輸入使用者名稱，系統會提示您輸入密碼。
認證會儲存在 PSCredential 物件中，密碼會儲存為 SecureString。
注意
如需 SecureString 資料保護的詳細資訊，請參閱 SecureString 有多安全？。
| Type: | PSCredential |
| Position: | Named |
| Default value: | Current user |
| 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 建構 函式的一節中描述， (Hashtable) 。
例如， 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
指定更新說明檔的資料夾，而不是從網際網路下載。 如果您使用 Cmdlet 將說明檔下載至目錄， Save-Help 請使用此參數或SourcePath。
您可以將目錄物件管線，例如從 Get-Item 或 Get-ChildItem Cmdlet 傳送至 Update-Help 。
與 SourcePath的值不同， LiteralPath 的值會完全依照其類型使用。 沒有字元會被視為萬用字元。 如果路徑包含逸出字元，請將它括在單引號中。 單引號會告訴 PowerShell 不要將任何字元解譯為逸出序列。
| Type: | String[] |
| Aliases: | PSPath, LP |
| 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 |
-Scope
指定更新說明的系統範圍。 在AllUsers範圍更新需要 Windows 系統上的系統管理許可權。 參數 -Scope 是在 PowerShell Core 6.1 版中引進。
CurrentUser 是 PowerShell 6.1 和更新版本中說明檔的預設範圍。 您可以指定AllUsers來安裝或更新所有使用者的說明。 需要 Unix 系統上 sudo 的許可權，才能更新所有使用者的說明。 例如： sudo pwsh -c Update-Help
可接受的值如下：
- CurrentUser
- AllUsers
| Type: | UpdateHelpScope |
| Position: | Named |
| Default value: | CurrentUser |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SourcePath
指定取得更新說明檔的檔系統資料夾 Update-Help ，而不是從網際網路下載。 輸入資料夾的路徑。 請勿指定檔案名或副檔名。 您可以將資料夾管線，例如從 Get-Item 或 Get-ChildItem Cmdlet 傳送至 Update-Help 。
根據預設， Update-Help 會從網際網路下載更新的說明檔。 當您使用 Cmdlet 將更新的說明檔下載至目錄時， Save-Help 請使用SourcePath。
若要指定SourcePath的預設值，請移至[群組原則]、[電腦設定] 和[設定 Update-Help 的預設來源路徑]。 此群組原則設定可防止使用者使用 Update-Help 從網際網路下載說明檔。
如需詳細資訊，請參閱 about_Group_Policy_Settings。
| Type: | String[] |
| Aliases: | Path |
| 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 文化特性的說明。
注意
Ubuntu 18.04 將預設地區設定變更為 C.UTF.8 ，這是無法辨識的 UI 文化特性。 Update-Help 除非您搭配支援的地區設定使用此參數，否則以無訊息方式下載說明，例如 en-US 。 這可能會發生在使用不支援值的任何平臺上。
只有當模組有提供所指定 UI 文化特性的說明檔時，使用 UICulture 參數的命令才會成功。 如果命令因為不支援指定的 UI 文化特性而失敗，則會顯示錯誤訊息。
| Type: | CultureInfo[] |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseDefaultCredentials
指出使用 Update-Help 目前使用者的認證來執行命令，包括網際網路下載。 根據預設，該命令執行時不會使用明確宣告的認證。
只有當網頁下載使用 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 模組的說明，其中包含隨 PowerShell 一起安裝的命令，或目錄中的任何模組 $PSHOME\Modules ，請使用 [ 以系統管理員身分執行] 選項啟動 PowerShell。
只有電腦上的 Administrators 群組成員可以更新核心 PowerShell 模組的說明、與 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 中引進。 它不適用於舊版 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-Help和 Save-Help Cmdlet 會使用下列埠來下載說明檔：HTTP 的埠 80 和 HTTPS 的埠 443。
Update-Help 支援所有模組和核心 PowerShell 嵌入式管理單元。它不支援任何其他嵌入式管理單元。
若要更新環境變數中未列出的 $env:PSModulePath 模組說明，請將模組匯入目前的會話，然後執行 Update-Help 命令。 在沒有參數的情況下執行 Update-Help ，或使用 Module 參數來指定模組名稱。 和 Save-Help Cmdlet 的 Update-HelpModule參數不接受模組檔案或模組資訊清單檔的完整路徑。
任何模組都能支援「可更新的說明」。 如需在您所撰寫模組中支援可更新說明的指示，請參閱 支援可更新的說明。
Update-HelpWindows 預先安裝環境不支援 和 Save-Help Cmdlet (Windows PE) 。