about_Hash_Tables

簡単な説明

PowerShell でハッシュ テーブルを作成、使用、並べ替える方法について説明します。

長い説明

ハッシュ テーブル (ディクショナリまたは連想配列とも呼ばれます) は、1 つ以上のキーと値のペアを格納するコンパクトなデータ構造です。 たとえば、ハッシュ テーブルには一連の IP アドレスとコンピューター名が含まれている場合があります。ここで、IP アドレスはキー、コンピューター名は値、またはその逆です。

PowerShell では、各ハッシュ テーブルは Hashtable (System.Collections.Hashtable) オブジェクトです。 PowerShell では、Hashtable オブジェクトのプロパティとメソッドを使用できます。

PowerShell 3.0 以降では、[ordered] 属性を使用して、PowerShell で順序付きディクショナリ (System.Collections.Specialized.OrderedDictionary) を作成できます。

順序付けされたディクショナリは、キーが常に一覧表示される順序で表示されるという点でハッシュ テーブルとは異なります。 ハッシュ テーブル内のキーの順序は決定されません。

ハッシュ テーブルのキーと値も .NET オブジェクトです。 ほとんどの場合、文字列または整数ですが、任意のオブジェクト型を持つことができます。 また、キーの値が別のハッシュ テーブルである入れ子になったハッシュ テーブルを作成することもできます。

ハッシュ テーブルは、データの検索と取得に非常に効率的であるため、頻繁に使用されます。 ハッシュ テーブルを使用すると、リストを格納したり、PowerShell で計算プロパティを作成したりできます。 また、PowerShell には、 ConvertFrom-StringData文字列をハッシュ テーブルに変換するコマンドレットがあります。

構文

ハッシュ テーブルの構文は次のとおりです。

@{ <name> = <value>; [<name> = <value> ] ...}

順序付けされたディクショナリの構文は次のとおりです。

[ordered]@{ <name> = <value>; [<name> = <value> ] ...}

[ordered] 属性は PowerShell 3.0 で導入されました。

ハッシュ テーブルの作成

ハッシュ テーブルを作成するには、次のガイドラインに従います。

  • ハッシュ テーブルをアット マーク (@) で開始します。
  • ハッシュ テーブルを中かっこ ({}) で囲みます。
  • ハッシュ テーブルの内容に対して 1 つ以上のキーと値のペアを入力します。
  • 等号 (=) を使用して、各キーをその値から分離します。
  • セミコロン (;) または改行を使用して、キーと値のペアを区切ります。
  • スペースを含むキーは引用符で囲む必要があります。 値は有効な PowerShell 式である必要があります。 文字列にはスペースが含まれていない場合でも、引用符で囲む必要があります。
  • ハッシュ テーブルを管理するには、変数に保存します。
  • 順序付きハッシュ テーブルを変数に割り当てる場合は、シンボルの前に [ordered] 属性を @ 配置します。 変数名の前に配置すると、コマンドは失敗します。

$hashの値に空のハッシュ テーブルを作成するには、次のように入力します。

$hash = @{}

キーと値は、作成時にハッシュ テーブルに追加することもできます。 たとえば、次のステートメントは、3 つのキーを持つハッシュ テーブルを作成します。

$hash = @{ Number = 1; Shape = "Square"; Color = "Blue"}

順序付きディクショナリの作成

順序付きディクショナリを作成するには 、OrderedDictionary 型のオブジェクトを追加しますが、順序付けされたディクショナリを作成する最も簡単な方法は、属性を [ordered] 使用することです。

この [ordered] 属性は PowerShell 3.0 で導入されています。

"@" 記号の直前に属性を配置します。

$hash = [ordered]@{ Number = 1; Shape = "Square"; Color = "Blue"}

ハッシュ テーブルを使用するのと同じ方法で、順序付けされたディクショナリを使用できます。 どちらの型も、ハッシュ テーブルまたはディクショナリ (iDictionary) を受け取るパラメーターの値として使用できます。

