about_Properties

簡単な説明

PowerShell でオブジェクト プロパティを使用する方法について説明します。

詳細な説明

PowerShell では、オブジェクトと呼ばれる情報の構造化コレクションを使用して、データ ストア内の項目またはコンピューターの状態を表します。 通常は、Microsoft .NET Framework の一部であるオブジェクトを操作しますが、PowerShell でカスタム オブジェクトを作成することもできます。

項目とそのオブジェクトの間の関連付けは非常に近いです。 オブジェクトを変更するときは、通常、オブジェクトが表す項目を変更します。 たとえば、PowerShell でファイルを取得しても、実際のファイルは取得されません。 代わりに、ファイルを 表す FileInfo オブジェクトを取得します。 FileInfo オブジェクトを変更すると、ファイルも変更されます。

ほとんどのオブジェクトにはプロパティがあります。 プロパティは、オブジェクトに関連付けられているデータです。 オブジェクトの種類によってプロパティが異なります。 たとえば、ファイルを表す FileInfo オブジェクトには IsReadOnly プロパティがあり、ファイルに読み取り専用属性があるかどうか、$False含まれていない場合に含まれます$Trueファイル システム ディレクトリを表す DirectoryInfo オブジェクトには、親ディレクトリへのパスを含む Parent プロパティがあります。

オブジェクトのプロパティ

オブジェクトのプロパティを取得するには、コマンドレットを Get-Member 使用します。 たとえば、FileInfo オブジェクトのプロパティを取得するには、コマンドレットをGet-ChildItem使用して、ファイルを表す FileInfo オブジェクトを取得します。 次に、パイプライン演算子 (|) を使用して FileInfo オブジェクトGet-Member送信します。 次のコマンドは、ファイルをpwsh.exe取得して .Get-Member 自動変数には $PSHOME 、PowerShell インストール ディレクトリのパスが含まれています。

Get-ChildItem $PSHOME\pwsh.exe | Get-Member

コマンドの出力には、FileInfo オブジェクトのメンバーが一覧表示されます。 メンバーには、プロパティとメソッドの両方が含まれます。 PowerShell で作業すると、オブジェクトのすべてのメンバーにアクセスできます。

メソッドではなくオブジェクトのプロパティのみを取得するには、次の例に示すように、コマンドレットの Get-Member MemberType パラメーターを値Propertyとして使用します。

Get-ChildItem $PSHOME\pwsh.exe | Get-Member -MemberType Property
TypeName: System.IO.FileInfo

Name              MemberType Definition
----              ---------- ----------
Attributes        Property   System.IO.FileAttributes Attributes {get;set;}
CreationTime      Property   System.DateTime CreationTime {get;set;}
CreationTimeUtc   Property   System.DateTime CreationTimeUtc {get;set;}
Directory         Property   System.IO.DirectoryInfo Directory {get;}
DirectoryName     Property   System.String DirectoryName {get;}
Exists            Property   System.Boolean Exists {get;}
Extension         Property   System.String Extension {get;}
FullName          Property   System.String FullName {get;}
IsReadOnly        Property   System.Boolean IsReadOnly {get;set;}
LastAccessTime    Property   System.DateTime LastAccessTime {get;set;}
LastAccessTimeUtc Property   System.DateTime LastAccessTimeUtc {get;set;}
LastWriteTime     Property   System.DateTime LastWriteTime {get;set;}
LastWriteTimeUtc  Property   System.DateTime LastWriteTimeUtc {get;set;}
Length            Property   System.Int64 Length {get;}
Name              Property   System.String Name {get;}

プロパティを見つけたら、PowerShell コマンドで使用できます。

プロパティ値

特定の型のすべてのオブジェクトには同じプロパティがありますが、これらのプロパティの値は特定のオブジェクトを記述します。 たとえば、すべての FileInfo オブジェクトには CreationTime プロパティがありますが、そのプロパティの値はファイルごとに異なります。

オブジェクトのプロパティの値を取得する最も一般的な方法は、メンバー アクセス演算子 (.) を使用することです。 オブジェクトを含む変数や、オブジェクトを取得するコマンドなど、オブジェクトへの参照を入力します。 次に、演算子 (.) の後にプロパティ名を入力します。

たとえば、次のコマンドは、ファイルの CreationTime プロパティの値をpwsh.exe表示します。 このコマンドはGet-ChildItempwsh.exe file. コマンドはかっこで囲んで、プロパティにアクセスする前に実行されるようにします。

(Get-ChildItem $PSHOME\pwsh.exe).CreationTime
Tuesday, June 14, 2022 5:17:14 PM

次の例に示すように、オブジェクトを変数に保存し、メンバー アクセス (.) メソッドを使用してそのプロパティを取得することもできます。

$a = Get-ChildItem $PSHOME\pwsh.exe
$a.CreationTime
Tuesday, June 14, 2022 5:17:14 PM

