【初心者向け】PowerShellの`[PSCustomObject]`入門：カスタムオブジェクトの作り方

By /

はい、承知いたしました。PowerShell初心者向けに、[PSCustomObject]の詳細な使い方や活用法、メリット・デメリットなどを網羅し、約5000語を目指した解説記事を作成します。記事形式で直接出力します。

【初心者向け】PowerShellの[PSCustomObject]入門：カスタムオブジェクトの作り方と徹底活用

PowerShellは、システム管理や自動化を効率的に行うための強力なスクリプト言語です。その最大の特長の一つに「オブジェクト指向」であることが挙げられます。PowerShellのコマンドレットは、単なるテキストではなく、構造化されたデータである「オブジェクト」を扱います。このオブジェクト指向の考え方を理解し、自分で独自のオブジェクトを作成できるようになると、PowerShellスクリプトの表現力と柔軟性は飛躍的に向上します。

特に、スクリプトで収集したさまざまな情報を整理したり、コマンドレットの出力にはない独自の情報を追加したり、後続の処理（レポート作成やファイル出力など）に適した形にデータを加工したりする場合に、「カスタムオブジェクト」は非常に役立ちます。

本記事では、PowerShellで独自のカスタムオブジェクトを作成するための最も推奨される方法である[PSCustomObject]に焦点を当て、その基本的な使い方から、実践的な活用例、さらには応用的なテクニックまで、初心者の方にも分かりやすく詳細に解説していきます。PowerShellの基本的なコマンドレット（Get-*など）は使ったことがあるけれど、オブジェクト指向やパイプラインの真価をまだ十分に引き出せていないと感じている方に、ぜひ読んでいただきたい内容です。

この記事を読むことで、あなたは以下のことができるようになります。

  • なぜPowerShellがオブジェクトを扱うのか、そのメリットを理解する。
  • [PSCustomObject]を使って、自分で情報を構造化されたオブジェクトとして定義する方法を習得する。
  • 作成したカスタムオブジェクトのプロパティにアクセスする方法を知る。
  • 複数のカスタムオブジェクトをコレクションとして扱い、パイプラインで処理する方法を学ぶ。
  • 収集したシステム情報やログ解析結果などをカスタムオブジェクトとして整形し、レポート作成やファイル出力に活用する具体的な例を理解する。
  • 計算プロパティなど、より高度なカスタムオブジェクトの活用法を知る。
  • [PSCustomObject]を使う上でのメリット・デメリットや、他のデータ構造（ハッシュテーブル、クラスなど）との使い分けのヒントを得る。

さあ、PowerShellのオブジェクト指向の扉を開き、あなたのスクリプトをもっとパワフルにしましょう。

1. なぜPowerShellはオブジェクトを扱うのか？（オブジェクト指向のおさらい）

カスタムオブジェクトの話に入る前に、なぜPowerShellがオブジェクトを重視するのか、簡単に振り返っておきましょう。PowerShellの設計思想の根幹に関わる部分であり、[PSCustomObject]の重要性を理解する上でも非常に大切です。

従来のコマンドラインツール（例えば、Unix/Linuxのシェルコマンドや、Windowsの古くからあるコマンドプロンプトのコマンド）は、基本的にテキストを扱います。あるコマンドの出力は単なる文字列であり、その文字列を次のコマンドの入力として渡します。これが「テキストパイプライン」です。

テキストパイプラインはシンプルで強力ですが、いくつかの課題があります。例えば、

  • 構造化されていない: 出力は整形されたテキストであるため、特定の情報（例えば、プロセスIDだけ、ファイルのサイズだけ）を取り出すには、文字列操作（パターンマッチング、切り出し、区切り文字による分割など）が必要になります。これは複雑でエラーが発生しやすく、コマンドの出力フォーマットが変わるとスクリプトが壊れるリスクがあります。
  • 型の情報がない: すべてがテキストなので、数値なのか、日付なのか、真偽値なのかといったデータの型情報が失われます。計算を行う前に数値に変換したり、日付として比較する前に適切な形式に変換したりする必要があります。
  • プロパティとメソッドがない: テキストには、そのデータが持つ「属性」（プロパティ）や「操作」（メソッド）といった概念がありません。

一方、PowerShellはオブジェクトを扱います。PowerShellのコマンドレットが出力するのは、プロパティ（属性）とメソッド（操作）を持ったオブジェクトです。そして、PowerShellのパイプラインは、このオブジェクトをそのまま次のコマンドレットに渡します。これが「オブジェクトパイプライン」です。

オブジェクトパイプラインのメリットは以下の通りです。

  • 構造化されている: オブジェクトはあらかじめ定義されたプロパティを持っています。例えば、Get-Processコマンドレットが出力するプロセスオブジェクトには、「ProcessName」「Id」「CPU」「Memory」といったプロパティが定義されています。特定の情報を取得するには、.演算子を使ってプロパティ名で直接アクセスできます（例: $process.Id）。文字列操作は不要です。
  • 型の情報を持つ: オブジェクトのプロパティは、それぞれ適切なデータ型（整数、文字列、日付/時刻、真偽値など）を持っています。型に基づいた正確な比較や演算が容易に行えます。
  • プロパティとメソッドを持つ: オブジェクトは単なるデータだけでなく、そのデータに対して行える操作（メソッド）も持っている場合があります。例えば、サービスのオブジェクトにはStop()メソッドやStart()メソッドがあるかもしれません。

つまり、PowerShellでは、コマンドレットの出力は単なる表示用のテキストではなく、後続の処理で簡単に利用・加工できる構造化されたデータ（オブジェクト）なのです。このオブジェクト指向こそが、PowerShellによる自動化や管理を強力かつ効率的にしています。

2. なぜ独自のカスタムオブジェクトが必要なのか？

PowerShellに組み込まれているオブジェクト（Get-Processの出力、Get-Serviceの出力など）は非常に便利ですが、それだけで全てのタスクをカバーできるわけではありません。

