Update-Help

Odwołanie

Moduł:: Microsoft.PowerShell.Core

Pobiera i instaluje najnowsze pliki pomocy na komputerze.

Składnia

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>]

Opis

Polecenie Update-Help cmdlet pobiera najnowsze pliki pomocy dla modułów programu PowerShell i instaluje je na komputerze. Nie musisz ponownie uruchamiać programu PowerShell, aby wprowadzić zmianę w życie. Możesz użyć Get-Help polecenia cmdlet , aby natychmiast wyświetlić nowe pliki pomocy.

Update-Help Sprawdza wersję plików pomocy na komputerze. Jeśli nie masz plików pomocy dla modułu lub jeśli pliki pomocy są nieaktualne, Update-Help pobierze najnowsze pliki pomocy. Pliki pomocy można pobrać i zainstalować z Internetu lub udziału plików.

Bez parametrów Update-Help aktualizuje pliki pomocy dla modułów, które obsługują pomoc z możliwością aktualizacji i są ładowane do sesji lub instalowane w lokalizacji zawartej $env:PSModulePathw pliku . Aby uzyskać więcej informacji, zobacz about_Updatable_Help.

Update-Help sprawdza wersję zainstalowanej pomocy. Jeśli Update-Help nie można odnaleźć zaktualizowanych plików pomocy dla modułu, będzie on kontynuowany w trybie dyskretnym bez wyświetlania komunikatu o błędzie. Użyj parametru Force , aby pominąć sprawdzanie wersji. Użyj parametru Verbose , aby wyświetlić szczegóły stanu i postępu. Użyj parametru Moduł, aby zaktualizować pliki pomocy dla określonego modułu.

Jeśli ustawienia kulturowe systemu operacyjnego są skonfigurowane dla języka, który nie jest dostępny do aktualizacji pomocy, Update-Help będzie kontynuowany w trybie dyskretnym bez pobierania żadnej pomocy. Użyj parametru UICulture , aby pobrać pliki pomocy w obsługiwanym języku. Pomoc jest zawsze dostępna dla en-US ustawień regionalnych.

Można również używać Update-Help na komputerach, które nie są połączone z Internetem. Najpierw użyj Save-Helppolecenia cmdlet , aby pobrać pliki pomocy z Internetu i zapisać je w folderze udostępnionym dostępnym dla systemu, który nie jest połączony z Internetem. Następnie użyj parametru SourcePath polecenia , Update-Help aby pobrać zaktualizowane pliki pomocy z udostępnionego pliku i zainstalować je na komputerze.

Polecenie Update-Help cmdlet zostało wprowadzone w programie Windows PowerShell 3.0.

Ważne

Update-Help wymaga uprawnień administracyjnych.

Aby zaktualizować pliki pomocy dla podstawowych modułów programu PowerShell, musisz być członkiem grupy Administratorzy na komputerze.

Aby pobrać lub zaktualizować pliki pomocy dla modułów w katalogu instalacyjnym programu PowerShell ($PSHOME\Modules), w tym moduły programu PowerShell Core, uruchom program PowerShell przy użyciu opcji Uruchom jako administrator . Na przykład: Start-Process powershell.exe -Verb RunAs.

Pliki pomocy można również zaktualizować przy użyciu elementu menu Update Windows PowerShell Help (Aktualizowanie programu Windows PowerShell) w menu Pomoc w zintegrowanym środowisku skryptów programu Windows PowerShell (ISE).

Element Pomocy programu Windows PowerShell update uruchamia Update-Help polecenie cmdlet bez parametrów. Aby zaktualizować pomoc dotyczącą modułów w $PSHOME katalogu, uruchom program Windows PowerShell ISE przy użyciu opcji Uruchom jako administrator.

Przykłady

Przykład 1. Aktualizowanie plików pomocy dla wszystkich modułów

Polecenie Update-Help cmdlet aktualizuje pliki pomocy dla zainstalowanych modułów, które obsługują aktualizowalną pomoc. Język kultury interfejsu użytkownika jest ustawiany w systemie operacyjnym.

Update-Help

