Update-Help

Sözdizimi

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 modülleri için en yeni yardım dosyalarını indirir ve bunları bilgisayarınıza yükler. Değişikliği etkili hale getirmek için PowerShell'i yeniden başlatmanız gerekmez. Yeni yardım dosyalarını hemen görüntülemek için cmdlet'ini kullanabilirsiniz Get-Help .

Update-Help , bilgisayarınızdaki yardım dosyalarının sürümünü denetler. Bir modül için yardım dosyalarınız yoksa veya yardım dosyalarınız güncel değilse, Update-Help en yeni yardım dosyalarını indirir. Yardım dosyaları internetten veya dosya paylaşımından indirilebilir ve yüklenebilir.

Parametreler olmadan, Update-Help güncelleştirilebilir yardımı destekleyen ve oturuma yüklenen veya içinde bulunan $env:PSModulePathbir konuma yüklenen modüller için yardım dosyalarını güncelleştirir. Daha fazla bilgi için bkz. about_Updatable_Help.

Update-Help yüklü yardımın sürümünü denetler. Bir modül için güncelleştirilmiş yardım dosyaları bulunamazsa Update-Help , hata iletisi görüntülenmeden sessizce devam eder. Sürüm denetimini atlamak için Force parametresini kullanın. Durum ve ilerleme ayrıntılarını görmek için Ayrıntılı parametresini kullanın. Belirli bir modülün yardım dosyalarını güncelleştirmek için Module parametresini kullanın.

İnternet'e bağlı olmayan bilgisayarlarda da kullanabilirsiniz Update-Help . İlk olarak, cmdlet'ini Save-Helpkullanarak yardım dosyalarını İnternet'ten indirin ve bunları İnternet'e bağlı olmayan sistem tarafından erişilebilen paylaşılan bir klasöre kaydedin. Ardından, paylaşılandan güncelleştirilmiş yardım dosyalarını indirmek ve bilgisayara yüklemek için sourcepath parametresini Update-Help kullanın.

Update-Help Cmdlet, Windows PowerShell 3.0'da kullanıma sunulmuştur.

Örnekler

Örnek 1: Tüm modüller için yardım dosyalarını güncelleştirme

Update-Help Cmdlet, Güncelleştirilebilir Yardım'ı destekleyen yüklü modüller için yardım dosyalarını güncelleştirir. Kullanıcı arabirimi (UI) kültür dili işletim sisteminde ayarlanır.

Update-Help

Örnek 2: Belirtilen modüller için yardım dosyalarını güncelleştirme

Update-Help Cmdlet yalnızca Microsoft.PowerShell ile başlayan modül adları için yardım dosyalarını güncelleştirir.

Update-Help -Module Microsoft.PowerShell*

Örnek 3: En-US yerel ayarına ayarlı olmayan bir sistemde yardım güncelleştiriliyor

Update-Help Cmdlet, birden çok dilde yardım indirmek için tasarlanmıştır. Ancak, sisteminizin kullandığı dil için kullanılabilir bir yardım olmadığında modül ve kullanıcı arabirimi kültürü için bir hata iletisi görüntülenir.

Bu örnekte, Update-Help yerel ayara ayarlanmış en-GB bir sistemde çalıştırılıyor.

Update-Help Microsoft.PowerShell.Utility -Force

Update-Help: Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with
UI culture(s) {en-GB} : The specified culture is not supported: en-GB. Specify a culture
from the following list: {en-US}..
English-US help content is available and can be installed using: Update-Help -UICulture en-US.

Yardım dosyaları her zaman yerel ayar için en-US yayımlanır. İngilizce yardımını indirmek için UICulture parametresiyle komutunu çalıştırın Update-Help ve yerel ayarı belirtinen-US.

Örnek 4: Bir dosya paylaşımından birden çok bilgisayarda yardım dosyalarını güncelleştirme

Bu örnekte, güncelleştirilmiş yardım dosyaları İnternet'ten indirilir ve bir dosya paylaşımına kaydedilir. Dosya paylaşımına erişme ve güncelleştirmeleri yükleme izinlerine sahip kullanıcı kimlik bilgileri gereklidir. Dosya paylaşımı kullanıldığında, güvenlik duvarlarının arkasındaki veya İnternet'e bağlı olmayan bilgisayarları güncelleştirmek mümkündür.

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
}

Komut, Save-Help Güncelleştirilebilir Yardım'ın desteklendiğini tüm modüller için en yeni yardım dosyalarını indirir. DestinationPath parametresi dosyaları dosya paylaşımına \\Server01\Share\PSHelp kaydeder. Credential parametresi, dosya paylaşımına erişim izni olan bir kullanıcıyı belirtir.

Invoke-Command Cmdlet, birden çok bilgisayarda uzak Update-Help komutlar çalıştırır. ComputerName parametresi, Servers.txt dosyasından uzak bilgisayarların listesini alır. ScriptBlock parametresi komutunu çalıştırır Update-Help ve sourcepath parametresini kullanarak güncelleştirilmiş yardım dosyalarını içeren dosya paylaşımını belirtir. Credential parametresi, dosya paylaşımına erişebilen ve uzak Update-Help komutu çalıştırabilen bir kullanıcıyı belirtir.

Örnek 5: Güncelleştirilmiş yardım dosyalarının listesini alma

