Get-Help
PowerShell のコマンドと概念に関する情報を表示します。
構文
Get-Help
[[-Name] <String>]
[-Path <String>]
[-Category <String[]>]
[-Full]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]Get-Help
[[-Name] <String>]
[-Path <String>]
[-Category <String[]>]
-Detailed
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]Get-Help
[[-Name] <String>]
[-Path <String>]
[-Category <String[]>]
-Examples
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]Get-Help
[[-Name] <String>]
[-Path <String>]
[-Category <String[]>]
-Parameter <String[]>
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]Get-Help
[[-Name] <String>]
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
-Online
[<CommonParameters>]Get-Help
[[-Name] <String>]
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
-ShowWindow
[<CommonParameters>]説明
コマンドレットには Get-Help 、コマンドレット、関数、共通情報モデル (CIM) コマンド、ワークフロー、プロバイダー、エイリアス、スクリプトなど、PowerShell の概念とコマンドに関する情報が表示されます。
PowerShell コマンドレットのヘルプを表示するには、「」と入力し、その後にコマンドレット名 (例: ) を入力 Get-Help します Get-Help Get-Process。
PowerShell の概念的なヘルプ記事は、about_Comparison_Operatorsなどのabout_から始まります。 すべての about_ 記事を表示するには、「」と入力します Get-Help about_*。 特定の記事を表示するには、 などGet-Help about_Comparison_Operatorsと入力しますGet-Help about_<article-name>。
PowerShell プロバイダーのヘルプを表示するには、「」と入力し、その後にプロバイダー名を入力 Get-Help します。 たとえば、証明書プロバイダーのヘルプを表示するには、「」と入力します Get-Help Certificate。
または を入力helpmanして、一度に 1 つの画面のテキストを表示することもできます。 または、 <cmdlet-name> -?と同じです Get-Helpが、コマンドレットでのみ機能します。
Get-Help は、コンピューター上のヘルプ ファイルから表示されるヘルプ コンテンツを取得します。 ヘルプ ファイルがない場合は、 Get-Help コマンドレットに関する基本情報のみが表示されます。 一部の PowerShell モジュールには、ヘルプ ファイルが含まれています。 PowerShell 3.0 以降、Windows オペレーティング システムに付属するモジュールにはヘルプ ファイルは含まれていません。 PowerShell 3.0 でモジュールのヘルプ ファイルをダウンロードまたは更新するには、 コマンドレットを使用します Update-Help 。
PowerShell ヘルプ ドキュメントをオンラインで表示することもできます。 ヘルプ ファイルのオンライン バージョンを取得するには、 Online パラメーター (例: ) を使用します Get-Help Get-Process -Online。
「」と入力し、その後にヘルプ記事の正確な名前を入力するか、ヘルプ記事に固有の単語を入力 Get-Help すると、 Get-Help その記事の内容が表示されます。 コマンド エイリアスの正確な名前を指定すると、 Get-Help 元のコマンドのヘルプが表示されます。 いくつかのヘルプ記事のタイトルに表示される単語または単語パターンを入力すると、 Get-Help 一致するタイトルの一覧が表示されます。 ヘルプ記事のタイトルに表示されないテキストを入力すると、 Get-Help そのテキストを内容に含む記事の一覧が表示されます。
Get-Help では、サポートされているすべての言語とロケールに関するヘルプ記事を入手できます。 Get-Help最初に、Windows 用に設定されたロケールでヘルプ ファイルを検索し、次に pt-BR の場合は pt などの親ロケールで、次にフォールバック ロケールで検索します。 PowerShell 3.0 以降では、フォールバック ロケールでヘルプが見つからない場合 Get-Help は、エラー メッセージを返すか自動生成されたヘルプを表示する前に、英語 ( en-US) でヘルプ記事を検索します。
コマンド構文図に表示される Get-Help シンボルの詳細については、「 about_Command_Syntax」を参照してください。 Required や Position などのパラメーター属性の詳細については、「about_Parameters」を参照してください。
注意
PowerShell 3.0 と PowerShell 4.0 では、 Get-Help モジュールが現在のセッションにインポートされていない限り、モジュールの About 記事が見つかりません。 モジュールの About 記事を取得するには、 コマンドレットを使用するか、モジュールに Import-Module 含まれているコマンドレットを実行してモジュールをインポートします。
PSReadLine v2.2.2 以降では、コマンド ラインでコマンドを入力するときに役立つ簡単なアクセスを提供する 2 つの関数がモジュールに付属しています。 ヘルプは、ページングのある代替画面バッファーのターミナルに表示されます。
F1 キーを押すと、PSReadLineShowCommandHelp 関数は、カーソルの左側に最も近いコマンドレット名を呼び出Get-Help -Fullします。 カーソルがパラメーターのすぐ左側にある場合、関数は完全なヘルプ トピックでそのパラメーターの説明にジャンプします。 Q キーを押してヘルプ ビューを終了すると、同じカーソル位置にあるコマンド ラインに戻り、コマンドの入力を続けることができます。
キーの組み合わせ Alt+h を使用すると、 PSReadLineShowParameterHelp 関数は、カーソルのすぐ左側にパラメーターのヘルプ情報を表示します。 コマンド ラインの下にヘルプ テキストが表示されます。 これにより、 パラメーターの説明を確認し、コマンドの入力を続けることができます。
詳細については、「 動的ヘルプの使用」を参照してください。
例
例 1: コマンドレットに関する基本的なヘルプ情報を表示する
これらの例では、 コマンドレットに関する基本的なヘルプ情報を Format-Table 表示します。
Get-Help Format-Table
Get-Help -Name Format-Table
Format-Table -?Get-Help <cmdlet-name> は、コマンドレットの最も単純で既定の Get-Help 構文です。 Name パラメーターは省略できます。
構文 <cmdlet-name> -? はコマンドレットに対してのみ機能します。
例 2: 基本情報を一度に 1 ページずつ表示する
これらの例では、コマンドレットに関する基本的なヘルプ情報を Format-Table 1 ページずつ表示します。
help Format-Table
man Format-Table
Get-Help Format-Table | Out-Host -Paginghelp は、コマンドレットを内部的に実行 Get-Help し、結果を一度に 1 ページずつ表示する関数です。
man は 関数の help エイリアスです。
Get-Help Format-Table は、オブジェクトをパイプラインの下に送信します。 Out-Host -Paging はパイプラインから出力を受信し、一度に 1 ページずつ表示します。 詳細については、「 Out-Host」を参照してください。
例 3: コマンドレットの詳細情報を表示する
これらの例では、 コマンドレットに関するより詳細なヘルプ情報を Format-Table 表示します。
Get-Help Format-Table -Detailed
Get-Help Format-Table -FullDetailed パラメーターには、パラメーターの説明と例を含むヘルプ記事の詳細ビューが表示されます。
Full パラメーターには、パラメーターの説明、例、入力オブジェクトと出力オブジェクトの種類、その他のメモを含むヘルプ記事の完全なビューが表示されます。
Detailed パラメーターと Full パラメーターは、コンピューターにヘルプ ファイルがインストールされているコマンドに対してのみ有効です。 パラメーターは、概念 (about_) ヘルプ記事には有効ではありません。
例 4: パラメーターを使用してコマンドレットの選択した部分を表示する
これらの例では、コマンドレット ヘルプの選択した部分を Format-Table 表示します。
Get-Help Format-Table -Examples
Get-Help Format-Table -Parameter *
Get-Help Format-Table -Parameter GroupByExamples パラメーターには、ヘルプ ファイルの NAME セクションと SYNOPSIS セクション、およびすべての例が表示されます。 Examples パラメーターは switch パラメーターであるため、Example 番号を指定できません。
Parameter パラメーターには、指定したパラメーターの説明のみが表示されます。 アスタリスク (*) ワイルドカード文字のみを指定すると、すべてのパラメーターの説明が表示されます。
Parameter がGroupBy などのパラメーター名を指定すると、そのパラメーターに関する情報が表示されます。
これらのパラメーターは、概念 (about_) のヘルプ記事には有効ではありません。
例 5: オンライン バージョンのヘルプを表示する
次の使用例は、既定の Web ブラウザーにコマンドレットのオンライン バージョンのヘルプ記事 Format-Table を表示します。
Get-Help Format-Table -Online例 6: ヘルプ システムに関するヘルプを表示する
パラメーターのないコマンドレットには Get-Help 、PowerShell ヘルプ システムに関する情報が表示されます。
Get-Help例 7: 使用可能なヘルプ記事を表示する
次の使用例は、コンピューターで利用可能なすべてのヘルプ記事の一覧を表示します。
Get-Help *例 8: 概念記事の一覧を表示する
次の使用例は、PowerShell ヘルプに含まれる概念的な記事の一覧を表示します。 これらの記事はすべて、 about_文字で始まります。 特定のヘルプ ファイルを表示するには、「」と入力します Get-Help \<about_article-name\>(例: Get-Help about_Signing)。
コンピューターにヘルプ ファイルがインストールされている概念記事のみが表示されます。 PowerShell 3.0 でのヘルプ ファイルのダウンロードとインストールの詳細については、「 Update-Help」を参照してください。
Get-Help about_*例 9: コマンドレット ヘルプで単語を検索する
この例では、コマンドレットヘルプ記事で単語を検索する方法を示します。
Get-Help Add-Member -Full | Out-String -Stream | Select-String -Pattern Clixml
the Export-Clixml cmdlet to save the instance of the object, including the additional members...
can use the Import-Clixml cmdlet to re-create the instance of the object from the information...
Export-Clixml
Import-ClixmlGet-Help のヘルプ情報を取得するには、 Full パラメーターを Add-Member使用します。 MamlCommandHelpInfo オブジェクトがパイプラインに送信されます。 Out-String では、 Stream パラメーターを使用してオブジェクトを文字列に変換します。 Select-String は Pattern パラメーターを使用して 、Clixml の文字列を検索します。
例 10: 単語を含む記事の一覧を表示する
次の使用例は、 リモート処理という単語を含む記事の一覧を表示します。
記事のタイトルに表示されない単語を入力すると、 Get-Help その単語を含む記事の一覧が表示されます。
Get-Help -Name remoting
Name Category Module Synopsis
---- -------- ------ --------
Install-PowerShellRemoting.ps1 External Install-PowerShellRemoting.ps1
Disable-PSRemoting Cmdlet Microsoft.PowerShell.Core Prevents remote users...
Enable-PSRemoting Cmdlet Microsoft.PowerShell.Core Configures the computer...例 11: プロバイダー固有のヘルプを表示する
この例では、 のプロバイダー固有のヘルプを取得する 2 つの方法を Get-Item示します。 これらのコマンドは、PowerShell SQL Server プロバイダーの DataCollection ノードで コマンドレットを使用Get-Itemする方法を説明するヘルプを取得します。
最初の例では、Path パラメーターをGet-Help使用して、SQL Server プロバイダーのパスを指定します。
プロバイダーのパスが指定されているため、任意のパスの場所からコマンドを実行できます。
2 番目の例では、 を使用Set-Locationして、SQL Server プロバイダーのパスに移動します。 その場所から、プロバイダー固有のヘルプを取得するために Path パラメーターは必要 Get-Help ありません。
Get-Help Get-Item -Path SQLSERVER:\DataCollection
NAME
Get-Item
SYNOPSIS
Gets a collection of Server objects for the local computer and any computers
to which you have made a SQL Server PowerShell connection.
...
Set-Location SQLSERVER:\DataCollection
SQLSERVER:\DataCollection> Get-Help Get-Item
NAME
Get-Item
SYNOPSIS
Gets a collection of Server objects for the local computer and any computers
to which you have made a SQL Server PowerShell connection.
...例 12: スクリプトのヘルプを表示する
この例では、 のヘルプを取得します MyScript.ps1 script。 関数とスクリプトのヘルプを記述する方法については、「 about_Comment_Based_Help」を参照してください。
Get-Help -Name C:\PS-Test\MyScript.ps1パラメーター
-Category
指定したカテゴリの項目とそのエイリアスに対してのみヘルプを表示します。 概念に関する記事は 、HelpFile カテゴリにあります。
このパラメーターに使用できる値は次のとおりです。
- エイリアス
- コマンドレット
- プロバイダー
- 全般
- よく寄せられる質問
- 用語集
- HelpFile
- ScriptCommand
- 機能
- フィルター
- ExternalScript
- All
- DefaultHelp
- ワークフロー
- DscResource
- クラス
- 構成
| Type: | String[] |
| Accepted values: | Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Component
Exchange など、指定したコンポーネント値を持つコマンドを表示します。 コンポーネント名を入力します。 ワイルドカード文字を使用できます。 このパラメーターは、概念 (About_) ヘルプの表示には影響しません。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Detailed
基本的なヘルプの表示に加えてパラメーターの説明と例を表示します。 このパラメーターは、ヘルプ ファイルがコンピューターにインストールされている場合にのみ有効です。 概念 (About_) ヘルプの表示には影響しません。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Examples
名前、概要、例のみを表示します。 This parameter is effective only when the help files are installed on the computer. It has no effect on displays of conceptual (About_) help.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Full
コマンドレットのヘルプ記事全体を表示します。 完全には 、パラメーターの説明と属性、例、入力オブジェクトと出力オブジェクトの種類、追加のメモが含まれます。
This parameter is effective only when the help files are installed on the computer. It has no effect on displays of conceptual (About_) help.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Functionality
指定した機能を持つ項目のヘルプを表示します。 機能を入力します。 ワイルドカード文字を使用できます。 This parameter has no effect on displays of conceptual (About_) help.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Name
指定したコマンドまたは概念に関するヘルプを取得します。 コマンドレット、関数、プロバイダー、スクリプト、またはワークフローの名前 (例: Get-Member)、概念的なアーティクル名 ( など about_Objects)、または エイリアス ( など ls) を入力します。 コマンドレット名とプロバイダー名ではワイルドカード文字を使用できますが、ワイルドカード文字を使用して関数ヘルプとスクリプト ヘルプの記事の名前を検索することはできません。
環境変数に一覧表示 $env:Path されているパスにないスクリプトのヘルプを表示するには、スクリプトのパスとファイル名を入力します。
ヘルプ記事の正確な名前を入力すると、 Get-Help 記事の内容が表示されます。
いくつかのヘルプ記事のタイトルに表示される単語または単語パターンを入力すると、 Get-Help 一致するタイトルの一覧が表示されます。
ヘルプ記事のタイトルと一致しないテキストを入力すると、 Get-Help そのテキストを内容に含む記事の一覧が表示されます。
などの about_Objects概念記事の名前は、英語以外のバージョンの PowerShell でも英語で入力する必要があります。
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-Online
既定のブラウザーにヘルプ記事のオンライン バージョンを表示します。 このパラメーターは、コマンドレット、関数、ワークフロー、スクリプトのヘルプ記事に対してのみ有効です。 リモート セッションでは、 で Online パラメーター Get-Help を使用することはできません。
作成するヘルプ記事でこの機能をサポートする方法については、「 about_Comment_Based_Help」および「 オンライン ヘルプのサポート」および 「PowerShell コマンドレットのヘルプの作成」を参照してください。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Parameter
指定したパラメーターの詳しい説明のみを表示します。 ワイルドカードを使用できます。 This parameter has no effect on displays of conceptual (About_) help.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Path
指定されたプロバイダー パスでのコマンドレットの動作を説明するヘルプを取得します。 PowerShell プロバイダー パスを入力します。
このパラメーターは、指定された PowerShell プロバイダー パスでのコマンドレットの動作を説明するコマンドレットヘルプ記事のカスタマイズされたバージョンを取得します。 このパラメーターは、プロバイダー コマンドレットに関するヘルプでのみ有効であり、プロバイダーのヘルプ ファイルにプロバイダー コマンドレットヘルプ記事のカスタム バージョンが含まれている場合にのみ有効です。 このパラメーターを使用するには、プロバイダーが含まれるモジュールのヘルプ ファイルをインストールします。
プロバイダー パスのカスタム コマンドレット ヘルプを表示するには、プロバイダー パスの場所に移動し、コマンドをGet-Help入力するか、任意のパスのGet-Help場所から Path パラメーターを使用してプロバイダー パスを指定します。 カスタム コマンドレットのヘルプは、ヘルプ記事のプロバイダー ヘルプ セクションでも確認できます。
PowerShell プロバイダーの詳細については、「 about_Providers」を参照してください。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Role
指定したユーザー ロール向けにカスタマイズされたヘルプを表示します。 ロールを入力します。 ワイルドカード文字を使用できます。
組織においてユーザーが果たすロールを入力します。 一部のコマンドレットでは、このパラメーターの値に基づいて、ヘルプ ファイルに異なるテキストが表示されます。 このパラメーターは、コア コマンドレットのヘルプには効果を持ちません。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ShowWindow
読みやすくするために、ウィンドウにヘルプ トピックを表示します。 このウィンドウには、[ 検索機能の検索 ] と [設定] ボックスが含まれており、ヘルプ トピックの選択したセクションのみを表示するオプションなど、表示のオプションを設定できます。
ShowWindow パラメーターは、コマンド (コマンドレット、関数、CIM コマンド、スクリプト) および概念に関する記事のヘルプ トピックをサポートしています。 プロバイダーのヘルプはサポートされていません。
このパラメーターは PowerShell 7.0 で再導入されました。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
None
オブジェクトをこのコマンドレットにパイプすることはできません。
出力
ExtendedCmdletHelpInfo
ヘルプ ファイルがないコマンドで を実行 Get-Help すると、 Get-Help 自動生成されたヘルプを表す ExtendedCmdletHelpInfo オブジェクトが返されます。
概念的なヘルプ記事が表示された場合は、 Get-Help それを文字列として返します。
MamlCommandHelpInfo
ヘルプ ファイルを含むコマンドを取得した場合は、 Get-HelpMamlCommandHelpInfo オブジェクトを返します。
メモ
PowerShell 3.0 にはヘルプ ファイルは含まれていません。 読み取るヘルプ ファイル Get-Help をダウンロードしてインストールするには、 コマンドレットを Update-Help 使用します。 コマンドレットを Update-Help 使用して、PowerShell に付属するコア コマンドと、インストールするモジュールのヘルプ ファイルをダウンロードしてインストールできます。 また、このコマンドレットを使用してヘルプ ファイルを更新して、コンピューター上のヘルプを最新に保つこともできます。
PowerShell オンラインに付属するコマンドに関するヘルプ記事は、Windows PowerShellを使用したはじめにから参照することもできます。
Get-Help では、Windows オペレーティング システムのロケール セットまたはそのロケールのフォールバック言語にヘルプが表示されます。 プライマリ ロケールまたはフォールバック ロケールのヘルプ ファイルがない場合、 は、 Get-Help コンピューターにヘルプ ファイルがないかのように動作します。 別のロケールのヘルプを表示するには、コントロール パネルの [地域と言語] を使用して設定を変更します。 Windows 10以降では、[設定]、[時刻&言語] です。
ヘルプの完全なビューには、パラメーターに関する情報のテーブルが含まれています。 この表には、次のフィールドが含まれます。
[必須] 。 パラメーターが必須 (true) であるか省略可能 (false) であるかを示します。
位置。 パラメーターの名前を指定するか、位置指定 (数値) を指定するかを示します。 位置指定パラメーターは、コマンド内の特定の場所に指定する必要があります。
[名前付き ] は、パラメーター名は必須ですが、パラメーターはコマンド内の任意の場所に表示できることを示します。
数値 はパラメーター名が省略可能であることを示しますが、名前を省略する場合は、数値で指定された場所にパラメーターを指定する必要があります。 たとえば、 は、
2パラメーター名を省略する場合、パラメーターがコマンドの 2 番目または唯一の名前のないパラメーターである必要があることを示します。 パラメーター名を使用する場合は、コマンド内の任意の場所にパラメーターを指定できます。既定値。 コマンドに パラメーターを含めない場合に PowerShell で使用されるパラメーター値または既定の動作。
パイプライン入力を受け入れます。 パイプラインを介してオブジェクトをパラメーターに送信できるかどうかを示します (true)。 プロパティ名で 指定すると、パイプライン オブジェクトにはパラメーター名と同じ名前のプロパティが必要です。
ワイルドカード文字を受け入れます。 パラメーターの値に、アスタリスク () や疑問符
?(*) などのワイルドカード文字を含めることができるかどうかを示します。
関連リンク
フィードバック
フィードバックの送信と表示