Get-Command

構文

Get-Command
   [-Verb <String[]>]
   [-Noun <String[]>]
   [-Module <String[]>]
   [-FullyQualifiedModule <ModuleSpecification[]>]
   [-TotalCount <Int32>]
   [-Syntax]
   [-ShowCommandInfo]
   [[-ArgumentList] <Object[]>]
   [-All]
   [-ListImported]
   [-ParameterName <String[]>]
   [-ParameterType <PSTypeName[]>]
   [<CommonParameters>]

Get-Command
   [[-Name] <String[]>]
   [-Module <String[]>]
   [-FullyQualifiedModule <ModuleSpecification[]>]
   [-CommandType <CommandTypes>]
   [-TotalCount <Int32>]
   [-Syntax]
   [-ShowCommandInfo]
   [[-ArgumentList] <Object[]>]
   [-All]
   [-ListImported]
   [-ParameterName <String[]>]
   [-ParameterType <PSTypeName[]>]
   [-UseFuzzyMatching]
   [-FuzzyMinimumDistance <UInt32>]
   [-UseAbbreviationExpansion]
   [<CommonParameters>]

説明

Get-Command コマンドレットは、コマンドレット、エイリアス、関数、フィルター、スクリプト、アプリケーションなど、コンピューターにインストールされているすべてのコマンドを取得します。 Get-Command は、他のセッションからインポートされた PowerShell モジュールとコマンドからコマンドを取得します。 現在のセッションにインポートされたコマンドのみを取得するには、 ListImported パラメーターを使用します。

パラメーターがない場合、 Get-Command はコンピューターにインストールされているすべてのコマンドレット、関数、エイリアスを取得します。 Get-Command * は、Path 環境変数 ($env:Path) 内のすべての PowerShell 以外のファイルを含む、すべての種類のコマンドを取得します。このファイルは Application コマンドの種類で一覧表示されます。

Get-Command コマンドの正確な名前を使用する場合は、ワイルドカード文字を使用せずに、コマンドを含むモジュールが自動的にインポートされ、コマンドをすぐに使用できるようになります。 モジュールの自動インポートを有効、無効、および構成するには、 $PSModuleAutoLoadingPreference 基本設定変数を使用します。 詳細については、「 about_Preference_Variables」を参照してください。

Get-Command は、ヘルプ トピックから情報を取得する Get-Help とは異なり、コマンド コードからデータを直接取得します。

Windows PowerShell 5.0 以降、 Get-Command コマンドレットの結果には、既定で Version 列が表示されます。 新しい Version プロパティが CommandInfo クラスに追加されました。

例

例 1: コマンドレット、関数、エイリアスを取得する

このコマンドは、コンピューターにインストールされている PowerShell コマンドレット、関数、およびエイリアスを取得します。

Get-Command

例 2: 現在のセッションでコマンドを取得する

このコマンドは、 ListImported パラメーターを使用して、現在のセッションのコマンドのみを取得します。

Get-Command -ListImported

例 3: コマンドレットを取得して順番に表示する

このコマンドは、すべてのコマンドレットを取得し、それらをコマンドレット名内の名詞によるアルファベット順で並べ替え、その後、名詞に基づくグループとして表示します。 この表示は、タスクのコマンドレットの検索に役立ちます。

Get-Command -Type Cmdlet | Sort-Object -Property Noun | Format-Table -GroupBy Noun

例 4: モジュール内のコマンドを取得する

このコマンドでは、 Module パラメーターを使用して、Microsoft.PowerShell.Security および Microsoft.PowerShell.Utility モジュールのコマンドを取得します。

Get-Command -Module Microsoft.PowerShell.Security, Microsoft.PowerShell.Utility

例 5: コマンドレットに関する情報を取得する

このコマンドは、 Get-AppLockerPolicy コマンドレットに関する情報を取得します。 また、 AppLocker モジュールもインポートされ、 AppLocker モジュール内のすべてのコマンドが現在のセッションに追加されます。

Get-Command Get-AppLockerPolicy

モジュールが自動的にインポートされる場合、その効果は Import-Module コマンドレットの使用と同じです。 モジュールは、コマンド、型、および書式設定ファイルを追加し、セッションでスクリプトを実行できます。 モジュールの自動インポートを有効、無効、および構成するには、 $PSModuleAutoLoadingPreference 基本設定変数を使用します。 詳細については、「 about_Preference_Variables」を参照してください。

例 6: コマンドレットの構文を取得する

このコマンドでは、 ArgumentList パラメーターと Syntax パラメーターを使用して、Cert: ドライブで使用される Get-ChildItem コマンドレットの構文を取得します。 Cert: ドライブは、証明書プロバイダーがセッションに追加する PowerShell ドライブです。

Get-Command  -Name Get-Childitem -Args Cert: -Syntax

出力に表示される構文を、Args (ArgumentList) パラメーターを省略したときに表示される構文と比較すると、Certificate プロバイダーcodeSigningCert という動的 パラメーターがGet-ChildItemコマンドレットに追加されます。