Belirtilen Update-Help modül için cmdlet güncelleştirmeleri yardımı. Cmdlet, güncelleştirilen yardım dosyalarının listesini görüntülemek için Ayrıntılı ortak parametresini kullanır. Belirli bir modülün tüm yardım dosyalarının veya yardım dosyalarının çıkışını görüntülemek için Ayrıntılı'yi kullanabilirsiniz.

Ayrıntılı parametresi olmadan komutun Update-Help sonuçlarını görüntülemez. Ayrıntılı parametre çıkışı, yardım dosyalarının güncelleştirildiğini veya en son sürümün yüklü olup olmadığını doğrulamak için yararlıdır.

Update-Help -Module Microsoft.PowerShell.Utility -Verbose

Örnek 6: Güncelleştirilebilir Yardım'ı destekleyen modülleri bulma

Bu örnekte Güncelleştirilebilir Yardımı destekleyen modüller listelenir. Komutu, Güncelleştirilebilir Yardım'ı destekleyen modülleri tanımlamak için modülün HelpInfoUri özelliğini kullanır. HelpInfoUri özelliği, cmdlet çalıştırıldığında Update-Help yeniden yönlendirilen bir URL içerir.

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, ... }

Örnek 7: Güncelleştirilmiş yardım dosyalarının envanteri

Bu örnekte betik Get-UpdateHelpVersion.ps1 , her modül ve sürüm numaraları için Güncelleştirilebilir Yardım dosyalarının bir envanterini oluşturur.

Betik, modüllerin HelpInfoUri özelliğini kullanarak Güncelleştirilebilir Yardımı destekleyen modülleri tanımlar. Güncelleştirilebilir Yardım'ı destekleyen modüller için betik, en son sürüm numarasını bulmak için yardım bilgileri dosyasını (*helpinfo.xml) arar ve ayrıştırılır.

Betik, özel bir çıkış nesnesi oluşturmak için PSCustomObject sınıfını ve karma tablosunu kullanır.

# 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

Parametreler

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-Scope

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Girişler

DirectoryInfo

Dizin yolu nesnesini bu cmdlet'e yöneltebilirsiniz.

PSModuleInfo

Bir modül nesnesini bu cmdlet'e aktarabilirsiniz.

Çıkışlar

None

Bu cmdlet çıkış döndürmez.

Notlar

PowerShell ile yüklenen komutları veya dizindeki herhangi bir modülü içeren temel PowerShell modüllerine yönelik yardımı güncelleştirmek için PowerShell'i $PSHOME\Modules Yönetici olarak çalıştır seçeneğiyle başlatın.

Yalnızca bilgisayardaki Administrators grubunun üyeleri çekirdek PowerShell modülleri, PowerShell ile birlikte yüklenen komutlar ve klasördeki $PSHOME\Modules modüller için yardımı güncelleştirebilir. Yardım dosyalarını güncelleştirme izniniz yoksa yardım dosyalarını çevrimiçi olarak okuyabilirsiniz. Örneğin, Get-Help Update-Help -Online.

Modüller, güncelleştirilebilir yardımın en küçük birimidir. Belirli bir cmdlet için yardımı güncelleştiremezsiniz. Belirli bir cmdlet içeren modülü bulmak için cmdlet'inin ModuleName özelliğini kullanın; örneğin, (Get-Command Update-Help).ModuleName.Get-Command

Yardım dosyaları modül dizinine yüklendiğinden Update-Help , cmdlet yalnızca bilgisayarda yüklü olan modüller için güncelleştirilmiş yardım dosyasını yükleyebilir. Save-Help Ancak, cmdlet bilgisayarda yüklü olmayan modüller için yardım kaydedebilir.

Update-Help Cmdlet, Windows PowerShell 3.0'da kullanıma sunulmuştur. PowerShell'in önceki sürümlerinde çalışmaz. Hem Windows PowerShell 2.0 hem de Windows PowerShell 3.0 bulunan bilgisayarlarda, yardım dosyalarını indirmek ve güncelleştirmek için Windows PowerShell 3.0 oturumundaki cmdlet'ini kullanın Update-Help . Yardım dosyaları hem Windows PowerShell 2.0 hem de Windows PowerShell 3.0 tarafından kullanılabilir.

ve Save-Help cmdlet'leriUpdate-Help, yardım dosyalarını indirmek için aşağıdaki bağlantı noktalarını kullanır: HTTP için 80 numaralı bağlantı noktası ve HTTPS için 443 numaralı bağlantı noktası.

Update-Help tüm modülleri ve çekirdek PowerShell ek bileşenlerini destekler. Diğer ek bileşenleri desteklemez.

Ortam değişkeninde listelenmeyen bir konumdaki modülün yardımını $env:PSModulePath güncelleştirmek için modülü geçerli oturuma aktarın ve ardından bir Update-Help komut çalıştırın. Parametre olmadan çalıştırın Update-Help veya modül adını belirtmek için Module parametresini kullanın. ve Save-Help cmdlet'lerinin Update-Help Module parametresi bir modül dosyasının veya modül bildirim dosyasının tam yolunu kabul etmez.

Herhangi bir modül Güncelleştirilebilir Yardımı destekleyebilir. Oluşturduğunuz modüllerde Güncelleştirilebilir Yardım'ı destekleme yönergeleri için bkz . Güncelleştirilebilir Yardımı Destekleme.

Update-Help ve Save-Help cmdlet'leri Windows Önyükleme Ortamı'nda (Windows PE) desteklenmez.

İlişkili Bağlantılar

• Get-Culture
• Get-Help
• Get-Module
• Get-UICulture
• Start-Job
• Save-Help