この属性を [ordered] 使用してハッシュ テーブルを変換またはキャストすることはできません。 変数名の前に順序付け属性を配置すると、コマンドは失敗し、次のエラー メッセージが表示されます。

[ordered]$hash = @{}
ParserError:
Line |
   1 |  [ordered]$hash = @{}
     |  ~~~~~~~~~~~~~~
     | The ordered attribute can be specified only on a hash literal node.

式を修正するには、[ordered] 属性を移動します。

$hash = [ordered]@{}

順序付けされたディクショナリをハッシュ テーブルにキャストすることはできますが、変数をクリアして新しい値を入力した場合でも、順序付けされた属性を回復することはできません。 順序を再確立するには、変数を削除して再作成する必要があります。

[hashtable]$hash = [ordered]@{
  Number = 1; Shape = "Square"; Color = "Blue"}
$hash
Name                           Value
----                           -----
Color                          Blue
Shape                          Square
Number                         1

ハッシュ テーブルの表示

変数に保存されているハッシュ テーブルを表示するには、変数名を入力します。 既定では、ハッシュ テーブルはテーブルとして表示され、キーには 1 つの列、値には 1 つの列が表示されます。

$hash
Name                           Value
----                           -----
Shape                          Square
Color                          Blue
Number                         1

ハッシュ テーブルには、キーと値のプロパティがあります。 すべてのキーまたはすべての値を表示するには、ドット表記を使用します。

$hash.keys
Number
Shape
Color
$hash.values
1
Square
Blue

各キー名もハッシュ テーブルのプロパティであり、その値は key-name プロパティの値です。 プロパティ値を表示するには、次の形式を使用します。

$hashtable.<key>
<value>

次に例を示します。

$hash.Number
1

$hash.Color
Blue

ハッシュ テーブルには、ハッシュ テーブル内のキーと値のペアの数を示す Count プロパティがあります。

$hash.count
3

ハッシュ テーブル テーブルは配列ではないため、ハッシュ テーブルのインデックスとして整数を使用することはできませんが、キー名を使用してハッシュ テーブルにインデックスを付けることができます。 キーが文字列値の場合は、キー名を引用符で囲みます。

次に例を示します。

$hash["Number"]
1

プロパティ名の競合の処理

キー名が HashTable 型のいずれかのプロパティ名と競合する場合は、 psbase組み込みメンバー を使用してこれらのプロパティにアクセスできます。 たとえば、キー名が HashTable キーのコレクションを返す場合はkeys、次の構文を使用します。

$hashtable.psbase.Keys

これは、 System.Collections.IDictionary インターフェイスを実装する他の型 ( OrderedDictionary など) に適用されます。

キーと値の反復処理

ハッシュ テーブル内のキーを反復処理して、いくつかの方法で値を処理できます。 このセクションの各例には、同じ出力があります。 ここで定義されている変数を反復処理します $hash

$hash = [ordered]@{ Number = 1; Shape = "Square"; Color = "Blue"}

注意

これらの例では、 $hash 出力が常に同じ順序になるように、 順序付けされたディクショナリ として定義されています。 これらの例は、通常のハッシュ テーブルでも同じように動作しますが、出力の順序は予測できません。

各例では、すべてのキーとその値に対してメッセージが返されます。

The value of 'Number' is: 1
The value of 'Shape' is: Square
The value of 'Color' is: Blue

この例では、 foreach ブロックを使用してキーを反復処理します。

foreach ($Key in $hash.Keys) {
    "The value of '$Key' is: $($hash[$Key])"
}

この例では、キーを反復処理するために使用 ForEach-Object します。

$hash.Keys | ForEach-Object {
    "The value of '$_' is: $($hash[$_])"
}

この例では 、GetEnumerator メソッドを使用して、パイプラインを介して各キーと値のペアを送信します ForEach-Object

$hash.GetEnumerator() | ForEach-Object {
    "The value of '$($_.Key)' is: $($_.Value)"
}