およびコマンドレットをSelect-ObjectFormat-List使用して、オブジェクトのプロパティ値を表示することもできます。 Select-ObjectFormat-Listパラメーターには Property パラメーターがあります。 Property パラメーターを使用して、1 つ以上のプロパティとその値を指定できます。 または、ワイルドカード文字 (*) を使用して、すべてのプロパティを表すことができます。

たとえば、次のコマンドは、pwsh.exe ファイルのすべてのプロパティの値を表示します。

Get-ChildItem $PSHOME\pwsh.exe | Format-List -Property *
PSPath              : Microsoft.PowerShell.Core\FileSystem::C:\Program Files\PowerShell\7\pwsh.exe
PSParentPath        : Microsoft.PowerShell.Core\FileSystem::C:\Program Files\PowerShell\7
PSChildName         : pwsh.exe
PSDrive             : C
PSProvider          : Microsoft.PowerShell.Core\FileSystem
PSIsContainer       : False
Mode                : -a---
ModeWithoutHardLink : -a---
VersionInfo         : File:             C:\Program Files\PowerShell\7\pwsh.exe
                      InternalName:     pwsh.dll
                      OriginalFilename: pwsh.dll
                      FileVersion:      7.3.9.500
                      FileDescription:  pwsh
                      Product:          PowerShell
                      ProductVersion:   7.3.9 SHA: 116d193ed28dcc6914653c799846bbf379cea0fb
                      Debug:            False
                      Patched:          False
                      PreRelease:       False
                      PrivateBuild:     False
                      SpecialBuild:     False
                      Language:         Language Neutral

BaseName            : pwsh
ResolvedTarget      : C:\Program Files\PowerShell\7\pwsh.exe
Target              :
LinkType            :
Length              : 293312
DirectoryName       : C:\Program Files\PowerShell\7
Directory           : C:\Program Files\PowerShell\7
IsReadOnly          : False
FullName            : C:\Program Files\PowerShell\7\pwsh.exe
Extension           : .exe
Name                : pwsh.exe
Exists              : True
CreationTime        : 10/25/2023 7:00:18 PM
CreationTimeUtc     : 10/26/2023 12:00:18 AM
LastAccessTime      : 11/14/2023 5:14:36 PM
LastAccessTimeUtc   : 11/14/2023 11:14:36 PM
LastWriteTime       : 10/25/2023 7:00:18 PM
LastWriteTimeUtc    : 10/26/2023 12:00:18 AM
LinkTarget          :
UnixFileMode        : -1
Attributes          : Archive

静的プロパティ

PowerShell では、.NET クラスの静的プロパティを使用できます。 静的プロパティは、オブジェクトのプロパティである標準プロパティとは異なり、クラスのプロパティです。

クラスの静的プロパティを取得するには、コマンドレットの Static パラメーターを Get-Member 使用します。 たとえば、次のコマンドは、クラスの静的プロパティを System.DateTime 取得します。

Get-Date | Get-Member -MemberType Property -Static
TypeName: System.DateTime

Name     MemberType Definition
----     ---------- ----------
MaxValue Property   static datetime MaxValue {get;}
MinValue Property   static datetime MinValue {get;}
Now      Property   datetime Now {get;}
Today    Property   datetime Today {get;}
UtcNow   Property   datetime UtcNow {get;}

静的プロパティの値を取得するには、次の構文を使用します。

[<ClassName>]::<Property>

たとえば、次のコマンドは、クラスの UtcNow 静的プロパティの値を System.DateTime 取得します。

[System.DateTime]::UtcNow

メンバーアクセス列挙

PowerShell 3.0 以降では、メンバー アクセス演算子 (.) を使用してリスト コレクションに存在しないプロパティにアクセスすると、PowerShell によってコレクション内の項目が自動的に列挙され、各アイテムのプロパティの値が返されます。 詳細については、「about_Member-Access_Enumeration」を参照 してください

このコマンドは、返されるすべてのサービスの DisplayName プロパティの値を Get-Service 返します。

(Get-Service).DisplayName
Application Experience
Application Layer Gateway Service
Windows All-User Install Agent
Application Identity
Application Information
...

すべてのコレクションには、 コレクション内のオブジェクトの数を返す Count プロパティがあります。

(Get-Service).Count
176

PowerShell 3.0 以降では、コレクションではないシングルトン オブジェクトの Count プロパティまたは Length プロパティを取得できます。

(Get-Service Audiosrv).Count
1

ただし、一部のオブジェクトには Length プロパティがあります。 たとえば、文字列の 長さは 文字列内の文字数です。 Count プロパティは、オブジェクトのインスタンスの数です。

PS> $str = 'string'
PS> $str.Length
6
PS> $str.Count
1

個々のオブジェクトとコレクションにプロパティが存在する場合は、コレクションのプロパティのみが返されます。

$collection = @(
    [pscustomobject]@{length = "foo"}
    [pscustomobject]@{length = "bar"}
)
# PowerShell returns the collection's Length.
$collection.length
2

関連項目