Przykład 2. Aktualizowanie plików pomocy dla określonych modułów

Polecenie Update-Help cmdlet aktualizuje pliki pomocy tylko dla nazw modułów rozpoczynających się od programu Microsoft.PowerShell.

Update-Help -Module Microsoft.PowerShell*

Przykład 3. Aktualizowanie pomocy w systemie nie jest ustawione na ustawienia regionalne en-US

Polecenie cmdlet jest przeznaczone do pobierania Update-Help pomocy w wielu językach. Jeśli jednak nie ma dostępnej pomocy dla języka używanego przez system, nie powiedzie się w trybie dyskretnym, Update-Help chyba że używasz parametru UICulture .

W tym przykładzie Update-Help jest uruchamiany w systemie ustawionym en-GB na ustawienia regionalne.

Update-Help Microsoft.PowerShell.Utility -Force
Update-Help Microsoft.PowerShell.Utility -Force -UICulture en-GB

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}.
At line:1 char:1
+ Update-Help Microsoft.PowerShell.Utility -Force -UICulture en-GB
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidOperation: (:) [Update-Help], Exception
    + FullyQualifiedErrorId : HelpCultureNotSupported,Microsoft.PowerShell.Commands
   .UpdateHelpCommand

Pliki pomocy są zawsze publikowane dla en-US ustawień regionalnych. Aby pobrać pomoc języka angielskiego, uruchom polecenie Update-Help z parametrem UICulture i określ en-US ustawienia regionalne.

Przykład 4. Automatyczne aktualizowanie plików pomocy

W tym przykładzie jest tworzone zaplanowane zadanie, które aktualizuje pomoc dla wszystkich modułów codziennie o godzinie 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

Polecenie Register-ScheduledJob cmdlet tworzy zaplanowane zadanie, które uruchamia Update-Help polecenie. Polecenie używa parametru Credential do uruchomienia Update-Help przy użyciu poświadczeń członka grupy Administratorzy na komputerze. Wartość parametru Trigger to New-JobTrigger polecenie, które tworzy wyzwalacz zadania, który uruchamia zadanie codziennie o godzinie 3:00.

Aby uruchomić Register-ScheduledJob polecenie, uruchom program PowerShell przy użyciu opcji Uruchom jako administrator . Program PowerShell monituje o podanie hasła użytkownika określonego w parametrze Credential . Poświadczenia są przechowywane z zaplanowanym zadaniem. Po uruchomieniu zadania nie jest wyświetlany monit.

Możesz użyć Get-ScheduledJob polecenia cmdlet , aby wyświetlić zaplanowane zadanie, użyć Set-ScheduledJob polecenia cmdlet , aby go zmienić, i użyć Unregister-ScheduledJob polecenia cmdlet , aby go usunąć. Możesz również wyświetlać zaplanowane zadanie i zarządzać nim w harmonogramie zadań w następującej ścieżce:

Task Scheduler Library\Microsoft\Windows\PowerShell\ScheduledJobs.

Przykład 5. Aktualizowanie plików pomocy na wielu komputerach z udziału plików

W tym przykładzie zaktualizowane pliki pomocy są pobierane z Internetu i zapisywane w udziale plików. Wymagane są poświadczenia użytkownika, które mają uprawnienia dostępu do udziału plików i instalowania aktualizacji. Gdy jest używany udział plików, można zaktualizować komputery, które znajdują się za zaporami lub nie są połączone z Internetem.

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
}

Polecenie Save-Help pobiera najnowsze pliki pomocy dla wszystkich modułów obsługujących aktualizowalną pomoc. Parametr DestinationPath zapisuje pliki w \\Server01\Share\PSHelp udziale plików. Parametr Credential określa użytkownika, który ma uprawnienia dostępu do udziału plików.

Polecenie Invoke-Command cmdlet uruchamia polecenia zdalne Update-Help na wielu komputerach. Parametr ComputerName pobiera listę komputerów zdalnych z pliku Servers.txt . Parametr ScriptBlock uruchamia Update-Help polecenie i używa parametru SourcePath do określenia udziału plików zawierającego zaktualizowane pliki pomocy. Parametr Credential określa użytkownika, który może uzyskać dostęp do udziału plików i uruchomić zdalne Update-Help polecenie.