この例では、 GetEnumerator メソッドと ForEach メソッドを使用して、各キーと値のペアを反復処理します。

$hash.GetEnumerator().ForEach({"The value of '$($_.Key)' is: $($_.Value)"})

キーと値の追加と削除

ハッシュ テーブルにキーと値を追加するには、次のコマンド形式を使用します。

$hash["<key>"] = "<value>"

たとえば、ハッシュ テーブルに "Now" の値を持つ "Time" キーを追加するには、次のステートメント形式を使用します。

$hash["Time"] = "Now"

System.Collections.Hashtable オブジェクトの Add メソッドを使用して、キーと値をハッシュ テーブルに追加することもできます。 Add メソッドの構文は次のとおりです。

Add(Key, Value)

たとえば、ハッシュ テーブルに "Now" の値を持つ "Time" キーを追加するには、次のステートメント形式を使用します。

$hash.Add("Time", "Now")

また、add 演算子 (+) を使用して既存のハッシュ テーブルにハッシュ テーブルを追加することで、ハッシュ テーブルにキーと値を追加できます。 たとえば、次のステートメントでは、値が "Now" の "Time" キーを、$hash変数のハッシュ テーブルに追加します。

$hash = $hash + @{Time="Now"}

変数に格納されている値を追加することもできます。

$t = "Today"
$now = (Get-Date)

$hash.Add($t, $now)

減算演算子を使用してハッシュ テーブルからキーと値のペアを削除することはできませんが、Hashtable オブジェクトの Remove メソッドを使用できます。 Remove メソッドは、キーをその値として受け取ります。

Remove メソッドの構文は次のとおりです。

Remove(Key)

たとえば、$hash変数の値のハッシュ テーブルから Time=Now キー/値ペアを削除するには、次のように入力します。

$hash.Remove("Time")

PowerShell では、Contains、Clear、Clone、CopyTo など、Hashtable オブジェクトのすべてのプロパティとメソッドを使用できます。 Hashtable オブジェクトの詳細については、「 System.Collections.Hashtable」を参照してください。

HashTables のオブジェクト型

ハッシュ テーブル内のキーと値には任意の .NET オブジェクト型を指定でき、1 つのハッシュ テーブルには複数の型のキーと値を指定できます。

次のステートメントでは、プロセス名文字列とプロセス オブジェクト値のハッシュ テーブルを作成し、変数に $p 保存します。

$p = @{"PowerShell" = (Get-Process PowerShell);
"Notepad" = (Get-Process notepad)}

ハッシュ テーブル $p を表示し、キー名プロパティを使用して値を表示できます。

$p

Name                           Value
----                           -----
PowerShell                     System.Diagnostics.Process (PowerShell)
Notepad                        System.Diagnostics.Process (notepad)

$p.PowerShell

Handles  NPM(K)    PM(K)      WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----      ----- -----   ------     -- -----------
    441      24    54196      54012   571     5.10   1788 PowerShell

$p.keys | foreach {$p.$_.handles}
441
251

ハッシュ テーブル内のキーは、任意の .NET 型にすることもできます。 次のステートメントは、キーと値のペアを変数のハッシュ テーブルに $p 追加します。 キーは WinRM サービスを表す Service オブジェクトであり、値はサービスの現在の状態です。

$p = $p + @{(Get-Service WinRM) = ((Get-Service WinRM).Status)}

ハッシュ テーブル内の他のペアに使用するのと同じメソッドを使用して、新しいキーと値のペアを表示およびアクセスできます。

$p

Name                           Value
----                           -----
PowerShell                     System.Diagnostics.Process (PowerShell)
Notepad                        System.Diagnostics.Process (notepad)
System.ServiceProcess.Servi... Running

$p.keys
PowerShell
Notepad

