Update-Help
Bilgisayarınıza en yeni yardım dosyalarını indirir ve yükler.
Syntax
Path (Varsayılan)
Update-Help
[[-Module] <String[]>]
[[-SourcePath] <String[]>]
[[-UICulture] <CultureInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-Recurse]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LiteralPath
Update-Help
[[-Module] <String[]>]
[[-UICulture] <CultureInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-LiteralPath <String[]>]
[-Recurse]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Update-Help cmdlet'i, PowerShell modülleri için en yeni yardım dosyalarını indirir ve 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 Get-Help cmdlet'ini kullanabilirsiniz.
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, oturumdaki modüller ve Güncelleştirilebilir Yardım'ı destekleyen tüm yüklü modüller için yardım dosyalarını güncelleştirir. Yüklü olan ancak geçerli oturumda yüklenmeyen modüller dahil edilir. PowerShell modülleri, $env:PSModulePath ortam değişkeninde listelenen bir konumda depolanır. Daha fazla bilgi için bkz. about_Updatable_Help.
Belirli bir modülün yardım dosyalarını güncelleştirmek için Modülü parametresini kullanabilirsiniz. Birden çok dilde ve yerel ayarda yardım dosyalarını indirmek için UICulture parametresini kullanın.
İnternete bağlı olmayan bilgisayarlarda da kullanabilirsiniz Update-Help . İlk olarak, yardım dosyalarını İnternet'ten indirmek ve bunları İnternet'e bağlı olmayan sistemin erişebileceği paylaşılan bir klasöre kaydetmek için cmdlet'i kullanın Save-Help. Ardından Update-Help parametresini kullanarak paylaşılan yardım dosyalarını indirip bilgisayara yükleyin.
PowerShell profilinize Update-Help cmdlet'ini ekleyerek yardım güncelleştirmelerini otomatikleştirebilirsiniz. Varsayılan olarak, Update-Help her bilgisayarda günde yalnızca bir kez çalışır. Günde bir kez sınırı geçersiz kılmak için Zorla parametresini kullanın.
Update-Help cmdlet'i Windows PowerShell 3.0'da kullanıma sunulmuştur.
Önemli
Update-Help, PowerShell 6.0 ve altında yönetim ayrıcalıkları gerektirir.
PowerShell 6.1 ve üzeri varsayılan KapsamCurrentUserolarak ayarlayın.
PowerShell 6.1'den önce Kapsam parametresi kullanılamıyordu.
Çekirdek PowerShell modüllerinin yardım dosyalarını güncelleştirmek için bilgisayardaki Yöneticiler grubunun üyesi olmanız gerekir.
PowerShell Core modülleri de dahil olmak üzere PowerShell yükleme dizinindeki ($PSHOME\Modules) modüllerin yardım dosyalarını indirmek veya güncelleştirmek için Yönetici olarak çalıştır seçeneğini kullanarak PowerShell'i başlatın.
Örneğin: Start-Process pwsh.exe -Verb RunAs.
Örnekler
Örnek 1: Tüm modüller için yardım dosyalarını güncelleştirme
Update-Help cmdlet'i 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'i yalnızca Microsoft.PowerShellile başlayan modül adlarıyla ilgili yardım dosyalarını güncelleştirir.
Update-Help -Module Microsoft.PowerShell*
Örnek 3: Farklı diller için yardım dosyalarını güncelleştirme
Update-Help cmdlet'i tüm modüller için Japonca (ja-JP) ve İngilizce (en-US) yardım dosyalarını güncelleştirir.
Bir modül belirtilen ui kültürü için yardım dosyaları sağlamazsa modül ve ui kültürü için bir hata iletisi görüntülenir. Bu örnekte hata iletisi, Microsoft.PowerShell.Utility
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.
Ö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
}
Save-Help komutu Güncelleştirilebilir Yardımı destekleyen tüm modüller için en yeni yardım dosyalarını indirir.
DestinationPath parametresi, dosyaları \\Server01\Share\PSHelp dosya paylaşımına kaydeder.
Kimlik Bilgisi parametresi, dosya paylaşımına erişim izni olan bir kullanıcıyı belirtir.
Invoke-Command cmdlet'i 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 Update-Help komutunu çalıştırır ve güncelleştirilmiş yardım dosyalarını içeren dosya paylaşımını belirtmek için SourcePath parametresini kullanır.
Kimlik Bilgisi parametresi, dosya paylaşımına erişebilen ve uzak Update-Help komutunu çalıştırabilen bir kullanıcıyı belirtir.
Örnek 5: Güncelleştirilmiş yardım dosyalarının listesini alma
belirtilen modül için Update-Help 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. Tüm yardım dosyalarının veya belirli bir modülün yardım dosyalarının çıktısını görüntülemek için Ayrıntılı kullanabilirsiniz.
Ayrıntılı parametresi olmadan Update-Help komutun 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. Komut, Güncelleştirilebilir Yardımı destekleyen modülleri tanımlamak için modülün HelpInfoUri özelliğini kullanır.
HelpInfoUri özelliği, Update-Help cmdlet'i çalıştırıldığında yeniden yönlendirilen bir adres 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 için Güncelleştirilebilir Yardım dosyalarının ve bunların sürüm numaralarının 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
Cmdlet'i çalıştırmadan önce sizden onay ister.
Parametre özellikleri
| Tür: | SwitchParameter |
| Default value: | False |
| Joker karakterleri destekler: | False |
| DontShow: | False |
| Diğer adlar: | Cf |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Credential
SourcePathtarafından belirtilen dosya sistemi konumuna erişim izni olan bir kullanıcının kimlik bilgilerini belirtir. Bu parametre yalnızca komutta SourcePath veya LiteralPath parametresi kullanıldığında geçerlidir.
Kimlik Bilgisi parametresi, uzak bilgisayarlarda Update-Help parametresiyle komutları çalıştırmanızı sağlar. Açık kimlik bilgileri sağlayarak uzak bir bilgisayarda komutunu çalıştırabilir ve üçüncü bir bilgisayardaki dosya paylaşımına erişim reddedildi hatasıyla karşılaşmadan veya kimlik bilgilerini temsilci olarak atamak için CredSSP kimlik doğrulamasını kullanmadan erişebilirsiniz.
User01 veya Domain01\User01gibi bir kullanıcı adı yazın veya cmdlet'i tarafından oluşturulan Get-Credential nesnesi girin. Bir kullanıcı adı yazarsanız parolayı girmeniz istenir.
Kimlik bilgileri bir PSCredential nesnesinde depolanır ve parola SecureStringolarak depolanır.
Uyarı
SecureString veri koruması hakkında daha fazla bilgi için bkz. SecureString ne kadar güvenli?.
Parametre özellikleri
| Tür: | PSCredential |
| Default value: | Current user |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Force
Bu cmdlet'in günde bir kez sınırlamaya uymadığını, sürüm denetimini atladığını ve 1 GB sınırını aşan dosyaları indirdiğini gösterir.
Bu parametre olmadan, Update-Help her 24 saatlik dönemde yalnızca bir kez çalışır. İndirmeler modül başına 1 GB sıkıştırılmamış içerikle sınırlıdır ve yardım dosyaları yalnızca bilgisayardaki mevcut dosyalardan daha yeni olduklarında yüklenir.
Günde bir kez sınırı, yardım dosyalarını barındıran sunucuları korur ve yinelenen bağlantıların veya indirmelerin kaynak maliyetine neden olmadan PowerShell profilinize bir Update-Help komutu eklemenizi pratik hale getirir.
Force parametresi olmadan birden çok ui kültüründeki bir modülün yardımını güncelleştirmek için, aşağıdakiler gibi tüm ui kültürlerini aynı komuta ekleyin:
Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
Parametre özellikleri
| Tür: | SwitchParameter |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-FullyQualifiedModule
ModuleSpecification nesneleri biçiminde belirtilen adlara sahip modülleri belirtir. Bu modüller, ModuleSpecification Constructor (Hashtable)'nin Açıklamalar bölümünde açıklanmıştır.
Örneğin, FullyQualifiedModule parametresi şu biçimde belirtilen bir modül adını kabul eder:
@{ModuleName = "modulename"; ModuleVersion = "version_number"}
veya
@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}.
ModuleName ve ModuleVersion gereklidir, ancak Guid isteğe bağlıdır.
Modülü parametresiyle aynı komutta FullyQualifiedModule parametresini belirtemezsiniz.
Parametre özellikleri
| Tür: | |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | True |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-LiteralPath
Güncelleştirilmiş yardım dosyalarını İnternet'ten indirmek yerine klasörü belirtir. Yardım dosyalarını bir dizine indirmek için cmdlet'ini kullandıysanız bu parametreyi veya Save-Help kullanın.
Get-Item veya Get-ChildItem cmdlet'leri gibi bir dizin nesnesini Update-Helpiçin işlem hattı oluşturabilirsiniz.
SourcePathdeğerinden farklı olarak, LiteralPath değeri tam olarak yazıldığı gibi kullanılır. Hiçbir karakter joker karakter olarak yorumlanmamıştır. Yol kaçış karakterleri içeriyorsa, yolu tek tırnak işaretleriyle çevreleyin. Tek tırnak işaretleri, PowerShell'in hiçbir karakteri kaçış dizisi olarak yorumlamamasını sağlar.
Parametre özellikleri
| Tür: | String[] |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
| Diğer adlar: | PSPath, LP |
Parametre kümeleri
LiteralPath
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | True |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Module
Belirtilen modüller için güncelleştirme yardımı. Virgülle ayrılmış bir listeye bir veya daha fazla modül adı veya ad deseni girin veya her satırda bir modül adı listeleyen bir dosya belirtin. Joker karakterlere izin verilir. modülleri Get-Module cmdlet'inden Update-Help cmdlet'ine işlem hattı oluşturabilirsiniz.
Belirttiğiniz modüllerin bilgisayarda yüklü olması gerekir, ancak geçerli oturuma aktarılması gerekmez. Oturumdaki herhangi bir modülü veya $env:PSModulePath ortam değişkeninde listelenen bir konuma yüklenen herhangi bir modülü belirtebilirsiniz.
* değeri (tümü) bilgisayarda yüklü olan tüm modüller için yardımı güncelleştirmeye çalışır.
Güncelleştirilebilir Yardımı desteklemeyen modüller dahil edilir. Komut Güncelleştirilebilir Yardımı desteklemeyen modüllerle karşılaştığında bu değer hata oluşturabilir. Bunun yerine, Update-Help parametresiz çalıştırın.
cmdlet'in Update-Help parametresi bir modül dosyasının veya modül bildirim dosyasının tam yolunu kabul etmez.
$env:PSModulePath bir konumda olmayan bir modülün yardımını güncelleştirmek için, Update-Help komutunu çalıştırmadan önce modülü geçerli oturuma aktarın.
Parametre özellikleri
| Tür: | String[] |
| Default value: | None |
| Joker karakterleri destekler: | True |
| DontShow: | False |
| Diğer adlar: | İsim |
Parametre kümeleri
(All)
| Position: | 0 |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | True |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Recurse
Belirtilen dizindeki yardım dosyaları için özyinelemeli bir arama gerçekleştirir. Bu parametre yalnızca komut SourcePath parametresini kullandığında geçerlidir.
Parametre özellikleri
| Tür: | SwitchParameter |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-Scope
Yardımın güncelleştirildiği sistem kapsamını belirtir.
AllUsers kapsamındaki güncelleştirmeler, Windows sistemlerinde yönetici ayrıcalıkları gerektirir.
-Scope parametresi PowerShell Core sürüm 6.1'de kullanıma sunulmuştur.
CurrentUser, PowerShell 6.1 ve üzeri yardım dosyaları için varsayılan kapsamdır.
AllUsers, tüm kullanıcılara yönelik yardımı yüklemek veya güncelleştirmek için belirtilebilir. Unix sistemlerinde tüm kullanıcılara yönelik yardımı güncelleştirmek için sudo ayrıcalıkları gerekir. Örneğin: sudo pwsh -c Update-Help
Kabul edilebilir değerler şunlardır:
- MevcutKullanıcı
- Tüm Kullanıcılar
Parametre özellikleri
| Tür: | UpdateHelpScope |
| Default value: | CurrentUser |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | True |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-SourcePath
Update-Help güncelleştirilmiş yardım dosyalarını internetten indirmek yerine aldığı bir dosya sistemi klasörü belirtir. Klasörün yolunu girin. Dosya adı veya dosya adı uzantısı belirtmeyin.
Get-Item veya Get-ChildItem cmdlet'leri gibi bir klasörü Update-Helpiçin işlem hattı oluşturabilirsiniz.
varsayılan olarak, Update-Help güncelleştirilmiş yardım dosyalarını İnternet'ten indirir. Güncelleştirilmiş yardım dosyalarını bir dizine indirmek için cmdlet'ini kullandığınızda Save-Help kullanın.
SourcePathiçin varsayılan bir değer belirtmek için, Grup İlkesi, Bilgisayar Yapılandırması'ne gidin ve Update-Helpiçin varsayılan kaynak yolunu ayarlayın. Bu Grup İlkesi ayarı, kullanıcıların yardım dosyalarını İnternet'ten indirmek için Update-Help kullanmasını engeller.
Daha fazla bilgi için bkz. about_Group_Policy_Settings.
Parametre özellikleri
| Tür: | String[] |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
| Diğer adlar: | Yol |
Parametre kümeleri
Path
| Position: | 1 |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-UICulture
Update-Help güncelleştirilmiş yardım dosyalarını almak için kullandığı kullanıcı arabirimi kültürü değerlerini belirtir.
es-ESgibi bir veya daha fazla dil kodu, kültür nesneleri içeren bir değişken veya Get-Culture veya Get-UICulture komutu gibi kültür nesnelerini alan bir komut girin. Joker karakterlere izin verilmez ve degibi kısmi bir dil kodu gönderemezsiniz.
varsayılan olarak, Update-Help işletim sistemi için ayarlanan kullanıcı arabirimi kültüründeki yardım dosyalarını alır.
UICulture parametresini belirtirseniz Update-Help yalnızca belirtilen ui kültürü için yardım arar.
Uyarı
Ubuntu 18.04, varsayılan yerel ayar ayarını C.UTF.8, tanınan bir kullanıcı arabirimi kültürü olmayan olarak değiştirdi.
Update-Help, bu parametreyi en-USgibi desteklenen bir yerel ayar ile kullanmadığınız sürece sessizce indirme yardımı başarısız olur. Bu, desteklenmeyen bir değer kullanan herhangi bir platformda oluşabilir.
UICulture parametresini kullanan komutlar yalnızca modül belirtilen ui kültürü için yardım dosyaları sağladığında başarılı olur. Belirtilen kullanıcı arabirimi kültürü desteklenmediği için komut başarısız olursa bir hata iletisi görüntülenir.
Parametre özellikleri
| Tür: | |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | 2 |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-UseDefaultCredentials
Update-Help geçerli kullanıcının kimlik bilgilerini kullanarak internet indirmesi de dahil olmak üzere komutu çalıştırdığını gösterir. Varsayılan olarak, komut açık kimlik bilgileri olmadan çalışır.
Bu parametre yalnızca web indirmesi NT LAN Manager (NTLM), anlaşma veya Kerberos tabanlı kimlik doğrulaması kullandığında geçerlidir.
Parametre özellikleri
| Tür: | SwitchParameter |
| Default value: | None |
| Joker karakterleri destekler: | False |
| DontShow: | False |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
-WhatIf
Cmdlet çalıştırılırsa ne olacağını gösterir. Cmdlet çalıştırılmıyor.
Parametre özellikleri
| Tür: | SwitchParameter |
| Default value: | False |
| Joker karakterleri destekler: | False |
| DontShow: | False |
| Diğer adlar: | Wi |
Parametre kümeleri
(All)
| Position: | Named |
| Zorunlu: | False |
| İşlem hattından gelen değer: | False |
| Özellik adına göre işlem hattından gelen değer: | False |
| Kalan bağımsız değişkenlerden elde edilen değer: | False |
CommonParameters
Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.
Girişler
DirectoryInfo
dizin yolunu Update-Help.
PSModuleInfo
bir modül nesnesini Get-Module cmdlet'inden Update-Help'e aktarabilirsiniz.
Çıkışlar
None
Update-Help herhangi bir çıkış oluşturmaz.
Notlar
PowerShell ile yüklenen komutları veya $PSHOME\Modules dizinindeki herhangi bir modülü içeren temel PowerShell modüllerine yönelik yardımı güncelleştirmek için PowerShell'i yönetici olarak çalıştır seçeneğiyle başlatın.
Çekirdek PowerShell modülleri, PowerShell ile birlikte yüklenen komutlar ve $PSHOME\Modules klasöründeki modüller için yalnızca bilgisayardaki Yöneticiler grubunun üyeleri 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 içeren modülü bulmak için, cmdlet'in Get-Command özelliğini kullanın; örneğin, (Get-Command Update-Help).ModuleName.
Yardım dosyaları modül dizinine yüklendiğinden, Update-Help cmdlet'i yalnızca bilgisayarda yüklü olan modüller için güncelleştirilmiş yardım dosyasını yükleyebilir. Ancak, Save-Help cmdlet'i bilgisayarda yüklü olmayan modüller için yardım kaydedebilir.
Update-Help bir modülün güncelleştirilmiş yardım dosyalarını bulamıyorsa veya belirtilen dilde güncelleştirilmiş yardım bulamazsa, hata iletisi görüntülemeden sessizce devam eder. Durum ve ilerleme ayrıntılarını görmek için Ayrıntılı parametresini kullanın.
Update-Help cmdlet'i 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 oturumunda Update-Help cmdlet'ini kullanın. Yardım dosyaları hem Windows PowerShell 2.0 hem de Windows PowerShell 3.0 tarafından kullanılabilir.
Update-Help ve Save-Help cmdlet'leri, 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 temel PowerShell ek bileşenlerini destekler. Diğer ek bileşenleri desteklemez.
$env:PSModulePath ortam değişkeninde listelenmeyen bir konumdaki modülün yardımını güncelleştirmek için modülü geçerli oturuma aktarın ve ardından bir Update-Help komutu çalıştırın.
Update-Help parametresiz çalıştırın veya modül adını belirtmek için Module parametresini kullanın.
ve Update-Help cmdlet'lerinin Save-Help parametresi, 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.