例えば、以下のような状況を考えてみましょう。

  • 複数のシステムから、それぞれ異なる種類の情報を収集し、それらを一つにまとめてレポートしたい（例: サーバーAのOSバージョン、サーバーBのIPアドレス、サーバーCのディスク空き容量）。
  • 特定のログファイルを解析し、そこから抽出した情報（タイムスタンプ、イベントタイプ、メッセージ内容、関連ユーザーなど）を構造化して後続処理に渡したい。
  • 計算によって得られた結果や、外部ファイルから読み込んだ設定情報など、PowerShellの組み込みコマンドレットでは直接取得できない情報を、他のオブジェクトと同様に構造化された形式で扱いたい。
  • スクリプトの途中で生成される一時的なデータを、名前付きの属性（プロパティ）として管理したい。

このような場合、情報を単なる文字列や、キーと値のペアであるハッシュテーブルとして保持することも可能です。しかし、前述のオブジェクト指向のメリットを最大限に活かすためには、これらの「自分で集めたり生成したりした情報」も、PowerShellのオブジェクトとして扱うのが最も効率的です。

ここで登場するのが、カスタムオブジェクトです。カスタムオブジェクトを使うことで、あなたのスクリプトが収集したり生成したりした独自のデータに、プロパティ名をつけて構造化し、他のPowerShellオブジェクトと同じようにパイプラインで扱ったり、Format-*コマンドレットやExport-Csvなどで整形・出力したりすることが容易になります。

カスタムオブジェクトを作成する方法はいくつかありますが、現代のPowerShell（バージョン3.0以降）で最も推奨され、広く使われているのが[PSCustomObject]アクセラレーターを使った方法です。

3. [PSCustomObject]の基本的な使い方

[PSCustomObject]アクセラレーターは、ハッシュテーブル（辞書のようなもの、キーと値のペアの集まり）から簡単にカスタムオブジェクトを作成するための構文です。非常に直感的で簡潔に記述できるため、現在のPowerShellスクリプトでカスタムオブジェクトを作成する際の標準的な方法となっています。

3.1. ハッシュテーブルからの変換

最も基本的な[PSCustomObject]の使い方は、定義済みのハッシュテーブルをキャスト（型変換）する方法です。ハッシュテーブルのキーがオブジェクトのプロパティ名になり、ハッシュテーブルの値がそのプロパティの値になります。

まずは簡単な例を見てみましょう。あるユーザーの情報を格納するカスタムオブジェクトを作成します。

“`powershell

ユーザー情報を保持するハッシュテーブルを定義します

$userInfoHash = @{
Name = “Alice”
UserID = “alice01”
Department = “Sales”
IsActive = $true
}

ハッシュテーブルを [PSCustomObject] にキャスト（変換）します

$userObject = [PSCustomObject]$userInfoHash

作成したカスタムオブジェクトを表示します

$userObject
“`

このコードを実行すると、以下のような出力が得られます。

Name : Alice
UserID : alice01
Department : Sales
IsActive : True

見た目はハッシュテーブルと似ているかもしれませんが、これは既にオブジェクトです。PowerShellのGet-Memberコマンドレットを使って、その正体を確認してみましょう。

“`powershell

作成したオブジェクトのメンバー（プロパティやメソッド）を確認します

$userObject | Get-Member
“`

実行結果には、TypeNameとしてSystem.Management.Automation.PSCustomObjectと表示されるはずです。また、Name、UserID、Department、IsActiveというNoteProperty（後述しますが、これは最も一般的なプロパティの種類です）がリストアップされます。

“`
TypeName: System.Management.Automation.PSCustomObject

Name MemberType Definition
—- ———- ———-
Department NoteProperty string Department=Sales
IsActive NoteProperty bool IsActive=True
Name NoteProperty string Name=Alice
UserID NoteProperty string UserID=alice01
“`

この結果から、$userObjectが確かに[PSCustomObject]型のオブジェクトであり、定義したハッシュテーブルのキーがそのままプロパティ名になっていることが分かります。さらに、値に基づいてPowerShellが自動的にデータ型（string, bool）を推測していることも確認できます。

3.2. ハッシュテーブルを直接キャスト

ハッシュテーブルを一度変数に格納せずに、直接[PSCustomObject]にキャストすることも可能です。この方法の方が、多くの場合、より簡潔に記述できます。

“`powershell

ハッシュテーブルを直接 [PSCustomObject] にキャストしてオブジェクトを作成

$serverInfo = [PSCustomObject]@{
ComputerName = “SRV01”
OSVersion = (Get-ComputerInfo).OsDisplayVersion
FreeSpaceGB = (Get-Volume C).FreeSpaceGB
}

作成したオブジェクトを表示

$serverInfo
“`

この例では、Get-ComputerInfoやGet-Volumeといったコマンドレットの出力を利用してプロパティの値を動的に設定しています。これにより、現在のシステムの状態を反映したカスタムオブジェクトを作成できます。

出力例：

ComputerName : SRV01
OSVersion : Microsoft Windows Server 2019 Standard Evaluation
FreeSpaceGB : 150.75

3.3. プロパティへのアクセス

カスタムオブジェクトを作成したら、個々のプロパティの値にはドット（.）演算子を使ってアクセスできます。これは組み込みオブジェクトのプロパティにアクセスするのと全く同じ方法です。

“`powershell

前述の $serverInfo オブジェクトがあると仮定します

ComputerName プロパティの値を取得して表示

Write-Host “サーバー名: $($serverInfo.ComputerName)”

FreeSpaceGB プロパティの値を取得して表示

Write-Host “空き容量 (GB): $($serverInfo.FreeSpaceGB)”

プロパティの値を別の変数に代入することも可能

$freeSpace = $serverInfo.FreeSpaceGB
Write-Host “取得した空き容量変数: $freeSpace GB”
“`

この出力例：

サーバー名: SRV01
空き容量 (GB): 150.75
取得した空き容量変数: 150.75 GB

このように、カスタムオブジェクトのプロパティへのアクセスは非常に簡単です。一度オブジェクトとしてデータを構造化してしまえば、その後の処理で特定の情報が必要になったときに、直感的なプロパティ名で参照できます。

3.4. 複数のカスタムオブジェクトとコレクション

実際のスクリプトでは、単一のカスタムオブジェクトではなく、複数のシステム情報や複数のログエントリなど、同じ構造を持つオブジェクトの集まり（コレクション）を扱うことがほとんどです。PowerShellでは、このようなコレクションを配列として扱うのが一般的です。

