Get-ItemProperty
指定した項目のプロパティを取得します。
構文
Get-ItemProperty
[-Path] <String[]>
[[-Name] <String[]>]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-UseTransaction]
[<CommonParameters>]
Get-ItemProperty
-LiteralPath <String[]>
[[-Name] <String[]>]
[-Filter <String>]
[-Include <String[]>]
[-Exclude <String[]>]
[-Credential <PSCredential>]
[-UseTransaction]
[<CommonParameters>]
説明
Get-ItemProperty
コマンドレットは、指定した項目のプロパティを取得します。
たとえば、このコマンドレットを使用して、ファイル オブジェクトの LastAccessTime プロパティの値を取得できます。
このコマンドレットを使用して、レジストリ エントリとその値を表示することもできます。
例
例 1: 特定のディレクトリに関する情報を取得する
このコマンドは、"C:\Windows" ディレクトリに関する情報を取得します。
Get-ItemProperty C:\Windows
例 2: 特定のファイルのプロパティを取得する
このコマンドは、「C:\Test\Weather.xls」ファイルのプロパティを取得します。
結果は、出力を一覧として表示するために、Format-List
コマンドレットにパイプされます。
Get-ItemProperty C:\Test\Weather.xls | Format-List
例 3: レジストリ サブキー内のレジストリ エントリの値の名前とデータを表示する
このコマンドは、"CurrentVersion" レジストリ サブキーに含まれる各レジストリ エントリの値の名前とデータを表示します。
このコマンドでは、レジストリの "HKEY_LOCAL_MACHINE" ハイブにマップされている HKLM:
という名前の PowerShell ドライブが必要であることに注意してください。
その名前とマッピングを持つドライブは、既定で PowerShell で使用できます。
または、プロバイダー名の後に 2 つのコロンが続く次の代替パスを使用して、このレジストリ サブキーへのパスを指定できます。
"レジストリ::HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion"。
Get-ItemProperty -Path HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
例 4: レジストリ サブキー内のレジストリ エントリの値の名前とデータを取得する
このコマンドは、"CurrentVersion" レジストリ サブキーの "ProgramFilesDir" レジストリ エントリの値の名前とデータを取得します。 このコマンドでは、 Path パラメーターを使用してサブキーを指定し、Name パラメーターを使用してエントリの値の名前を指定します。
このコマンドでは、PowerShell の継続文字であるバック クォートまたはグレーブ アクセント (') を使用して、2 行目からコマンドを続行します。
Get-ItemProperty -Path HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion -Name "ProgramFilesDir"
例 5: レジストリ キー内のレジストリ エントリの値の名前とデータを取得する
このコマンドは、"PowerShellEngine" レジストリ キー内のレジストリ エントリの値の名前とデータを取得します。 結果を次の出力例に示します。
Get-ItemProperty -Path HKLM:\SOFTWARE\Microsoft\PowerShell\1\PowerShellEngine
ApplicationBase : C:\Windows\system32\WindowsPowerShell\v1.0\
ConsoleHostAssemblyName : Microsoft.PowerShell.ConsoleHost, Version=1.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, ProcessorArchitecture=msil
PowerShellVersion : 2.0
RuntimeVersion : v2.0.50727
CTPVersion : 5
PSCompatibleVersion : 1.0,2.0
例 6: レジストリ値とデータの結果を取得、書式設定、表示する
この例では、リスト内の Get-ItemProperty
コマンドの出力を書式設定して、レジストリ値とデータを簡単に確認し、結果を解釈しやすくする方法を示します。
最初のコマンドでは、 Get-ItemProperty
コマンドレットを使用して、 Microsoft.PowerShell サブキーのレジストリ エントリを取得します。
このサブキーには、PowerShell の既定のシェルのオプションが格納されます。
結果を次の出力例に示します。
出力は、"Path" と "ExecutionPolicy" の 2 つのレジストリ エントリがあることを示しています。 レジストリ キーに含まれるエントリが 5 つ未満の場合、既定ではテーブルに表示されますが、多くの場合、リストに表示する方が簡単です。
2 番目のコマンドでは、同じ Get-ItemProperty
コマンドを使用します。
ただし、今回は、コマンドはパイプライン演算子 (|
) を使用して、コマンドの結果を Format-List
コマンドレットに送信します。
Format-List
コマンドは、値 '*' (all) の Property パラメータを使用して、リスト内のオブジェクトのすべてのプロパティを表示します。
結果を次の出力例に示します。
結果の表示には、"Path" レジストリ エントリと "ExecutionPolicy" レジストリ エントリと、レジストリ キー オブジェクトのあまり馴染みのないプロパティがいくつか表示されます。 PS というプレフィックスが付いたその他のプロパティは、レジストリ キーを表すオブジェクトなど、PowerShell カスタム オブジェクトのプロパティです。
Get-ItemProperty -Path HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\Microsoft.PowerShell
Path ExecutionPolicy
---- ---------------
C:\Windows\system32\WindowsPowerShell\v1.0\powershell.exe RemoteSigned
Get-ItemProperty -Path HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\Microsoft.PowerShell | Format-List -Property *
PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\Software\Microsoft\PowerShell\1\ShellIds\Micro
soft.PowerShell
PSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\Software\Microsoft\PowerShell\1\ShellIds
PSChildName : Microsoft.PowerShell
PSDrive : HKLM
PSProvider : Microsoft.PowerShell.Core\Registry
Path : C:\Windows\system32\WindowsPowerShell\v1.0\powershell.exe
ExecutionPolicy : RemoteSigned
パラメーター
-Credential
このアクションを実行するアクセス許可を持つユーザー アカウントを指定します。 既定値は現在のユーザーです。
"User01" や "Domain01\User01" などのユーザー名を入力するか、PSCredential オブジェクト (Get-Credential
コマンドレットによって生成されたものなど) を入力します。
ユーザー名を入力すると、パスワードの入力を求められます。
Warnung
このパラメーターは、Windows PowerShell でインストールされているプロバイダーではサポートされていません。
型: | PSCredential |
配置: | Named |
規定値: | Current user |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Exclude
文字列配列として、このコマンドレットが操作から除外する項目を指定します。 このパラメーターの値は、Path パラメーターを修飾します。 "*.txt" などのパス要素またはパターンを入力します。 ワイルドカード文字を使用できます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Filter
プロバイダーの形式または言語でフィルターを指定します。 このパラメーターの値は、Path パラメーターを修飾します。
ワイルドカード文字の使用を含むフィルターの構文は、プロバイダーによって異なります。 フィルターは、取得後に PowerShell でオブジェクトをフィルター処理するのではなく、コマンドレットがオブジェクトを取得するときにプロバイダーによって適用されるため、他のパラメーターよりも効率的です。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-Include
文字列配列として、このコマンドレットが操作に含める項目を指定します。 このパラメーターの値は、Path パラメーターを修飾します。 "*.txt" などのパス要素またはパターンを入力します。 ワイルドカード文字を使用できます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-LiteralPath
プロパティの現在の場所へのパスを指定します。 Path パラメーターとは異なり、LiteralPath の値は、型指定されたとおりに使用されます。 ワイルドカードとして解釈される文字はありません。 パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。 単一引用符は、エスケープ シーケンスとして文字を解釈しないように PowerShell に指示します。
型: | String[] |
Aliases: | PSPath |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
取得するプロパティの名前を指定します。
型: | String[] |
Aliases: | PSProperty |
配置: | 1 |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Path
項目または項目へのパスを指定します。
型: | String[] |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-UseTransaction
アクティブなトランザクションにコマンドを含みます。 このパラメーターは、トランザクションが進行中の場合にのみ有効です。 詳細については、アクティブなトランザクションにコマンドを組み込むを参照してください。 このパラメーターは、トランザクションが進行中の場合にのみ有効です。 詳細については、about_Transactionsを参照してください。
型: | SwitchParameter |
Aliases: | usetx |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
入力
パスを含む文字列を Get-ItemProperty
にパイプ処理できます。
出力
System.Boolean, System.String, System.DateTime
Get-ItemProperty
取得した各 item プロパティのオブジェクトを返します。
オブジェクトの種類は、取得されるオブジェクトによって異なります。
たとえば、ファイル システム ドライブでは、ファイルまたはフォルダーが返される場合があります。
メモ
Get-ItemProperty
コマンドレットは、任意のプロバイダーによって公開されるデータを操作するように設計されています。 セッションで使用可能なプロバイダーを一覧表示するには、「Get-PSProvider
」と入力します。 詳細については、「about_Providers」を参照してください。