証明書プロバイダーの詳細については、「 about_Certificate_Provider」を参照してください。

例 7: 動的パラメーターを取得する

この例のコマンドでは、 Get-DynamicParameters 関数を使用して、証明書プロバイダーが Cert: ドライブで使用するときに Get-ChildItem コマンドレットに追加する動的パラメーターを取得します。

function Get-DynamicParameters
{
    param ($Cmdlet, $PSDrive)
    (Get-Command -Name $Cmdlet -ArgumentList $PSDrive).ParameterSets |
      ForEach-Object {$_.Parameters} |
        Where-Object { $_.IsDynamic } |
          Select-Object -Property Name -Unique
}
Get-DynamicParameters -Cmdlet Get-ChildItem -PSDrive Cert:

Name
----
CodeSigningCert

この例の Get-DynamicParameters 関数は、コマンドレットの動的パラメーターを取得します。 これは、前の例で使用されたメソッドの代替です。 動的パラメーターは、別のコマンドレットまたはプロバイダーによって、コマンドレットに追加できます。

例 8: すべての種類のすべてのコマンドを取得する

このコマンドは、 Path 環境変数 ($env:path) のパス内の実行可能ファイルを含め、ローカル コンピューター上のすべての種類のすべてのコマンドを取得します。

Get-Command *

FileInfo オブジェクト (System.IO.FileInfo) ではなく、各ファイルの ApplicationInfo オブジェクト (System.Management.Automation.ApplicationInfo) を返します。

例 9: パラメーター名と型を使用してコマンドレットを取得する

このコマンドは、名前にAuthが含まれており、その型がauthenticationMechanismパラメーターを持つコマンドレットを取得します。

Get-Command -ParameterName *Auth* -ParameterType AuthenticationMechanism

ユーザーの認証に使用されるメソッドを指定するためのコマンドレットを検索するために、次のようなコマンドを使用できます。

ParameterType パラメーターは、AuthenticationMechanism 値を受け取るパラメーターと、AuthenticationLevel パラメーターを受け取るパラメーターを区別します。これらのパラメーターの名前が似ている場合でも同様です。

例 10: エイリアスを取得する

この例では、エイリアスで Get-Command コマンドレットを使用する方法を示します。

Get-Command -Name dir

CommandType     Name                                               ModuleName
-----------     ----                                               ----------
Alias           dir -> Get-ChildItem

通常はコマンドレットと関数で使用されますが、 Get-Command はスクリプト、関数、エイリアス、実行可能ファイルも取得します。

コマンドの出力には、エイリアスの Name プロパティ値の特別なビューが表示されます。 この表示は、エイリアスとコマンドのフルネームを示しています。

例 11: エイリアスから構文を取得する

この例では、エイリアスの標準名と共に構文を取得する方法を示します。

コマンドの出力には、標準名と構文が続くラベル付きのエイリアスが表示されます。

Get-Command -Name dir -Syntax

dir (alias) -> Get-ChildItem

dir [[-Path] <string[]>] [[-Filter] <string>] [-Include <string[]>] [-Exclude <string[]>] [-Recurse] [-Depth <uint>] [-Force] [-Name] [-Attributes <FlagsExpression[FileAttributes]>] [-FollowSymlink] [-Directory] [-File] [-Hidden] [-ReadOnly] [-System] [<CommonParameters>]

dir [[-Filter] <string>] -LiteralPath <string[]> [-Include <string[]>] [-Exclude <string[]>] [-Recurse] [-Depth <uint>] [-Force] [-Name] [-Attributes <FlagsExpression[FileAttributes]>] [-FollowSymlink] [-Directory] [-File] [-Hidden] [-ReadOnly] [-System] [<CommonParameters>]

例 12: メモ帳コマンドのすべてのインスタンスを取得する

この例では、Get-Command コマンドレットの All パラメーターを使用して、ローカル コンピューター上の Notepad コマンドのすべてのインスタンスを表示します。

Get-Command Notepad -All | Format-Table CommandType, Name, Definition

CommandType     Name           Definition
-----------     ----           ----------
Application     notepad.exe    C:\WINDOWS\system32\notepad.exe
Application     NOTEPAD.EXE    C:\WINDOWS\NOTEPAD.EXE

All パラメーターは、セッション内に同じ名前のコマンドが複数ある場合に便利です。

Windows PowerShell 3.0 以降では、セッションに同じ名前のコマンドが複数含まれている場合、 Get-Command はコマンド名を入力したときに実行されるコマンドのみを取得します。 All パラメーターを使用すると、Get-Commandは、指定した名前のすべてのコマンドを取得し、実行の優先順位で返します。 一覧で最初のコマンドではなく、他のコマンドを実行するには、コマンドへの完全修飾パスを入力します。

コマンドの優先順位の詳細については、 about_Command_Precedenceを参照してください。

