Get-ItemProperty
指定した項目のプロパティを取得します。
構文
Get-ItemProperty [-LiteralPath] <string[]> [[-Name] <string[]>] [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Include <string[]>] [-UseTransaction] [<CommonParameters>]
Get-ItemProperty [-Path] <string[]> [[-Name] <string[]>] [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Include <string[]>] [-UseTransaction] [<CommonParameters>]
説明
Get-ItemProperty コマンドレットは、指定した項目のプロパティを取得します。たとえば、Get-ItemProperty を使用すると、ファイル オブジェクトの LastAccessTime プロパティの値を取得できます。さらに、Get-ItemProperty を使用してレジストリ エントリおよびそれらの値を表示することもできます。
パラメーター
-Credential <PSCredential>
この処理を実行するアクセス許可を持つユーザー アカウントを指定します。既定値は現在のユーザーです。
"User01" や "Domain01\User01" のようなユーザー名を入力するか、Get-Credential コマンドレットで生成されるような PSCredential オブジェクトを入力します。ユーザー名を入力すると、パスワードの入力を促すメッセージが表示されます。
このパラメーターは、Windows PowerShell でインストールされるプロバイダーではサポートされていません。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
true (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-Exclude <string[]>
指定した項目を除外します。ワイルドカードを使用できます。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Filter <string>
プロバイダーの形式や言語でフィルターを指定します。このパラメーターの値は、Path パラメーターを修飾します。ワイルドカードを使用できるかどうかなど、フィルターの構文はプロバイダーによって異なります。フィルターは他のパラメーターよりも効率が良い方法です。これは、オブジェクトを取得した後に Windows PowerShell がオブジェクトをフィルターするのではなく、オブジェクトを取得する際にプロバイダーがフィルターを適用するためです。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Include <string[]>
指定した項目を処理対象に含めます。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-LiteralPath <string[]>
項目プロパティへのパスを指定します。LiteralPath の値は、入力した内容のまま使用されます。ワイルドカードとして解釈される文字はありません。パスにエスケープ文字が含まれている場合は、単一引用符で囲みます。単一引用符で囲んだ文字はエスケープ シーケンスとして解釈されません。
必須 |
true |
位置 |
1 |
既定値 |
|
パイプライン入力を許可する |
true (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-Name <string[]>
取得するプロパティの名前を 1 つ以上指定します。
必須 |
false |
位置 |
2 |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Path <string[]>
項目のパスを 1 つ以上指定します。
必須 |
true |
位置 |
1 |
既定値 |
|
パイプライン入力を許可する |
true (ByValue, ByPropertyName) |
ワイルドカード文字を許可する |
false |
-UseTransaction
コマンドを有効なトランザクションに含めます。このパラメーターは、トランザクションの進行中のみ有効です。詳細については、「about_Transactions」を参照してください。
必須 |
false |
位置 |
named |
既定値 |
|
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.
入力と出力
入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。
入力 |
System.String パイプを使用してパスを含む文字列を Get-ItemProperty に渡すことができます。 |
出力 |
Object Get-ItemProperty は、取得する各項目のプロパティのオブジェクトを返します。オブジェクトの型は、取得するオブジェクトによって異なります。 |
注
Get-ItemProperty コマンドレットは、プロバイダーによって公開されているデータを使用するように設計されています。セッションで使用可能なプロバイダーの一覧を表示するには、「Get-PSProvider」と入力します。詳細については、「about_Providers」を参照してください。
例 1
C:\PS>get-itemproperty C:\Windows
説明
-----------
このコマンドは、C:\Windows ディレクトリに関する情報を取得します。
例 2
C:\PS>get-itemproperty C:\Test\Weather.xls | format-list
説明
-----------
このコマンドは、C:\Test\Weather.xls ファイルのプロパティを取得します。結果は Format-List コマンドレットに対してパイプ処理され、一覧として表示されます。
例 3
C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion
説明
-----------
このコマンドを実行すると、レジストリ サブキー CurrentVersion に含まれている各レジストリ エントリの値名とデータが表示されます。このコマンドを実行するには、HKLM: という名前の Windows PowerShell ドライブがレジストリの HKEY_LOCAL_MACHINE ハイブにマッピングされている必要があります。この名前とマッピングを持つドライブは、Windows PowerShell では既定で使用可能です。また、プロバイダー名の後に 2 つのコロンを続けた以下の代替パスを使用して、このレジストリ サブキーのパスを指定することもできます。
Registry::HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion.
例 4
C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion `
-name "ProgramFilesDir"
説明
-----------
このコマンドは、レジストリ サブキー CurrentVersion に含まれているレジストリ エントリ ProgramFilesDir の値名とデータを取得します。また、Path パラメーターを使用してサブキーを、Name パラメーターを使用してエントリの値名を指定します。
例 5
C:\PS>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=31bf3856ad
364e35, ProcessorArchitecture=msil
PowerShellVersion : 2.0
RuntimeVersion : v2.0.50727
CTPVersion : 5
PSCompatibleVersion : 1.0,2.0
説明
-----------
このコマンドは、PowerShellEngine レジストリ キー内のレジストリ エントリの値名とデータを取得します。次のサンプル出力に結果を示します。
例 6
C:\PS>get-itemproperty -path HKLM:\SOFTWARE\Microsoft\PowerShell\1\ShellIds\Microsoft.PowerShell
Path ExecutionPolicy
---- ---------------
C:\Windows\system32\WindowsPowerShell\v1.0\powershell.exe RemoteSigned
C:\PS>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
説明DO NOT TRANSLATE
-----------
この例は、レジストリ値とデータ、および結果の解釈方法が見やすくなるように Get-ItemProperty コマンドの出力を一覧形式に書式設定する方法を示します。
最初のコマンドは、Get-ItemProperty コマンドレットを使用して Microsoft.PowerShell サブキーのレジストリ エントリを取得します。このサブキーには、Windows PowerShell の既定のシェルのオプションが格納されています。次のサンプル出力に結果を示します。
出力には、Path と ExecutionPolicy の 2 つのレジストリ エントリがあることが示されます。レジストリ キーに含まれるエントリが 5 つよりも少ない場合、既定では表形式で表示されますが、一覧に表示した方がわかりやすい場合が多々あります。
2 番目のコマンドも、同じ Get-ItemProperty コマンドレットを使用します。ただし、このコマンドではパイプライン演算子 (|) を使用してコマンドの結果を Format-List コマンドレットに送ります。Format-List コマンドは Property パラメーターに * (すべての値) を指定して、オブジェクトのすべてのプロパティを一覧に表示します。次のサンプル出力に結果を示します。
結果には、レジストリ キー オブジェクトのあまり知られていないいくつかのプロパティと共に Path および ExecutionPolicy レジストリ エントリが表示されます。プレフィックス "PS" の付いたその他のプロパティは、レジストリ キーを表すオブジェクトのように Windows PowerShell カスタム オブジェクトのプロパティです。
関連項目
概念
about_Providers
Set-ItemProperty
Clear-ItemProperty
Copy-ItemProperty
Move-ItemProperty
New-ItemProperty
Remove-ItemProperty
Rename-ItemProperty