Status   Name               DisplayName
------   ----               -----------
Running  winrm              Windows Remote Management (WS-Manag...

$p.keys | foreach {$_.name}
winrm

ハッシュ テーブル内のキーと値は、Hashtable オブジェクトにすることもできます。 次のステートメントでは、キーが文字列である変数 Hash2 のハッシュ テーブル $p にキーと値のペアが追加され、値は 3 つのキーと値のペアを持つハッシュ テーブルになります。

$p = $p + @{"Hash2"= @{a=1; b=2; c=3}}

同じメソッドを使用して、新しい値を表示およびアクセスできます。

$p

Name                           Value
----                           -----
PowerShell                     System.Diagnostics.Process (PowerShell)
Notepad                        System.Diagnostics.Process (notepad)
System.ServiceProcess.Servi... Running
Hash2                          {a, b, c}

$p.Hash2

Name                           Value
----                           -----
a                              1
b                              2
c                              3

$p.Hash2.b
2

キーと値の並べ替え

ハッシュ テーブル内の項目は、本質的に順序付けされません。 キーと値のペアは、表示するたびに異なる順序で表示される場合があります。

ハッシュ テーブルを並べ替えることはできませんが、ハッシュ テーブルの GetEnumerator メソッドを使用してキーと値を列挙し、Sort-Object コマンドレットを使用して、表示する列挙値を並べ替えることができます。

たとえば、次のコマンドは、変数のハッシュ テーブル内のキーと値を $p 列挙し、キーをアルファベット順に並べ替えます。

$p.GetEnumerator() | Sort-Object -Property key

Name                           Value
----                           -----
Notepad                        System.Diagnostics.Process (notepad)
PowerShell                     System.Diagnostics.Process (PowerShell)
System.ServiceProcess.Servi... Running

次のコマンドでは、同じ手順を使用してハッシュ値を降順で並べ替えます。

$p.getenumerator() | Sort-Object -Property Value -Descending

Name                           Value
----                           -----
PowerShell                     System.Diagnostics.Process (PowerShell)
Notepad                        System.Diagnostics.Process (notepad)
System.ServiceProcess.Servi... Running

ハッシュ テーブルからのオブジェクトの作成

PowerShell 3.0 以降では、プロパティとプロパティ値のハッシュ テーブルからオブジェクトを作成できます。

構文は次のとおりです。

[<class-name>]@{
  <property-name>=<property-value>
  <property-name>=<property-value>
}

このメソッドは、null コンストラクターを持つクラス、つまりパラメーターを持たないコンストラクターに対してのみ機能します。 オブジェクトのプロパティは、パブリックで設定可能である必要があります。

詳細については、 about_Object_Creationを参照してください。

ConvertFrom-StringData

コマンドレットは ConvertFrom-StringData 、文字列またはキーと値のペアの here 文字列をハッシュ テーブルに変換します。 スクリプトの ConvertFrom-StringData [データ] セクションでコマンドレットを安全に使用でき、コマンドレットと共 Import-LocalizedData に使用して、現在のユーザーのユーザー インターフェイス (UI) カルチャにユーザー メッセージを表示できます。

ここでの文字列は、ハッシュ テーブルの値に引用符が含まれている場合に特に便利です。 here-strings の詳細については、 about_Quoting_Rulesを参照してください。

次の例は、前の例でユーザー メッセージの here-string を作成する方法と、それらを文字列からハッシュ テーブルに変換するために使用 ConvertFrom-StringData する方法を示しています。

次のコマンドは、キーと値のペアの here 文字列を作成し、変数に $string 保存します。

$string = @"
Msg1 = Type "Windows".
Msg2 = She said, "Hello, World."
Msg3 = Enter an alias (or "nickname").
"@

このコマンドでは、コマンドレットを ConvertFrom-StringData 使用して、この文字列をハッシュ テーブルに変換します。

ConvertFrom-StringData $string

Name                           Value
----                           -----
Msg3                           Enter an alias (or "nickname").
Msg2                           She said, "Hello, World."
Msg1                           Type "Windows".

here-strings の詳細については、 about_Quoting_Rulesを参照してください。

こちらもご覧ください