複数のカスタムオブジェクトを作成し、それらを配列に追加していくことで、簡単にカスタムオブジェクトのコレクションを作成できます。

“`powershell

カスタムオブジェクトを格納するための空の配列を作成します

配列は @() で初期化するのが一般的です

$servers = @()

1つ目のサーバー情報オブジェクトを作成し、配列に追加します

$servers += [PSCustomObject]@{
ComputerName = “SRV01”
IPAddress = “192.168.1.101”
Status = “Running”
}

2つ目のサーバー情報オブジェクトを作成し、配列に追加します

$servers += [PSCustomObject]@{
ComputerName = “SRV02”
IPAddress = “192.168.1.102”
Status = “Stopped”
}

3つ目のサーバー情報オブジェクトを作成し、配列に追加します

$servers += [PSCustomObject]@{
ComputerName = “SRV03”
IPAddress = “192.168.1.103”
Status = “Running”
}

作成したカスタムオブジェクトのコレクション（配列）を表示します

$servers
“`

このコードを実行すると、以下のような出力が得られます。

ComputerName IPAddress Status
------------ --------- ------
SRV01 192.168.1.101 Running
SRV02 192.168.1.102 Stopped
SRV03 192.168.1.103 Running

配列として扱われるカスタムオブジェクトのコレクションは、PowerShellのパイプラインで非常に強力な威力を発揮します。例えば、特定の条件を満たすオブジェクトだけを抽出したり、特定のプロパティだけを選択したり、結果をソートしたり、ファイルに出力したりといった処理が、パイプラインを使うことで簡単に行えます。

例えば、ステータスが “Running” のサーバーだけを抽出したい場合は、Where-Objectコマンドレットを使います。

“`powershell

ステータスが ‘Running’ のサーバーだけを抽出します

$servers | Where-Object {$_.Status -eq “Running”}
“`

出力：

ComputerName IPAddress Status
------------ --------- ------
SRV01 192.168.1.101 Running
SRV03 192.168.1.103 Running

パイプラインの各ステップでは、オブジェクトがそのまま渡されるため、プロパティ名を使って簡単に条件を指定したり、値を操作したりできます。これがテキストベースの処理では非常に面倒になります。

3.5. New-Object PSObjectとの比較（歴史的経緯）

PowerShellの古いバージョン（特にv2以前）では、カスタムオブジェクトを作成する際によくNew-Object PSObjectというコマンドレットが使われていました。

“`powershell

古い方法（現在は非推奨）でカスタムオブジェクトを作成する例

$oldStyleObject = New-Object PSObject
$oldStyleObject | Add-Member -Type NoteProperty -Name “Name” -Value “Bob”
$oldStyleObject | Add-Member -Type NoteProperty -Name “Age” -Value 30

$oldStyleObject
“`

この方法では、まず空のPSObjectを作成し、その後Add-Memberコマンドレットを使ってプロパティを一つずつ追加していく必要がありました。

この方法は現在も使えますが、[PSCustomObject]アクセラレーターを使った方法に比べて、以下の点で劣ります。

  • 記述が冗長: プロパティの数だけAdd-Memberを呼び出す必要があり、コードが長くなります。
  • パフォーマンス: New-Object PSObjectとAdd-Memberを繰り返し呼び出すよりも、ハッシュテーブルを一度に[PSCustomObject]にキャストする方が効率的です。特に多数のオブジェクトや多数のプロパティを扱う場合に差が出ます。
  • 可読性: プロパティとその値の関連性が、ハッシュテーブルを直接見るよりも分かりにくいです。

そのため、特別な理由がない限り、カスタムオブジェクトの作成には[PSCustomObject]を使うことが強く推奨されています。本記事でも以降は[PSCustomObject]を使った方法を中心に解説していきます。

4. [PSCustomObject]を使った実践的な例

ここからは、具体的なシナリオで[PSCustomObject]がどのように役立つのかを見ていきましょう。

4.1. 例1：複数のシステム情報収集とレポート

複数のサーバーから情報を収集し、分かりやすいレポート形式で出力したいという状況はよくあります。ここでは、複数のコンピューター名を受け取り、それぞれのOSバージョンとCドライブの空き容量を収集してカスタムオブジェクトの配列として返す関数を作成してみましょう。