Przykład 6. Pobieranie listy zaktualizowanych plików pomocy

Polecenie Update-Help cmdlet aktualizuje pomoc dotyczącą określonego modułu. Polecenie cmdlet używa parametru Verbose common, aby wyświetlić listę zaktualizowanych plików pomocy. Możesz użyć pełnej funkcji , aby wyświetlić dane wyjściowe dla wszystkich plików pomocy lub plików pomocy dla określonego modułu.

Bez parametru Update-Help Verbose nie wyświetla wyników polecenia. Pełne dane wyjściowe parametru są przydatne do sprawdzania, czy pliki pomocy zostały zaktualizowane lub czy zainstalowano najnowszą wersję.

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

Przykład 7. Znajdowanie modułów obsługujących pomoc z możliwością aktualizowania

W tym przykładzie wymieniono moduły obsługujące pomoc z możliwością aktualizacji. Polecenie używa właściwości HelpInfoUri modułu do identyfikowania modułów obsługujących pomoc z możliwością aktualizowania. Właściwość HelpInfoUri zawiera adres URL, który jest przekierowywany po uruchomieniu Update-Help polecenia cmdlet.

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

Przykład 8. Spis zaktualizowanych plików pomocy

W tym przykładzie skrypt Get-UpdateHelpVersion.ps1 tworzy spis plików Pomocy z możliwością aktualizacji dla każdego modułu i ich numerów wersji.

Skrypt identyfikuje moduły, które obsługują aktualizowalną pomoc przy użyciu właściwości HelpInfoUri modułów. W przypadku modułów obsługujących pomoc z możliwością aktualizacji skrypt wyszukuje i analizuje plik informacji pomocy (*helpinfo.xml), aby znaleźć najnowszy numer wersji.

Skrypt używa klasy PSCustomObject i tabeli skrótów do utworzenia niestandardowego obiektu wyjściowego.

# 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

Parametry

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Typ:	SwitchParameter
Aliasy:	cf
Position:	Named
Domyślna wartość:	False
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Credential

Określa poświadczenia użytkownika, który ma uprawnienia dostępu do lokalizacji systemu plików określonej przez SourcePath. Ten parametr jest prawidłowy tylko wtedy, gdy parametr SourcePath lub LiteralPath jest używany w poleceniu .

Parametr Credential umożliwia uruchamianie Update-Help poleceń za pomocą parametru SourcePath na komputerach zdalnych. Podając jawne poświadczenia, można uruchomić polecenie na komputerze zdalnym i uzyskać dostęp do udziału plików na trzecim komputerze bez napotkania błędu odmowy dostępu lub uwierzytelniania CredSSP w celu delegowania poświadczeń.

Wpisz nazwę użytkownika, taką jak User01 lub Domain01\User01, lub wprowadź obiekt PSCredential wygenerowany przez Get-Credential polecenie cmdlet. Jeśli wpiszesz nazwę użytkownika, zostanie wyświetlony monit o wprowadzenie hasła.

Poświadczenia są przechowywane w obiekcie PSCredential , a hasło jest przechowywane jako secureString.

Uwaga

Aby uzyskać więcej informacji na temat ochrony danych SecureString , zobacz Jak bezpieczny jest protokół SecureString?.

Typ:	PSCredential
Position:	Named
Domyślna wartość:	Current user
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Force

Wskazuje, że to polecenie cmdlet nie jest zgodne z ograniczeniem raz dziennie, pomija sprawdzanie wersji i pobiera pliki, które przekraczają limit 1 GB.

Bez tego parametru Update-Help uruchamia się tylko raz w każdym 24-godzinnym okresie. Pliki do pobrania są ograniczone do 1 GB nieskompresowanej zawartości na moduł, a pliki pomocy są instalowane tylko wtedy, gdy są nowsze niż istniejące pliki na komputerze.