例 13: コマンドレットを含むモジュールの名前を取得する

このコマンドは、 Get-Date コマンドレットが発生したモジュールの名前を取得します。 このコマンドでは、すべてのコマンドの ModuleName プロパティを使用します。

(Get-Command Get-Date).ModuleName

Microsoft.PowerShell.Utility

このコマンド形式は、セッションにインポートされていない場合でも、PowerShell モジュールのコマンドで機能します。

例 14: 出力の種類を持つコマンドレットと関数を取得する

Get-Command -Type Cmdlet | Where-Object OutputType | Format-List -Property Name, OutputType

このコマンドは、出力の種類とオブジェクトの種類を返す、コマンドレットと関数を取得します。

コマンドの最初の部分は、すべてのコマンドレットを取得します。 パイプライン演算子 (|) は、 Where-Object コマンドレットにコマンドレットを送信し、 OutputType プロパティが設定されているもののみを選択します。 別のパイプライン演算子は、選択したコマンドレット オブジェクトを Format-List コマンドレットに送信し、各コマンドレットの名前と出力の種類を一覧に表示します。

CommandInfo オブジェクトの OutputType プロパティには、コマンドレット コードでコマンドレットの OutputType 属性が定義されている場合にのみ null 以外の値があります。

例 15: 特定のオブジェクトの種類を入力として受け取るコマンドレットを取得する

Get-Command -ParameterType (((Get-NetAdapter)[0]).PSTypeNames)

CommandType     Name                                               ModuleName
-----------     ----                                               ----------
Function        Disable-NetAdapter                                 NetAdapter
Function        Enable-NetAdapter                                  NetAdapter
Function        Rename-NetAdapter                                  NetAdapter
Function        Restart-NetAdapter                                 NetAdapter
Function        Set-NetAdapter                                     NetAdapter

このコマンドは、ネット アダプター オブジェクトを入力として受け取るコマンドレットを検索します。 このコマンド形式を使用して、いずれかのコマンドによって返されるオブジェクトの種類を受け取るコマンドレットを検索できます。

このコマンドは、すべてのオブジェクトの PSTypeNames 組み込みプロパティを使用します。このプロパティは、オブジェクトを記述する型を取得します。 net アダプターのコレクションの PSTypeNames プロパティではなく、net アダプターの PSTypeNames プロパティを取得するには、コマンドは配列表記を使用して、コマンドレットが返す最初のネット アダプターを取得します。

例 16: あいまい一致を使用してコマンドを取得する

この例では、コマンドの名前に意図的に "get-commnd" という入力ミスがあります。 コマンドレットは、 -UseFuzzyMatching スイッチを使用して、最適な一致が Get-Command され、その後にシステム上の同様の一致する他のネイティブ コマンドが続いていると判断しました。

Get-Command get-commnd -UseFuzzyMatching

CommandType     Name                                               Version    Source
-----------     ----                                               -------    ------
Cmdlet          Get-Command                                        6.2.0.0    Microsoft.PowerShell.Core
Application     getconf                                            0.0.0.0    /usr/bin/getconf
Application     command                                            0.0.0.0    /usr/bin/command

パラメーター

-All

-ArgumentList

-CommandType

-FullyQualifiedModule

-FuzzyMinimumDistance

-ListImported

-Module

-Name

-Noun

-ParameterName

-ParameterType

-ShowCommandInfo

-Syntax

-TotalCount

-UseAbbreviationExpansion

-UseFuzzyMatching

-Verb

入力

String

コマンド名をこのコマンドレットにパイプできます。

出力

CommandInfo

このコマンドレットは、 CommandInfo クラスから派生したオブジェクトを返します。 返されるオブジェクトの種類は、 Get-Command 取得するコマンドの種類によって異なります。

AliasInfo

エイリアスを表します。

ApplicationInfo

アプリケーションとファイルを表します。

CmdletInfo

コマンドレットを表します。

FunctionInfo

関数とフィルターを表します。

メモ

PowerShell には、 Get-Commandの次のエイリアスが含まれています。

• すべてのプラットフォーム:

  • gcm

• 同じ名前の複数のコマンドをセッションで使用できる場合、 Get-Command はコマンド名を入力したときに実行されるコマンドを返します。 同じ名前のコマンドを実行順序で取得するには、 All パラメーターを使用します。 詳細については、「about_Command_Precedence」(コマンドの優先順位について) を参照してください。

• モジュールが自動的にインポートされる場合、効果は Import-Module コマンドレットの使用と同じです。 モジュールは、コマンド、型、および書式設定ファイルを追加し、セッションでスクリプトを実行できます。 モジュールの自動インポートを有効、無効、および構成するには、 $PSModuleAutoLoadingPreference 基本設定変数を使用します。 詳細については、「 about_Preference_Variables」を参照してください。

関連リンク

• Export-PSSession
• Get-Help
• Get-Member
• Get-PSDrive
• Import-PSSession
• about_Command_Precedence