“`powershell
function Get-SystemReport {
[CmdletBinding()]
param(
[Parameter(Mandatory=$true)]
[string[]]$ComputerName # 処理対象のコンピューター名の配列
)

# 結果を格納するための空の配列
$reportData = @()

foreach ($computer in $ComputerName) {
    Write-Verbose "Processing computer: $computer" # 処理中のコンピューター名を表示 (Verboseスイッチ使用時)

    # 情報収集を試みる（エラー処理を追加するとより堅牢になりますが、ここでは簡略化）
    try {
        # OSバージョンを取得
        $osInfo = Get-ComputerInfo -ComputerName $computer -Property OsDisplayVersion -ErrorAction Stop

        # Cドライブの空き容量を取得
        # Get-Volume はリモート処理を直接サポートしないため、Invoke-Command を使用します
        $freeSpace = Invoke-Command -ComputerName $computer -ScriptBlock {
            (Get-Volume C).FreeSpaceGB
        } -ErrorAction Stop

        # 収集した情報をカスタムオブジェクトに格納
        $customObject = [PSCustomObject]@{
            ComputerName = $computer
            OSVersion    = $osInfo.OsDisplayVersion
            FreeSpaceGB  = $freeSpace
            Status       = "Success" # 成功フラグ
        }

        # 配列にカスタムオブジェクトを追加
        $reportData += $customObject

        Write-Verbose "Successfully collected info for $computer"

    } catch {
        # エラーが発生した場合もオブジェクトを作成し、エラー情報を格納
        Write-Warning "Failed to collect info for $computer. Error: $($_.Exception.Message)"

        $customObject = [PSCustomObject]@{
            ComputerName = $computer
            OSVersion    = "N/A"
            FreeSpaceGB  = "N/A"
            Status       = "Failed" # 失敗フラグ
            ErrorMessage = $_.Exception.Message # エラーメッセージ
        }

        # 配列にカスタムオブジェクトを追加
        $reportData += $customObject
    }
}

# 作成したオブジェクトの配列を返す
$reportData

}

関数を実行してレポートを取得

例: ローカルホストと存在しないホストを指定

$report = Get-SystemReport -ComputerName @(“localhost”, “nonexistent-server”, “127.0.0.1”) -Verbose

取得したレポートを表示 (Format-Tableで整形)

$report | Format-Table -AutoSize

Status が Failed のエントリだけを表示

Write-Host “`n— Failed Entries —”
$report | Where-Object {$_.Status -eq “Failed”} | Format-List
“`

この例では、

  1. 処理対象のコンピューター名の配列をパラメータとして受け取る関数を定義しました。
  2. 各コンピューターに対して、Get-ComputerInfoとInvoke-Commandを使って必要な情報を収集しています。
  3. 収集した情報（またはエラー情報）を元に、ループ内で動的に[PSCustomObject]を作成しています。各オブジェクトはComputerName、OSVersion、FreeSpaceGB、Statusといったプロパティを持ちます。エラーが発生した場合はErrorMessageプロパティも追加しています。
  4. 作成したカスタムオブジェクトを配列$reportDataに追加しています。
  5. 関数は最後にこの配列を返します。
  6. 関数の呼び出し側では、返されたカスタムオブジェクトの配列を$report変数に格納し、Format-TableやWhere-Objectといった標準のコマンドレットを使って、簡単に表示形式を調整したり、条件で絞り込んだりしています。

このように、カスタムオブジェクトを使うことで、スクリプトの内部でさまざまな情報を収集・整理し、後続の処理（表示、フィルタリング、出力など）に渡す標準的なインターフェースを提供できます。情報の収集部分と、その情報の利用部分を分離できるため、スクリプト全体の保守性や再利用性が向上します。

4.2. 例2：ログファイルの解析結果をオブジェクト化

テキストベースのログファイルを解析し、その内容を構造化されたオブジェクトとして扱いたい場合にも、[PSCustomObject]は非常に便利です。例えば、以下のようなフォーマットの簡単なログファイルを想定します。

2023-10-27 10:00:01 INFO User 'alice' logged in.
2023-10-27 10:05:15 WARN Disk space low on C:. Free space: 10GB
2023-10-27 10:10:30 ERROR Database connection failed.
2023-10-27 10:15:55 INFO User 'bob' logged out.
2023-10-27 10:20:00 INFO Service 'WebServer' started.

このログファイルから、各行の「タイムスタンプ」「レベル（INFO, WARN, ERROR）」「メッセージ」を抽出してオブジェクト化するスクリプトを作成してみましょう。

“`powershell

サンプルログファイルを作成（実際のログファイルに置き換えてください）

$logContent = @”
2023-10-27 10:00:01 INFO User ‘alice’ logged in.
2023-10-27 10:05:15 WARN Disk space low on C:. Free space: 10GB
2023-10-27 10:10:30 ERROR Database connection failed.
2023-10-27 10:15:55 INFO User ‘bob’ logged out.
2023-10-27 10:20:00 INFO Service ‘WebServer’ started.
Invalid log entry format.
“@

ログファイルパス（ここでは一時ファイルを使用）

$logFilePath = “$env:TEMP\sample.log”
$logContent | Out-File -Path $logFilePath -Encoding UTF8 # UTF8で保存推奨

解析結果を格納する配列

$logEntries = @()

ログファイルを1行ずつ読み込む

Get-Content -Path $logFilePath | ForEach-Object {
$line = $_ # 現在処理している行

# 正規表現を使って各要素を抽出
# パターン解説:
# ^(\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2})\s+ # タイムスタンプ (YYYY-MM-DD HH:MM:SS) をキャプチャグループ1に
# (INFO|WARN|ERROR)\s+                     # レベル (INFO, WARN, ERROR) をキャプチャグループ2に
# (.*)$                                    # 残りのメッセージをキャプチャグループ3に
$regexMatch = [regex]::Match($line, '^(\d{4}-\d{2}-\d{2}\s\d{2}:\d{2}:\d{2})\s+(INFO|WARN|ERROR)\s+(.*)$')

# 正規表現にマッチした場合のみオブジェクトを作成
if ($regexMatch.Success) {
    # 抽出した情報をカスタムオブジェクトに格納
    $customObject = [PSCustomObject]@{
        Timestamp = [datetime]$regexMatch.Groups[1].Value # 日付/時刻型に変換
        Level     = $regexMatch.Groups[2].Value # 文字列
        Message   = $regexMatch.Groups[3].Value # 文字列
        RawLine   = $line # 元の行も持たせておくと便利
    }

    # 配列に追加
    $logEntries += $customObject
} else {
    # マッチしない行は警告などを出すと良い
    Write-Warning "Skipped line due to unexpected format: $line"
}

}

解析結果のオブジェクトを表示

$logEntries | Format-Table -AutoSize

ERROR レベルのエントリだけを表示

Write-Host “`n— Error Entries —”
$logEntries | Where-Object {$_.Level -eq “ERROR”} | Format-List

特定のタイムスタンプより新しいエントリをフィルタリング

[datetime]型に変換しているので、日付/時刻での比較が簡単

Write-Host “`n— Entries after 10:10:00 —”
$cutoffTime = [datetime]”2023-10-27 10:10:00″
$logEntries | Where-Object {$_.Timestamp -gt $cutoffTime} | Format-Table -AutoSize

一時ファイルを削除 (任意)

Remove-Item $logFilePath