Limit raz dziennie chroni serwery hostujące pliki pomocy i sprawia, że można Update-Help dodać polecenie do profilu programu PowerShell bez ponoszenia kosztów zasobów powtarzających się połączeń lub pobierania.

Aby zaktualizować pomoc dotyczącą modułu w wielu kulturach interfejsu użytkownika bez parametru Force, uwzględnij wszystkie kultury interfejsu użytkownika w tym samym poleceniu, takie jak:

Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-FullyQualifiedModule

Wartość może być nazwą modułu, pełną specyfikacją modułu lub ścieżką do pliku modułu.

Gdy wartość jest ścieżką, ścieżka może być w pełni kwalifikowana lub względna. Ścieżka względna jest rozpoznawana względem skryptu zawierającego instrukcję using.

Gdy wartość jest nazwą lub specyfikacją modułu, program PowerShell przeszukuje element PSModulePath dla określonego modułu.

Specyfikacja modułu to tabela skrótu zawierająca następujące klucze.

ModuleName - Required Określa nazwę modułu.
GUID - Opcjonalnie Określa identyfikator GUID modułu.
Wymagane jest również określenie co najmniej jednego z trzech poniższych kluczy.
- ModuleVersion - Określa minimalną akceptowalną wersję modułu.
- MaximumVersion - Określa maksymalną akceptowalną wersję modułu.
- RequiredVersion - Określa dokładną, wymaganą wersję modułu. Nie można tego używać z innymi kluczami wersji.

Nie można określić parametru FullyQualifiedModule w tym samym poleceniu co parametr modułu.

Typ:	ModuleSpecification[]
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-LiteralPath

Określa folder dla zaktualizowanych plików pomocy zamiast pobierać je z Internetu. Użyj tego parametru lub parametru Save-Help SourcePath, jeśli użyto polecenia cmdlet do pobrania plików pomocy do katalogu.

Możesz potokować obiekt katalogu, taki jak z Get-Item poleceń cmdlet lub Get-ChildItem , do Update-Help.

W przeciwieństwie do wartości SourcePath wartość LiterałuPath jest używana dokładnie tak, jak jest typowana. Znaki nie są interpretowane jako symbole wieloznaczne. Jeśli ścieżka zawiera znaki ucieczki, należy ująć ją w pojedynczy cudzysłów. Pojedyncze znaki cudzysłowu informują program PowerShell, aby nie interpretował żadnych znaków jako sekwencji ucieczki.

Typ:	String[]
Aliasy:	PSPath
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Module

Pomoc dotycząca aktualizacji dla określonych modułów. Wprowadź co najmniej jedną nazwę modułu lub wzorce nazw na liście rozdzielanej przecinkami lub określ plik zawierający jedną nazwę modułu w każdym wierszu. Dozwolone są symbole wieloznaczne. Moduły potoku Get-Module można potokować z polecenia cmdlet do Update-Help polecenia cmdlet .

Określone moduły muszą być zainstalowane na komputerze, ale nie muszą być importowane do bieżącej sesji. Możesz określić dowolny moduł w sesji lub dowolny moduł zainstalowany w lokalizacji wymienionej w zmiennej środowiskowej $env:PSModulePath .

Wartość * (wszystkie) próbuje zaktualizować pomoc dla wszystkich modułów zainstalowanych na komputerze. Uwzględnione są moduły, które nie obsługują aktualizowalnej pomocy. Ta wartość może generować błędy, gdy polecenie napotka moduły, które nie obsługują aktualizowalnej pomocy. Zamiast tego uruchom polecenie Update-Help bez parametrów.

Parametr Update-Help Module polecenia cmdlet nie akceptuje pełnej ścieżki pliku modułu ani pliku manifestu modułu. Aby zaktualizować pomoc dotyczącą modułu, który nie znajduje się w $env:PSModulePath lokalizacji, zaimportuj moduł do bieżącej sesji przed uruchomieniem Update-Help polecenia.

Typ:	String[]
Aliasy:	Name
Position:	0
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	True

-Recurse

Wykonuje cykliczne wyszukiwanie plików pomocy w określonym katalogu. Ten parametr jest prawidłowy tylko wtedy, gdy polecenie używa parametru SourcePath .

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-SourcePath

