Příkaz Get-Help: Syntaxe, parametry, příklady

26. dubna 2021 1256 Pohledy pomoc powershell

Procházet témata příspěvků

Úvod

Nevíte, jak používat rutinu PowerShell? Rutina Get-Help PowerShell vám poskytne informace o jakémkoli příkazu powerShell.

V této příručce se dozvíte, jak používat rutinu PowerShell Get-Help. Jeho syntaxe, parametry a některé příklady.

Syntaxe příkazu Powershell Get-Help

Zjednodušená syntaxe Powershell Get-Help je:

|_+_| Některé parametry rutiny Powershell Get-Help nejsou výše zobrazeny. Uvedl jsem pouze parametry, které budete potřebovat pro každodenní použití. Rutina Get-Help může poskytnout informace nápovědy PowerShellu pro rutiny, funkce, příkazy CIM, pracovní postupy, poskytovatele, aliasy a skripty.

Powershell Get-Help parametry

Níže uvedená tabulka uvádí parametry zobrazené v poslední části a jejich význam. Obsahuje také příklady. Podrobné příklady viz Příklady dále v průvodci.

S/N Parametr Význam Příklad Get-Help Powershell
jedennázevUrčuje název rutiny, funkce, skriptu, pracovního postupu, poskytovatele nebo aliasuGet-Help -Name Get-Command
dvaParametrPoužívá se k zadání parametru rutiny, pro kterou potřebujete získat nápověduGet-Help -Name Get-Command -Název parametru
3PříkladyTento parametr nevyžaduje vstupní hodnotu. Pokud je zadáno, Get-Help vrátí příklady pro rutinuGet-Help -Name Get-Command -Příklady
4KategorieZobrazí nápovědu pouze pro položky v zadané kategorii a jejich aliasy. Některé akceptované hodnoty: Alias, Cmdlet atdGet-Help -Alias ​​kategorie
5PlnýZobrazí celé téma nápovědy pro rutinu, včetně parametrů, atributů a příkladůGet-Help Get-Command -Full
6DetailníPřidá popisy parametrů a příklady do základního zobrazení nápovědy.Get-Help Get-Command -Podrobné
7onlineOtevře online verzi tématu nápovědy ve výchozím internetovém prohlížečiGet-Help Get-Command -Online

Příklady Get-Help Powershell

Zde je několik příkladů rutiny Get-Help pro PowerShell. V této části použiji Get-Help k získání informací o rutině Get-Command.

Powershell Get-Help Příklad 1: Základní nápověda Powershell

Chcete-li získat základní informace nápovědy o rutině Get-Command, spusťte následující příkaz:

|_+_|

V tomto příkladu je rutina Get-Command . Všimněte si, že jsem nezahrnul parametr -Name. Nemusí to být zahrnuto. Zde je výsledek příkazu v PowerShellu.

Get-Help Příklad 1: Základní nápověda Powershell:

Příkaz se vrátil SYNOPSE (popis rutiny), jeho SYNTAX (jak používat rutinu) a její POPIS (podrobné informace o rutině).

Powershell Get-Help Příklad 2: Podrobná a úplná nápověda Powershell

Chcete-li zobrazit podrobnější informace o rutině, jednoduše zahrňte Detailní parametr. Zde je upravený příklad.

|_+_|

Když zahrnete Detailní parametr, Get-Help přidává popisy parametrů a příklady k základním informacím nápovědy PowerShellu.

Get-Help Příklad 2: Podrobná nápověda PowershellVětšina informací není na předchozím obrázku zobrazena.

Pokud navíc chcete zobrazit úplné informace nápovědy o rutině, použijte Plný parametr.

Zde je ukázkový příkaz:

|_+_|

Powershell Get-Help Příklad 3: Online nápověda Powershell

Pokud chcete, aby Get-Help otevřela online nápovědu pro rutinu, použijte online parametr. Get-Help otevře informace nápovědy pro rutinu pomocí vašeho výchozího prohlížeče.

Zde je příkaz k zobrazení online informací pro rutinu Get-Command.

|_+_|

Zde je výsledek. Otevřeno v Chrome (můj výchozí prohlížeč):

Get-Help Get-Command -Online

Powershell Get-Help Příklad 4: Kategorie Nápověda Powershell

Příkaz Get-Help má parametr nazvaný Kategorie . Toto můžete použít k získání informací nápovědy o kterékoli z následujících kategorií:

Alias, Rutina, Poskytovatel, Obecné, Časté dotazy, Slovník, Soubor nápovědy, Příkaz Script, Funkce, Filtr, ExternalScript, Vše, VýchozíHelp, Pracovní postup, DscResource, Třída a konfigurace

Jednou z velmi užitečných aplikací je zobrazení úplného seznamu aliasů všech rutin PowerShell ve vašem počítači.

Zde je příkaz:

|_+_|

A výsledek…

Použití aliasů rutiny zkracuje skript. Až budete příště skriptovat, můžete získat aliasy rutin pomocí příkazu výše.

V jiném příkladu, chcete-li vrátit VŠECHNY rutiny ve vašem počítači, použijte příkaz níže:

|_+_|

Pokud potřebujete konkrétní rutiny, můžete je vrátit pomocí rutiny Where-Object.

Například vrátit příkazy začínající slovy Co , použijte příkaz níže

|_+_|

To vrátí rutiny blízko tomu, co chci. Podívejte se na výsledky níže:

Get-Help -Kategorie rutina Where-Object Synopse -To se mi líbí

Powershell Get-Help Příklad 5: Získejte příklady rutiny

Jednou z výhod příkazu Powershell Get-Help je, že vám může poskytnout příklady, jak používat rutinu.

Chcete-li zobrazit příklady použití příkazu Get-Command, použijte následující příkaz:

|_+_|

Příkaz zobrazí všechny dostupné příklady:

Get-Help Get-Command -Příklady

Závěr

Doufám, že vám tato příručka zjednodušila používání Powershell Get-Help. A co je nejdůležitější, doufám, že jste si vybrali jednu nebo dvě věci, které potřebujete k napsání dalšího skriptu PowerShell.

Máte-li jakékoli dotazy nebo připomínky, použijte formulář Zanechat odpověď na konci této stránky. Můžete se také podělit o své osobní zkušenosti s PowerShell.

Chcete-li se o powershell dozvědět více, navštivte naši stránku PowerShell . Můžete také vyhledat PowerShell a zobrazit seznam všech našich příruček PowerShell.

Další užitečné příručky

  • 18 nejužitečnějších příkazů Powershell pro správce Windows
  • Jak naplánovat automatické spouštění skriptu PowerShellu na serveru Windows

Další zdroje a reference