“`

この例では、

  1. サンプルログファイルをGet-Contentで読み込み、各行をパイプラインでForEach-Objectに渡しています。
  2. ForEach-Objectブロック内で、各行に対して正規表現を使って「タイムスタンプ」「レベル」「メッセージ」を抽出しています。
  3. 正規表現がマッチした場合、抽出した情報を使って[PSCustomObject]を作成しています。ここで、タイムスタンプは単なる文字列ではなく、[datetime]型にキャストしています。これにより、後で日付/時刻による比較やソートが容易になります。
  4. 作成したオブジェクトを$logEntries配列に追加しています。
  5. 最後に、このオブジェクトの配列をFormat-Tableで整形して表示したり、Where-Objectを使ってレベルやタイムスタンプでフィルタリングしたりしています。

もしログ解析結果をカスタムオブジェクトに格納せず、単に文字列として扱っていたら、タイムスタンプでフィルタリングするために複雑な文字列操作と型変換をその都度行う必要があり、非常に手間がかかります。カスタムオブジェクトとして構造化することで、PowerShellの強力なオブジェクト処理コマンドレット（Where-Object, Sort-Object, Format-*など）を最大限に活用できるようになります。

4.3. 例3：簡単なレポート出力

カスタムオブジェクトの配列は、さまざまな形式で簡単に出力できます。前述のGet-SystemReport関数の出力や、$logEntries配列など、カスタムオブジェクトのコレクションがある場合、以下のようなコマンドレットを使って整形・出力できます。

  • Format-Table: 表形式で表示します。特定のプロパティだけを表示したり、列の幅を調整したりできます。
    powershell
    $report | Format-Table ComputerName, FreeSpaceGB -AutoSize # 指定したプロパティだけ表示
  • Format-List: リスト形式で表示します。各オブジェクトの詳細を縦長のリストで確認したい場合に便利です。
    powershell
    $logEntries | Where-Object {$_.Level -eq "ERROR"} | Format-List * # 全てのプロパティを表示
  • Format-Wide: 幅広く表示します。通常は一つのプロパティだけを横一列に並べて表示する場合に使います。
    powershell
    $report | Format-Wide ComputerName -Column 3 # 3列でコンピューター名を表示
  • Export-Csv: オブジェクトの内容をCSVファイルとして出力します。スプレッドシートソフトなどで開いて確認・分析する場合に非常に便利です。
    powershell
    $report | Export-Csv -Path "SystemReport.csv" -NoTypeInformation -Encoding UTF8
    # -NoTypeInformation : CSVの1行目に出力される型情報を除去します。
    # -Encoding UTF8 : 日本語などが含まれる場合に文字化けを防ぐためUTF8を指定することが多いです。
  • ConvertTo-Json: オブジェクトをJSON形式の文字列に変換します。REST APIとの連携や、設定ファイルの出力などに利用できます。
    powershell
    $logEntries | ConvertTo-Json -Depth 3 # Depthはネストの深さを指定（必要に応じて調整）
  • ConvertTo-Html: オブジェクトをHTML形式の文字列に変換します。簡単なHTMLレポートを生成できます。
    powershell
    $report | ConvertTo-Html -Title "System Report" | Out-File SystemReport.html -Encoding UTF8

このように、一度データをカスタムオブジェクトとして構造化してしまえば、PowerShell標準の出力コマンドレットを使って、さまざまな形式で簡単に加工・表示・出力ができるようになります。これは、テキスト処理では実現が難しい、オブジェクト指向ならではの強力なメリットです。

5. [PSCustomObject]の応用

基本的なプロパティを持つカスタムオブジェクトの作成に慣れたら、さらに高度な活用方法を見ていきましょう。

5.1. プロパティのデータ型指定

前述の例で見たように、[PSCustomObject]はハッシュテーブルの値から自動的にデータ型を推測してくれます。しかし、明示的にデータ型を指定したい場合もあります。例えば、数値として扱いたいプロパティが文字列として格納されてしまう可能性がある場合などです。

ハッシュテーブルの値として、目的のデータ型にキャストすることで、明示的に型を指定できます。

“`powershell
$typedObject = [PSCustomObject]@{
IntegerProperty = [int]”123″ # 文字列 “123” を整数型 [int] にキャスト
DecimalProperty = [decimal]”45.67″ # 文字列 “45.67” を小数点型 [decimal] にキャスト
BooleanProperty = [bool]”True” # 文字列 “True” を真偽値型 [bool] にキャスト
DateTimeProperty = [datetime]”2023-10-27 14:30:00″ # 文字列を日付/時刻型 [datetime] にキャスト
GuidProperty = [guid]”a1b2c3d4-e5f6-7890-1234-567890abcdef” # 文字列をGUID型 [guid] にキャスト
}

$typedObject | Get-Member
“`

Get-Memberの出力を見ると、それぞれのプロパティが指定したデータ型になっていることが確認できます。

“`
TypeName: System.Management.Automation.PSCustomObject

Name MemberType Definition
—- ———- ———-
BooleanProperty NoteProperty bool BooleanProperty=True
DateTimeProperty NoteProperty datetime DateTimeProperty=10/27/2023 2:30:00 PM
DecimalProperty NoteProperty decimal DecimalProperty=45.67
GuidProperty NoteProperty guid GuidProperty=a1b2c3d4-e5f6-7890-1234-567890abcdef
IntegerProperty NoteProperty int IntegerProperty=123
“`

明示的に型を指定することで、そのプロパティが常に期待する型の値を持つことを保証できます。これは、後続の処理で数値計算を行ったり、日付/時刻で比較を行ったりする場合に非常に重要です。不適切な型の値が格納されることによるエラーを防ぐことができます。

5.2. 計算プロパティ (ScriptProperty)

既存のプロパティの値を使って計算したり、他のプロパティと組み合わせて新しい情報を表現したりしたい場合があります。このような場合に便利なのが、計算プロパティ (ScriptProperty) です。計算プロパティは、プロパティの値が固定ではなく、アクセスされるたびにScriptBlock（スクリプトのブロック）を実行して動的に生成されます。

計算プロパティは、Add-Memberコマンドレットを使って既存のカスタムオブジェクトに追加するか、カスタムオブジェクトを作成する際にSelect-Objectコマンドレットと組み合わせて使用する方法が一般的です。後者の方法が、オブジェクト作成と同時に計算プロパティを定義できるため、よく使われます。

Select-Objectコマンドレットで計算プロパティを定義するには、@{Name="PropertyName"; Expression={ScriptBlock}}という形式のハッシュテーブルを使用します。

例：前述のシステムレポートオブジェクトに、Cドライブの空き容量をパーセンテージで表示する計算プロパティを追加してみましょう。

まず、元のオブジェクトを作成します（例として、Get-Volumeの出力を利用）。

“`powershell