Określa folder systemu plików, w którym Update-Help są aktualizowane pliki pomocy, zamiast pobierać je z Internetu. Wprowadź ścieżkę folderu. Nie należy określać nazwy pliku ani rozszerzenia nazwy pliku. Możesz potokować folder, taki jak jeden z Get-Item poleceń cmdlet lub Get-ChildItem , do Update-Help.

Domyślnie Update-Help pobiera zaktualizowane pliki pomocy z Internetu. Użyj metody SourcePath , gdy użyto Save-Help polecenia cmdlet, aby pobrać zaktualizowane pliki pomocy do katalogu.

Aby określić wartość domyślną dla metody SourcePath, przejdź do pozycji Zasady grupy, Konfiguracja komputera i Ustaw domyślną ścieżkę źródłową dla opcji Update-Help. To ustawienie zasad grupy uniemożliwia użytkownikom pobieranie Update-Help plików pomocy z Internetu. Aby uzyskać więcej informacji, zobacz temat Informacje o ustawieniach zasad grupy.

Typ:	String[]
Position:	1
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-UICulture

Określa wartości kultury interfejsu użytkownika używane Update-Help do uzyskiwania zaktualizowanych plików pomocy. Wprowadź co najmniej jeden kod języka, taki jak es-ES, zmienna zawierająca obiekty kultury lub polecenie, które pobiera obiekty kultury, takie jak Get-Culture polecenie lub Get-UICulture . Symbole wieloznaczne nie są dozwolone i nie można przesłać częściowego kodu języka, takiego jak de.

Domyślnie Update-Help pobiera pliki pomocy w kulturze interfejsu użytkownika ustawionej dla systemu operacyjnego. Jeśli określisz parametr UICulture, Update-Help poszukaj pomocy tylko dla określonej kultury interfejsu użytkownika.

Polecenia korzystające z parametru UICulture kończą się powodzeniem tylko wtedy, gdy moduł udostępnia pliki pomocy dla określonej kultury interfejsu użytkownika. Jeśli polecenie nie powiedzie się, ponieważ określona kultura interfejsu użytkownika nie jest obsługiwana, zostanie wyświetlony komunikat o błędzie.

Typ:	CultureInfo[]
Position:	2
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-UseDefaultCredentials

Wskazuje, że Update-Help uruchamia polecenie, w tym pobieranie z Internetu, przy użyciu poświadczeń bieżącego użytkownika. Domyślnie polecenie jest uruchamiane bez jawnych poświadczeń.

Ten parametr jest skuteczny tylko wtedy, gdy pobieranie internetowe używa nt LAN Manager (NTLM), negocjowania lub uwierzytelniania opartego na protokole Kerberos.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie jest uruchamiane.

Typ:	SwitchParameter
Aliasy:	wi
Position:	Named
Domyślna wartość:	False
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

Dane wejściowe

DirectoryInfo

Możesz przekazać do tego polecenia cmdlet obiekt ścieżki katalogu.

PSModuleInfo

Do tego polecenia cmdlet można przekazać obiekt modułu.

Dane wyjściowe

None

To polecenie cmdlet nie zwraca żadnych danych wyjściowych.

Uwagi

Aby zaktualizować pomoc dotyczącą podstawowych modułów programu PowerShell, które zawierają polecenia zainstalowane za pomocą programu PowerShell lub dowolnego modułu $PSHOME\Modules w katalogu, uruchom program PowerShell z opcją Uruchom jako administrator.

Tylko członkowie grupy Administratorzy na komputerze mogą zaktualizować pomoc dla podstawowych modułów programu PowerShell, poleceń zainstalowanych razem z programem PowerShell i modułów w folderze $PSHOME\Modules . Jeśli nie masz uprawnień do aktualizowania plików pomocy, możesz przeczytać pliki pomocy w trybie online. Na przykład Get-Help Update-Help -Online.

