Get-Help
PowerShell のコマンドと概念に関する情報を表示します。
構文
Get-Help
[[-Name] <String>]
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[-Full]
[<CommonParameters>]Get-Help
[[-Name] <String>]
-Detailed
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]Get-Help
[[-Name] <String>]
-Examples
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]Get-Help
[[-Name] <String>]
-Parameter <String>
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]Get-Help
[[-Name] <String>]
-Online
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<CommonParameters>]Get-Help
[[-Name] <String>]
-ShowWindow
[-Path <String>]
[-Category <String[]>]
[-Component <String[]>]
[-Functionality <String[]>]
[-Role <String[]>]
[<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」と入力します。
help または manを入力して、一度に 1 画面のテキストを表示することもできます。 または、<cmdlet-name> -?、Get-Helpと同じですが、コマンドレットでのみ機能します。
Get-Help は、コンピューター上のヘルプ ファイルから表示されるヘルプ コンテンツを取得します。 ヘルプ ファイルがない場合、Get-Help にはコマンドレットに関する基本情報のみが表示されます。 一部の PowerShell モジュールには、ヘルプ ファイルが含まれています。 PowerShell 3.0 以降、Windows オペレーティング システムに付属するモジュールにはヘルプ ファイルは含まれません。 PowerShell 3.0 でモジュールのヘルプ ファイルをダウンロードまたは更新するには、Update-Help コマンドレットを使用します。
Microsoft Docs で PowerShell ヘルプ ドキュメントをオンラインで表示することもできます。ヘルプ ファイルのオンライン バージョンを取得するには、Get-Help Get-Process -Onlineなど、Online パラメーターを使用します。 すべての PowerShell ドキュメントを読むには、Microsoft Docs PowerShell ドキュメントを参照してください。
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を参照してください。
必須 や 位置などのパラメーター属性については、about_Parametersを参照してください。
手記
PowerShell 3.0 と PowerShell 4.0 では、モジュールが現在のセッションにインポートされていない限り、Get-Help に関する記事がモジュールに見つかりません。 これは既知の問題です。 モジュール 記事を取得するには、Import-Module コマンドレットを使用するか、モジュールに含まれているコマンドレットを実行して、モジュールをインポートします。
例
例 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 -Paging
help は、コマンドレット 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 パラメーターには、パラメーターの説明、例、入力オブジェクトと出力オブジェクトの種類、その他のメモを含むヘルプ記事の完全なビューが表示されます。
詳細 および 完全な パラメーターは、コンピューターにヘルプ ファイルがインストールされているコマンドに対してのみ有効です。 パラメーターは、概念 (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 パラメーターには、指定したパラメーターの説明のみが表示されます。 アスタリスク (*) ワイルドカード文字のみを指定すると、すべてのパラメーターの説明が表示されます。
これらのパラメーターは、概念 (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-Clixml
Get-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: プロバイダー固有のヘルプを表示する
この例では、Get-Itemのプロバイダー固有のヘルプを取得する 2 つの方法を示します。 これらのコマンドは、PowerShell SQL Server プロバイダーの DataCollection ノードで Get-Item コマンドレットを使用する方法を説明するヘルプを取得します。
最初の例では、Get-HelpPath パラメーターを使用して、SQL Server プロバイダーのパスを指定します。
プロバイダーのパスが指定されているため、任意のパスの場所からコマンドを実行できます。
2 番目の例では、Set-Location を使用して SQL Server プロバイダーのパスに移動します。 その場所から、Get-Help がプロバイダー固有のヘルプを取得するために、Path パラメーターは必要ありません。
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 カテゴリにあります。
このパラメーターに使用できる値は次のとおりです。
- 別名
- コマンドレット
- 供給者
- 全般
- FAQ
- 用語集
- HelpFile
- ScriptCommand
- 機能
- フィルター
- ExternalScript
- すべての
- DefaultHelp
- ワークフロー
- DscResource
- クラス
- 構成
| 型: | String[] |
| 指定可能な値: | Alias, Cmdlet, Provider, General, FAQ, Glossary, HelpFile, ScriptCommand, Function, Filter, ExternalScript, All, DefaultHelp, Workflow, DscResource, Class, Configuration |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Component
Exchangeなど、指定したコンポーネント値を持つコマンドを表示します。 コンポーネント名を入力します。 ワイルドカード文字を使用できます。 このパラメーターは、概念 (About_) ヘルプの表示には影響しません。
| 型: | String[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | True |
-Detailed
基本的なヘルプ表示にパラメーターの説明と例を追加します。 このパラメーターは、ヘルプ ファイルがコンピューターにインストールされている場合にのみ有効です。 概念 (About_) ヘルプの表示には影響しません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | False |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Examples
名前、概要、および例のみを表示します。 例のみを表示するには、「(Get-Help \<cmdlet-name\>).Examples」と入力します。
このパラメーターは、ヘルプ ファイルがコンピューターにインストールされている場合にのみ有効です。 概念 (About_) ヘルプの表示には影響しません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | False |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Full
コマンドレットのヘルプ記事全体を表示します。 完全な には、パラメーターの説明と属性、例、入力オブジェクトと出力オブジェクトの種類、および追加のメモが含まれています。
このパラメーターは、ヘルプ ファイルがコンピューターにインストールされている場合にのみ有効です。 概念 (About_) ヘルプの表示には影響しません。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Functionality
指定した機能を持つアイテムのヘルプを表示します。 機能を入力します。 ワイルドカード文字を使用できます。 このパラメーターは、概念 (About_) ヘルプの表示には影響しません。
| 型: | String[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | True |
-Name
指定したコマンドまたは概念に関するヘルプを取得します。 コマンドレット、関数、プロバイダー、スクリプト、またはワークフローの名前 (Get-Memberなど)、概念的な記事名 (about_Objectsなど)、またはエイリアス (lsなど) を入力します。 ワイルドカード文字はコマンドレット名とプロバイダー名で使用できますが、ワイルドカード文字を使用して関数ヘルプとスクリプト ヘルプ記事の名前を検索することはできません。
$env:Path 環境変数にリストされているパスにないスクリプトのヘルプを表示するには、スクリプトのパスとファイル名を入力します。
ヘルプ記事の正確な名前を入力すると、Get-Help 記事の内容が表示されます。
複数のヘルプ記事タイトルに表示される単語または単語パターンを入力すると、Get-Help 一致するタイトルの一覧が表示されます。
ヘルプ記事のタイトルと一致しない単語を入力すると、Get-Help その単語を内容に含む記事の一覧が表示されます。
about_Objectsなどの概念記事の名前は、英語以外のバージョンの PowerShell でも英語で入力する必要があります。
| 型: | String |
| 配置: | 0 |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | True |
-Online
既定のブラウザーにヘルプ記事のオンライン バージョンを表示します。 このパラメーターは、コマンドレット、関数、ワークフロー、スクリプトのヘルプ記事でのみ有効です。 リモート セッションの Get-Help で Online パラメーターを使用することはできません。
作成したヘルプ記事でこの機能をサポートする方法の詳細については、「about_Comment_Based_Help」および「オンライン ヘルプ のサポート」および「の PowerShell コマンドレットのヘルプの作成」を参照してください。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | False |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Parameter
指定されたパラメーターの詳細な説明のみを表示します。 ワイルドカードを使用できます。 このパラメーターは、概念 (About_) ヘルプの表示には影響しません。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | True |
-Path
指定したプロバイダー パスでのコマンドレットの動作を説明するヘルプを取得します。 PowerShell プロバイダーのパスを入力します。
このパラメーターは、指定された PowerShell プロバイダー パスでのコマンドレットの動作を説明するコマンドレット ヘルプ記事のカスタマイズされたバージョンを取得します。 このパラメーターは、プロバイダー コマンドレットに関するヘルプに対してのみ有効であり、プロバイダーのヘルプ ファイルにプロバイダー コマンドレットのヘルプ記事のカスタム バージョンが含まれている場合にのみ有効です。 このパラメーターを使用するには、プロバイダーを含むモジュールのヘルプ ファイルをインストールします。
プロバイダー パスのカスタム コマンドレット ヘルプを表示するには、プロバイダー パスの場所に移動し、Get-Help コマンドを入力するか、任意のパスの場所から、Get-Help の Path パラメーターを使用してプロバイダー パスを指定します。 カスタム コマンドレット ヘルプは、ヘルプ記事のプロバイダー ヘルプ セクションでオンラインで見つけることもできます。
PowerShell プロバイダーの詳細については、「about_Providers」を参照してください。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | True |
-Role
指定したユーザー ロールに合わせてカスタマイズされたヘルプを表示します。 ロールを入力します。 ワイルドカード文字を使用できます。
組織でユーザーが果たす役割を入力します。 一部のコマンドレットでは、このパラメーターの値に基づいて、ヘルプ ファイルに異なるテキストが表示されます。 このパラメーターは、コア コマンドレットのヘルプには影響しません。
| 型: | String[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | True |
-ShowWindow
読みやすくするために、ヘルプ トピックをウィンドウに表示します。 このウィンドウには、検索 検索機能と、ヘルプ トピックの選択したセクションのみを表示するオプションなど、表示のオプションを設定できる [設定] ボックスが含まれています。
ShowWindow パラメーターは、コマンド (コマンドレット、関数、CIM コマンド、ワークフロー、スクリプト) と概念に関する 記事のヘルプ トピックをサポートします。 プロバイダーのヘルプはサポートされていません。
このパラメーターは PowerShell 3.0 で導入されました。
| 型: | SwitchParameter |
| 配置: | Named |
| 規定値: | False |
| 必須: | True |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
None
パイプラインの下にオブジェクトを送信して Get-Helpすることはできません。
出力
ExtendedCmdletHelpInfo
ヘルプ ファイルがないコマンドで Get-Help を実行すると、Get-Help は自動生成されたヘルプを表す ExtendedCmdletHelpInfo オブジェクトを返します。
概念的なヘルプ記事が表示された場合、Get-Help は文字列として返します。
MamlCommandHelpInfo
ヘルプ ファイルを含むコマンドを取得した場合、Get-Help は MamlCommandHelpInfo オブジェクトを返します。
メモ
PowerShell 3.0 にはヘルプ ファイルは含まれません。 読み取り Get-Help ヘルプ ファイルをダウンロードしてインストールするには、Update-Help コマンドレットを使用します。
Update-Help コマンドレットを使用すると、PowerShell に付属するコア コマンドと、インストールするモジュールのヘルプ ファイルをダウンロードしてインストールできます。 また、それを使用して、コンピューター上のヘルプが古くならなかったようにヘルプ ファイルを更新することもできます。
PowerShell オンラインに付属するコマンドに関するヘルプ記事は、「Windows PowerShellの概要」から参照することもできます。
Get-Help は、Windows オペレーティング システムのロケール セットまたはそのロケールのフォールバック言語でヘルプを表示します。 プライマリ ロケールまたはフォールバック ロケールのヘルプ ファイルがない場合、Get-Help はコンピューターにヘルプ ファイルがないかのように動作します。 別のロケールのヘルプを表示するには、コントロール パネルの Region と Language を使用して設定を変更します。 Windows 10 では、設定、時間 & 言語。
ヘルプの完全なビューには、パラメーターに関する情報のテーブルが含まれています。 この表には、次のフィールドが含まれています。
必須。 パラメーターが必須 (true) か省略可能 (false) かを示します。
位置. パラメーターが名前付きか位置指定 (数値) かを示します。 位置指定パラメーターは、コマンド内の指定した場所に指定する必要があります。
名前付き は、パラメーター名は必須ですが、パラメーターはコマンド内の任意の場所に表示できることを示します。
数値 は、パラメーター名が省略可能であることを示しますが、名前を省略する場合は、数値で指定された場所にパラメーターを指定する必要があります。 たとえば、
2は、パラメーター名を省略した場合、パラメーターはコマンドの 2 番目または唯一の名前のないパラメーターである必要があることを示します。 パラメーター名を使用すると、コマンド内の任意の場所にパラメーターを指定できます。既定値。 コマンドにパラメーターを含めない場合に PowerShell で使用されるパラメーター値または既定の動作。
パイプライン入力を受け入れます。 パイプラインを介してパラメーターにオブジェクトを送信できるかどうかを示します (true) か、または (false) 送信できません。 プロパティ名 は、パイプライン オブジェクトにパラメーター名と同じ名前のプロパティが必要であることを意味します。
ワイルドカード文字を受け入れます。 パラメーターの値に、アスタリスク (
*) や疑問符 (?) などのワイルドカード文字を含めることができるかどうかを示します。