Cドライブのボリューム情報を取得（例）

$volume = Get-Volume C

基本的なカスタムオブジェクトを作成

$serverVolumeInfo = [PSCustomObject]@{
DriveLetter = $volume.DriveLetter
FileSystem = $volume.FileSystem
CapacityGB = $volume.CapacityGB
FreeSpaceGB = $volume.FreeSpaceGB
}

作成したオブジェクトを表示

$serverVolumeInfo
“`

出力：

“`
DriveLetter FileSystem CapacityGB FreeSpaceGB

C NTFS 237.99 150.75
“`

次に、このオブジェクトに対して、CapacityGBとFreeSpaceGBを使って空き容量の割合を計算するFreeSpacePercentという計算プロパティを追加した新しいオブジェクトを、Select-Objectを使って作成します。

“`powershell

計算プロパティを追加して新しいオブジェクトを作成

$serverVolumeReport = $serverVolumeInfo | Select-Object *, # 元の全てのプロパティを保持
@{
Name = “FreeSpacePercent”; # 新しい計算プロパティの名前
Expression = { # 値を計算するためのScriptBlock
# $ はパイプラインから渡された現在のオブジェクト ($serverVolumeInfo) を参照
if ($.CapacityGB -gt 0) {
[math]::Round(($.FreeSpaceGB / $.CapacityGB) * 100, 2) # 割合を計算し小数点以下2桁で丸める
} else {
0 # 容量が0の場合は0%とする
}
}
}

新しいオブジェクトを表示

$serverVolumeReport
“`

出力：

“`
DriveLetter FileSystem CapacityGB FreeSpaceGB FreeSpacePercent

C NTFS 237.99 150.75 63.34
“`

Select-Object *,の部分は、「元のオブジェクトの全てのプロパティを選択する」という意味です。その後に@{...}形式で追加したい計算プロパティを定義します。

Expressionに指定されたScriptBlockの中では、特殊変数$_がパイプラインから渡されてきた現在のオブジェクト（この場合は$serverVolumeInfo）を参照します。$_.CapacityGBや$_.FreeSpaceGBのように、元のオブジェクトのプロパティ値を使って計算を行っています。

計算プロパティは非常に柔軟で、複雑なロジックを含む値をプロパティとして表現できます。

5.3. メソッド (ScriptMethod)

カスタムオブジェクトに、特定の操作を実行するメソッドを追加することも可能です。これは、Add-Member -MemberType ScriptMethodを使って行います。メソッドの定義も、ScriptBlockを使って行います。

例：前述のサーバー情報オブジェクトに、そのサーバー情報を簡潔な文字列として返すToString()メソッドを追加してみましょう（ToString()メソッドは多くのオブジェクトが持っており、文字列が必要なコンテキストで自動的に呼び出されることがあります）。

“`powershell
$server = [PSCustomObject]@{
ComputerName = “SRV01”
IPAddress = “192.168.1.101”
Status = “Running”
}

ScriptMethod (メソッド) を追加

$server | Add-Member -MemberType ScriptMethod -Name “ToString” -Value {
# $this はメソッドが呼び出されたオブジェクト自身を参照します
“Server: $($this.ComputerName), IP: $($this.IPAddress), Status: $($this.Status)”
}

追加したメソッドを確認

$server | Get-Member -MemberType ScriptMethod

メソッドを呼び出す

$server.ToString()
“`

出力：

“`
TypeName: System.Management.Automation.PSCustomObject

Name MemberType Definition
—- ———- ———-
ToString ScriptMethod System.Object ToString()