Moduły są najmniejszą jednostką aktualizowalnej pomocy. Nie można zaktualizować pomocy dla określonego polecenia cmdlet. Aby znaleźć moduł zawierający określone polecenie cmdlet, użyj właściwości ModuleName polecenia cmdlet, na przykład (Get-Command Update-Help).ModuleNameGet-Command .

Ponieważ pliki pomocy są instalowane w katalogu modułów, Update-Help polecenie cmdlet może zainstalować zaktualizowany plik pomocy tylko dla modułów zainstalowanych na komputerze. Jednak Save-Help polecenie cmdlet może zapisać pomoc dotyczącą modułów, które nie są zainstalowane na komputerze.

Polecenie Update-Help cmdlet zostało wprowadzone w programie Windows PowerShell 3.0. Nie działa we wcześniejszych wersjach programu PowerShell. Na komputerach z programem Windows PowerShell 2.0 i Windows PowerShell 3.0 użyj Update-Help polecenia cmdlet w sesji programu Windows PowerShell 3.0, aby pobrać i zaktualizować pliki pomocy. Pliki pomocy są dostępne zarówno dla programu Windows PowerShell 2.0, jak i programu Windows PowerShell 3.0.

Polecenia Update-Help cmdlet i Save-Help używają następujących portów do pobierania plików pomocy: Port 80 dla protokołu HTTP i port 443 dla protokołu HTTPS.

Update-Help obsługuje wszystkie moduły i podstawowe przystawki programu PowerShell. Nie obsługuje żadnych innych przystawek.

Aby zaktualizować pomoc dotyczącą modułu w lokalizacji, która nie znajduje się na liście w $env:PSModulePath zmiennej środowiskowej, zaimportuj moduł do bieżącej sesji, a następnie uruchom Update-Help polecenie. Uruchom polecenie Update-Help bez parametrów lub użyj parametru Moduł, aby określić nazwę modułu. Parametr Update-Help Module poleceń cmdlet i Save-Help nie akceptuje pełnej ścieżki pliku modułu ani pliku manifestu modułu.

Każdy moduł może obsługiwać pomoc z możliwością aktualizacji. Aby uzyskać instrukcje dotyczące obsługi aktualizowalnej pomocy w modułach, które tworzysz, zobacz Obsługa aktualizowalnej pomocy.

Polecenia Update-Help cmdlet i Save-Help nie są obsługiwane w środowisku preinstalacji systemu Windows (Windows PE).

Udostępnij za pośrednictwem

Update-Help

Składnia

Opis

Przykłady

Przykład 1. Aktualizowanie plików pomocy dla wszystkich modułów

Przykład 2. Aktualizowanie plików pomocy dla określonych modułów

Przykład 3. Aktualizowanie pomocy w systemie nie jest ustawione na ustawienia regionalne en-US

Przykład 4. Automatyczne aktualizowanie plików pomocy

Przykład 5. Aktualizowanie plików pomocy na wielu komputerach z udziału plików

Przykład 6. Pobieranie listy zaktualizowanych plików pomocy

Przykład 7. Znajdowanie modułów obsługujących pomoc z możliwością aktualizowania

Przykład 8. Spis zaktualizowanych plików pomocy

Parametry

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Dane wejściowe

Dane wyjściowe

Uwagi

Dodatkowe zasoby

Udostępnij za pośrednictwem

Update-Help

Składnia

Opis

Przykłady

Przykład 1. Aktualizowanie plików pomocy dla wszystkich modułów

Przykład 2. Aktualizowanie plików pomocy dla określonych modułów

Przykład 3. Aktualizowanie pomocy w systemie nie jest ustawione na ustawienia regionalne en-US

Przykład 4. Automatyczne aktualizowanie plików pomocy

Przykład 5. Aktualizowanie plików pomocy na wielu komputerach z udziału plików

Przykład 6. Pobieranie listy zaktualizowanych plików pomocy

Przykład 7. Znajdowanie modułów obsługujących pomoc z możliwością aktualizowania

Przykład 8. Spis zaktualizowanych plików pomocy

Parametry

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Dane wejściowe

Dane wyjściowe

Uwagi

Linki powiązane

Dodatkowe zasoby