Server: SRV01, IP: 192.168.1.101, Status: Running
“`

ScriptMethodのScriptBlock内では、特殊変数$thisがメソッドが呼び出されたオブジェクト自身を参照します。これにより、そのオブジェクトのプロパティ値にアクセスしたり、他のメソッドを呼び出したりといった操作を定義できます。

初心者向けとしては、計算プロパティの方が利用頻度が高く理解しやすいかもしれません。ScriptMethodは、オブジェクトに独自の「振る舞い」を持たせたい場合に強力ですが、より本格的なオブジェクト指向プログラミングの側面が強くなります。

5.4. 注釈プロパティ (NoteProperty) と他のプロパティタイプ

[PSCustomObject]を使ってハッシュテーブルから作成されるプロパティは、既定ではNotePropertyというタイプになります。これは最も基本的なプロパティで、単に名前と値を関連付けたものです。

Add-Memberコマンドレットでは、NoteProperty以外にもいくつかのプロパティタイプを追加できます。

  • AliasProperty: 既存のプロパティに別名（エイリアス）を付けます。例えば、ComputerNameプロパティにHostNameというエイリアスを付けるなど。
  • ScriptProperty: 前述の計算プロパティです。値をScriptBlockで動的に生成します。
  • CodeProperty: .NETコードを使って値を生成します（高度なトピック）。
  • AliasProperty / ScriptProperty / CodeProperty Set: これらのプロパティは通常値を取得する（Get）機能だけを持ちますが、Set機能（値を設定する）も定義できます。

初心者の方は、まずNotePropertyとScriptProperty（計算プロパティ）の使い方をマスターすれば十分でしょう。[PSCustomObject]のハッシュテーブルからの作成は、内部的にNotePropertyを追加する操作を行っています。

6. [PSCustomObject]のメリット・デメリット

[PSCustomObject]は非常に便利ですが、万能ではありません。そのメリットとデメリットを理解し、適切に使い分けることが重要です。

6.1. メリット

  • 構造化されたデータ: バラバラの情報を名前付きのプロパティとして整理できます。これにより、データの意味が明確になり、スクリプトの可読性が向上します。
  • パイプライン親和性: PowerShellのオブジェクトパイプラインにそのまま乗せることができます。Where-Object、Sort-Object、Group-Object、Measure-Objectなどの強力なコマンドレットを使って、データのフィルタリング、並べ替え、集計などを簡単に行えます。
  • レポート作成・出力の容易性: Format-Table、Export-Csv、ConvertTo-Jsonなどの標準コマンドレットで、簡単に表示形式を整えたり、さまざまな形式でファイルに出力したりできます。出力形式に合わせて自分で文字列整形コードを書く必要がほとんどありません。
  • 可読性と記述の容易さ: 特にハッシュテーブルからのキャストは非常にシンプルで直感的です。プロパティ名と値の対応が一目で分かります。
  • IntelliSenseのサポート: VS CodeなどのPowerShellエディタでは、カスタムオブジェクトのプロパティ名を補完候補として表示してくれます。これにより、スクリプトの記述ミスを減らし、開発効率が向上します。
  • 動的なプロパティ追加: スクリプトの実行中に、必要に応じてプロパティを追加できます（Add-Memberを使用）。ただし、[PSCustomObject]キャスト時に全てのプロパティを定義する方が一般的で推奨されます。

6.2. デメリット

  • 厳密な型チェックの欠如（既定では）: ハッシュテーブルから作成する場合、プロパティの型はPowerShellが自動的に推測します。明示的に型を指定しない限り、同じプロパティ名でも異なる型の値が格納されてしまう可能性があります。例えば、あるオブジェクトのAgeプロパティが整数なのに、別のオブジェクトでは文字列になってしまう、といったことが起こりえます。これは、予期しないエラーの原因となることがあります。明示的な型キャストを使用することで、ある程度回避可能です。
  • IntelliSenseの限界: ハッシュテーブルから動的に作成されるため、エディタはスクリプトを実行してみるまで、どのようなプロパティを持つオブジェクトが生成されるかを完全に把握できない場合があります。特に複雑なロジックでプロパティ名や型が決まる場合は、IntelliSenseの恩恵を受けにくいことがあります。（ただし、VS Codeなどモダンなエディタの多くは、ある程度静的な解析でプロパティを推測してくれます。）
  • 大規模・複雑な構造には向かない場合がある: 多数のプロパティを持つオブジェクトや、複数の関連するオブジェクトが複雑に組み合わさるような構造を扱う場合、ハッシュテーブルからのキャストだけでは定義が煩雑になることがあります。また、メソッドを多数持つオブジェクトを作成したい場合も、Add-Memberを繰り返すのは大変です。このようなケースでは、PowerShellのクラス（PowerShell 5.0以降で利用可能）や、既存の.NETクラスを継承・利用する方が、より適切な設計となる場合があります。

7. 他のデータ構造との比較と使い分け

PowerShellでデータを扱う方法には、カスタムオブジェクト以外にもいくつかあります。それぞれの特徴を理解し、[PSCustomObject]とどう使い分けるべきかを見ていきましょう。

  • 文字列 (String): 最も基本的なデータ形式です。テキストファイルの内容や、簡単なメッセージなどを保持するのに使います。しかし、構造を持たないため、特定の情報を取り出すには正規表現やSplitなどの文字列操作が必須になり、非常に手間がかかります。PowerShellでは、可能な限り構造化されたオブジェクトとしてデータを扱うのが推奨されます。
  • ハッシュテーブル (Hashtable): @{"Key1"="Value1"; "Key2"="Value2"} の形式で、キーと値のペアを格納できます。連想配列や辞書に相当します。
    • メリット: データの関連性をキーで表現できます。$hash.Keyのようにキー名で値にアクセスできます。PowerShell v3以降では既定で挿入順序が保持されます（[ordered]@{}）。
    • デメリット: オブジェクトではないため、そのままパイプラインに流しても、期待通りにWhere-ObjectやFormat-Tableで処理できない場合があります（特に複数のハッシュテーブルを配列にした場合、単なるキーと値のペアのリストとして扱われる）。また、プロパティではなくキーなので、IntelliSenseの恩恵も受けにくいです。
    • [PSCustomObject]との関係: [PSCustomObject]はハッシュテーブルから簡単に作成できるため、ハッシュテーブルはカスタムオブジェクトを作成するための一時的な格納場所として非常によく使われます。データの収集・整形段階ではハッシュテーブルを使用し、最終的にカスタムオブジェクトとしてまとめて出力する、というワークフローは一般的です。
  • 配列 (Array): @("Item1", "Item2") や 1, 2, 3 の形式で、複数の要素を順序付けして格納できます。
    • メリット: 複数の要素をまとめて管理できます。インデックス（$array[0]）やループ（foreach）で要素にアクセスできます。パイプラインの基本的な入力形式の一つです。
    • デメリット: 要素自体が構造を持つわけではありません。複数の異なる種類の情報をまとめて格納するには向きません（要素ごとに構造が異なる、など）。
    • [PSCustomObject]との関係: [PSCustomObject]のコレクションは、通常カスタムオブジェクトの配列として表現されます。配列は複数のカスタムオブジェクトをまとめて管理・処理するための「入れ物」として非常に重要です。
  • クラス (Class): PowerShell 5.0以降で利用可能になった、より本格的なオブジェクト指向の機能です。class MyClass { ... } のように定義します。
    • メリット: プロパティだけでなく、メソッド、コンストラクターなどを厳密に定義できます。プロパティに型制約を付けたり、検証ロジックを組み込んだりできます。コードの再利用性や構造化がより進みます。
    • デメリット: [PSCustomObject]よりも学習コストが高いです。定義が少し冗長になる場合があります。実行中に動的にプロパティを追加するような柔軟性は既定では持ちません。
    • [PSCustomObject]との使い分け:
      • [PSCustomObject] は、アドホック（一時的、その場限り）な構造化データを作成する場合に最適です。例えば、スクリプトの中で一時的に情報をまとめて表示したい、簡単なレポートを作成したい、といった場合に使います。定義が簡単で素早く使えるのが利点です。
      • クラス は、再利用可能な複雑なデータ構造を定義する場合や、オブジェクトに明確な振る舞い（メソッド）を持たせたい場合に適しています。例えば、会社の資産管理オブジェクト、複雑な設定オブジェクトなど、複数のスクリプトや関数で共通して使用するデータ構造を定義する場合に検討します。より堅牢で保守性の高いコードになります。

初心者の方は、まず[PSCustomObject]を使ったカスタムオブジェクト作成をマスターすることから始めるのが良いでしょう。多くのスクリプトで必要なレベルの構造化は、[PSCustomObject]で十分に実現できます。クラスは、より本格的なプログラミングを行う際に学習を検討するステップとなります。

8. よくある落とし穴とトラブルシューティング

[PSCustomObject]を使う上で、初心者の方がつまずきやすいポイントと、その解決策について触れておきます。

  • 空のオブジェクトやNullオブジェクトの扱い:
    • 情報を収集する際にエラーが発生したり、対象が見つからなかったりした場合、プロパティの値が $null になったり、カスタムオブジェクト自体が作成されずに $null になったりすることがあります。
    • オブジェクトやプロパティにアクセスする前に、if ($object -ne $null) や if ($object.PropertyName -ne $null) のように $null チェックを行うと、存在しないメンバーにアクセスしようとして発生するエラーを防ぐことができます。
    • 特にカスタムオブジェクトの配列を生成する際に、処理が失敗した要素がある場合、そのエントリが配列に含まれない、あるいはオブジェクトの一部プロパティが $null になるといった状況が発生します。前述の「例1：複数のシステム情報収集」のように、失敗した場合もエラー情報を格納したオブジェクトを生成して配列に含めるようにすると、レポートとして全体の成功/失敗状況を把握しやすくなります。
  • プロパティ名にスペースや特殊文字を含む場合:
    • ハッシュテーブルのキー名や、[PSCustomObject]のプロパティ名にスペースや - などの特殊文字を含めたい場合は、シングルクォート ' ' またはダブルクォート " " で囲む必要があります。
    • 例: @{ 'Free Space (GB)' = 150.75 }
    • このようなプロパティにアクセスする場合も、ドット演算子だけでなく、クォートと括弧を使用します。例: $object.'Free Space (GB)'
    • ただし、プロパティ名に特殊文字を使うのは、後続処理で扱いにくくなる場合があるため、避けるのが無難です。可能であればキャメルケース（freeSpaceGb）やパスカルケース（FreeSpaceGB）など、標準的な命名規則に従うことを推奨します。
  • 型変換エラー:
    • 明示的に型キャストを行う際に、値がその型に変換できない場合、エラーが発生します。
    • 例: [int]"abc" はエラーになります。
    • 外部から読み込んだデータ（特に文字列）を数値型や日付型に変換する際には、TryParse系のメソッド（例: [int]::TryParse("abc", [ref]$intValue)）を使って変換可能かどうかを事前にチェックするか、try/catchブロックでエラーを捕捉するなどの対応が必要です。
    • また、ハッシュテーブルからの[PSCustomObject]キャスト時に、PowerShellが意図しない型に推測してしまう場合があります。例えば、@{ Count = "5" } のように文字列で数値を渡すと、PowerShellは賢く型を推測してくれることが多いですが、常に意図通りになるとは限りません。重要なプロパティの型は、[int]"5"のように明示的にキャストして指定するのが安全です。
  • $object += $newItem による配列への要素追加のパフォーマンス:
    • ループ内で$array += $itemのように配列に要素を追加する操作は、要素数が少ない場合は問題ありませんが、非常に多数の要素（数千、数万など）を追加する場合、パフォーマンスが低下します。これは、+=演算子が、内部的に新しい配列を作成して既存の要素と新しい要素をコピーするという処理を行っているためです。
    • パフォーマンスが問題になる場合は、いったんArrayListやGeneric List ([System.Collections.Generic.List[object]]) を使用し、ループ終了後にToArray()メソッドで配列に変換する方が効率的です。
      powershell
      $list = [System.Collections.Generic.List[object]]::New() # または [System.Collections.ArrayList]::New()
      foreach (...) {
      $customObject = ... # オブジェクト作成
      $list.Add($customObject) # リストに追加
      }
      $arrayOfObjects = $list.ToArray() # 最後に配列に変換
    • ただし、通常の管理スクリプトで数千件程度のオブジェクトを扱うのであれば、+=でもほとんどの場合パフォーマンス問題にはなりません。数万件、数十万件といったデータを扱う場合に検討すれば十分です。

9. まとめ

本記事では、PowerShellにおけるカスタムオブジェクト、特に[PSCustomObject]を使ったオブジェクトの作成方法について、基本的な使い方から実践的な活用例、応用、メリット・デメリット、そして他のデータ構造との比較まで、詳細に解説しました。

PowerShellがオブジェクト指向であることの重要性を理解し、自分でカスタムオブジェクトを作成できるようになることは、PowerShellスクリプトを書く上での大きなステップです。これにより、

  • 収集した情報を分かりやすく構造化し、管理・利用しやすくなります。
  • PowerShellのオブジェクト処理コマンドレット（Where-Object、Sort-Object、Format-*など）の威力を最大限に引き出せます。
  • レポート作成やファイル出力が驚くほど簡単になります。
  • スクリプトの可読性、保守性、再利用性が向上します。

[PSCustomObject]は、ハッシュテーブルからのキャストというシンプルかつ効率的な方法でカスタムオブジェクトを作成できます。まずは、あなたが普段PowerShellで収集したり扱ったりしている情報を、[PSCustomObject]@{ ... } の形で構造化してみることから始めてみてください。

簡単な情報収集スクリプトの結果をカスタムオブジェクトとして返すように修正したり、ログ解析スクリプトの出力を行ごとにカスタムオブジェクトにしてみたりするだけでも、その後の処理がどれだけ楽になるか実感できるはずです。

カスタムオブジェクトの活用は、PowerShellを使ったシステム管理や自動化の可能性を大きく広げます。ぜひこの記事を参考に、あなたのスクリプトで[PSCustomObject]を積極的に活用してみてください。オブジェクト指向の世界へようこそ！

もし、さらに複雑なデータ構造や厳密な型定義が必要になった場合は、PowerShellのクラスについて学習を進めるのが次のステップとなります。

補足: 約5000語という要件でしたが、技術解説記事で冗長になりすぎず、かつ初心者向けに分かりやすさを保ちながらその語数を達成するのは困難です。本記事では、各項目を可能な限り詳細に説明し、多くの例を盛り込むことで情報量を増やしましたが、厳密に5000語を保証するものではありません。ご理解いただけますと幸いです。重要なのは語数よりも内容の質と分かりやすさであると考えています。

コメントする

メールアドレスが公開されることはありません。 ※ が付いている欄は必須項目です

上部へスクロール