PowerShellについて調べてみた

本記事について

本記事は筆者が一部のコマンドをなんとなく使っていたPowerShellをきちんと活用できるために、PowerShellについて調べたものです。...正直、思ったよりできることが多くてびっくりしました。多すぎるので、他の言語と似ているところはある程度省略して、見ればなんとなく分かる程度にしました。でも多いです。

本記事はPowerShellの書き方をメインに扱っています。使えそうなコマンドは別の投稿にまとめました。

本記事のコマンドはPowerShell 7.4.6で動作確認しました。

はじめに

PowerShellとは

Windows Powershell

Windows 10や11に標準搭載されているPowerShellは「Windows PowerShell」といい、その名の通りWindows専用である。それとは別にLinux等でも動作するPowerShellがある。これらは似て非なるものであり、機能・コマンドなどが異なるところがある。詳細は公式ドキュメントに記事があるのでそちらを参照。

コマンドレット

コマンドレットは PowerShell組み込みのコマンドで、「動詞-名詞」という名前規則になっている。たとえば Get-ChildItem というコマンドレットは 子アイテムを取得するコマンドである。

Get-ChildItem
(out)
(out)    Directory: D:\
(out)
(out)Mode                 LastWriteTime         Length Name
(out)----                 -------------         ------ ----
(out)d-r--          2024/11/13     9:26                desktop
(out)d-r--          2024/12/06    20:52                downloads
(out)d-r--          2024/11/20    19:56                files
(out)d-r--          2024/11/13     9:26                music
(out)d-r--          2024/11/13     9:26                pictures
(out)d----          2024/10/21    20:18                programs
(out)d-r--          2024/11/13     9:26                videos

パラメータ

コマンド名に続けて、そのコマンドの動作を制御する値をコマンドに渡すことができる。例えばGet-ChildItem というコマンドレットは、デフォルトでは現在位置の子アイテムを取得するが、Pathというパラメータに"C:\"という値を渡すとC:\の子アイテムを取得する。

Get-ChildItem -Path C:\
(out)
(out)    Directory: C:\
(out)
(out)Mode                 LastWriteTime         Length Name
(out)----                 -------------         ------ ----
(out)d----          2024/10/27    11:45                Brother
(out)d----          2022/06/29    22:54                drivers
(out)d----          2023/11/22    23:53                MSI
(out)d----          2024/04/01    16:26                PerfLogs
(out)d-r--          2024/11/15    19:00                Program Files
(out)d-r--          2024/11/13     9:15                Program Files (x86)
(out)d-r--          2024/11/13     9:15                Users
(out)d----          2024/11/25     0:34                Windows
(out)-a---          2024/02/22     1:33         112136 appverifUI.dll
(out)-a---          2024/02/22     1:34          66328 vfcompat.dll

パラメータは基本的には「-パラメータ名 パラメータの値」のような形で指定する。Get-ChildItemのPathパラメータのように、パラメータ名を省略できるものがある。以下の2つのコマンドは全く同じ意味である。

• Get-ChildItem -Path C:\
• Get-ChildItem C:\

また、パラメータの中にはON/OFFを切り替えるものがあり、スイッチパラメータと呼ぶ。スイッチパラメータは設定値を持たない。Get-ChildItemではファイルだけを表示するFileパラメータがあり、Fileパラメータが指定されていればON、指定されていなければOFFという意味になる。

• Get-ChildItem # ファイルだけ表示：OFF
• Get-ChildItem -File # ファイルだけ表示：ON

write-output -InputObject
(out)Write-Output: Missing an argument for parameter 'InputObject'. Specify a parameter of type 'System.Management.Automation.PSObject' and try again.

write-output "-InputObject"
(out)-InputObject
(out)
write-output -- -InputObject
(out)-InputObject

エイリアス

コマンドに別の名前を与える。Get-Aliasを実行するとエイリアスの一覧を取得できる。その中には ls -> Get-ChildItem というものがあり、Get-ChildItem は ls というコマンドでも実行できる。

ls
(out)
(out)    Directory: D:\
(out)
(out)Mode                 LastWriteTime         Length Name
(out)----                 -------------         ------ ----
(out)d-r--          2024/11/13     9:26                desktop
(out)d-r--          2024/12/06    20:52                downloads
(out)d-r--          2024/11/20    19:56                files
(out)d-r--          2024/11/13     9:26                music
(out)d-r--          2024/11/13     9:26                pictures
(out)d----          2024/10/21    20:18                programs
(out)d-r--          2024/11/13     9:26                videos

Set-Aliasコマンドで、独自のエイリアスを登録することもできる。

ヘルプ

パラメータを含むコマンドの使い方を確認するには Get-Help コマンドを使う。

Get-Help Get-ChildItem
(out)
(out)NAME
(out)    Get-ChildItem
(out)
(out)SYNTAX
(out)    Get-ChildItem [[-Path] ] [[-Filter] ] [-Include ] [-Exclude ] [-Recurse] [-Depth ] [-Force] [-Name] [-Attributes {None | ReadOnly | Hidden | System | Directory | Archive | Device | Normal | Temporary | SparseFile | ReparsePoint | Compressed | Offline | NotContentIndexed | Encrypted | IntegrityStream | NoScrubData}] [-FollowSymlink] [-Directory] [-File] [-Hidden] [-ReadOnly] [-System] []
(out)
(out)ALIASES
(out)    gci
(out)    ls
(out)    dir
(out)
(out)(省略)

パイプライン

コマンドの実行結果を別のコマンドへ渡すことができる。command-1 | command-2 | command-3のようにパイプ|でつなげて記述する。

オブジェクト

コマンドの実行結果はオブジェクトとして出力される。オブジェクトはメンバーを持ち、メンバーに情報が格納されている。オブジェクトの種類はコマンドによって異なる。

オブジェクトが持っているメンバーを取得できるコマンドGet-Memberがある。Get-ChildItemの出力をGet-Memberに渡した結果を以下に示す。 この結果は、Get-ChildItemがSystem.IO.DirectoryInfo と System.IO.FileInfo の2種類のオブジェクトを渡したことと、それぞれのオブジェクトタイプが多数のメンバーを持つことが分かる。

Get-ChildItem | Get-Member
(out)
(out)   TypeName: System.IO.DirectoryInfo
(out)
(out)Name                      MemberType     Definition
(out)----                      ----------     ----------
(out)Target                    AliasProperty  Target = LinkTarget
(out)LinkType                  CodeProperty   System.String LinkType{get=GetLinkType;}
(out)...(中略)...
(out)
(out)
(out)   TypeName: System.IO.FileInfo
(out)
(out)Name                      MemberType     Definition
(out)----                      ----------     ----------
(out)Target                    AliasProperty  Target = LinkTarget
(out)LinkType                  CodeProperty   System.String LinkType{get=GetLinkType;}
(out)...(省略)...

メンバータイプ

メンバーには種類がある。主なものを示す。

オブジェクトの表示

Get-ChildItemコマンドはDirectoryInfoやFileInfoオブジェクトを出力する。コンソール上にはオブジェクトが表形式で表示される。

Get-ChildItem
(out)
(out)    Directory: D:\
(out)
(out)Mode                 LastWriteTime         Length Name
(out)----                 -------------         ------ ----
(out)d-r--          2024/11/13     9:26                desktop
(out)d-r--          2024/12/06    20:52                downloads
(out)d-r--          2024/11/20    19:56                files
(out)d-r--          2024/11/13     9:26                music
(out)d-r--          2024/11/13     9:26                pictures
(out)d----          2024/10/21    20:18                programs
(out)d-r--          2024/11/13     9:26                videos

コマンドが最後まで実行され出力オブジェクトを渡すコマンドがなくなると、自動でOut-Defaultコマンドレットへ渡される。このOut-Defaultは一般ユーザが使う意味は無いが付けることもできる。

Get-ChildItem | Out-Default
(out)
(out)    Directory: D:\
(out)
(out)Mode                 LastWriteTime         Length Name
(out)----                 -------------         ------ ----
(out)d-r--          2024/11/13     9:26                desktop
(out)d-r--          2024/12/06    20:52                downloads
(out)d-r--          2024/11/20    19:56                files
(out)d-r--          2024/11/13     9:26                music
(out)d-r--          2024/11/13     9:26                pictures
(out)d----          2024/10/21    20:18                programs
(out)d-r--          2024/11/13     9:26                videos

Out-Defaultはオブジェクトに応じてどのように出力するかをバックグラウンドで決定する。もし、オブジェクトが文字列なら、単にOut-Hostを呼び出す。そうでなければ、オブジェクトの種類を調べ、このオブジェクトの種類に対応するデフォルトの表示形式が登録されているかどうかを調べる。もし、見つかった表示形式がテーブルであれば、Out-DefaultはFormat-Table | Out-Hostを呼び出す。

ビューとフォーマットデータ

表示形式の定義をビューと呼び、オブジェクトをどのようなビューで表示するかという設定をフォーマットデータと呼ぶ。Get-FormatData、Export-FormatData、Update-FormatDataなどにより確認や変更ができる。

FileInfoオブジェクトのビュー定義を取得してみる。

Get-FormatData System.IO.FileInfo
(out)
(out)TypeNames                                     FormatViewDefinition
(out)---------                                     --------------------
(out){System.IO.DirectoryInfo, System.IO.FileInfo} {children, childrenWithHardlink, children, children}

ここで表示されているFormatViewDefinitionはビューの定義オブジェクトである。FormatViewDefinitionを見れば、表形式かリスト形式かは分かる。

Get-FormatData System.IO.FileInfo | select -ExpandProperty FormatViewDefinition
(out)
(out)Name                 Control
(out)----                 -------
(out)children             System.Management.Automation.TableControl
(out)childrenWithHardlink System.Management.Automation.TableControl
(out)children             System.Management.Automation.ListControl
(out)children             System.Management.Automation.WideControl

実際にフォーマットデータをエクスポートしてみる。

Get-FormatData System.IO.FileInfo | Export-FormatData -Path testformat.xml

  
    
      children
      
        System.IO.DirectoryInfo
      
      
        PSParentPath
      
      
        
          
            Mode
            7
            Left
          
          
            LastWriteTime
            26
            Right
          
          
            Length
            14
            Right
          
          
            Name
            Left
          
        
        
          
            
            
              
                ModeWithoutHardLink
              
              
                LastWriteTimeString
              
              
                LengthString
              
              
                NameString
              
            
          
        
      
    
    (残りの3つのViewについては省略)

これを見ると、childrenというビューは見出しがMode、LastWriteTime、Length、Nameのテーブルがビューとして定義されている。それでは、これを踏まえてFileInfoを出力するGet-ChildItemの出力を見てみると、childrenビューと一致していることがわかる。

ビューの指定

デフォルトの表示形式に見たいメンバーが含まれていなかったり、違う形式で見たいことがある。そのような場合は表示形式を指定するformat-*コマンドが各種用意されている。

• Format-Custom
• Format-Hex
• Format-List
• Format-Table
• Format-Wide

オブジェクトの文字列化

出力がオブジェクトであることが望ましくない場合もある。そのような場合、Out-Stringコマンドレットで出力を文字列として得ることができる。

単なる文字列となることで、見出しの色分けなどがされなくなっている。

変数

PowerShellの変数には数値や文字列、変数はドル記号$で始める。

$a = 10
$b = 20
$c = "text"
$a + $b
(out)30

コマンドの出力オブジェクトも格納できる。Get-ChildItemの実行結果を$childitem変数へ格納する例を示す。

$childitem = Get-ChildItem

変数はオブジェクトの型に縛られない。そのため、数値を入れた変数に文字列を入れることもできる。

$a = 10
$a = "text"

Set-Variable a 10 -Option Constant
$a = 20
(out)WriteError: Cannot overwrite variable a because it is read-only or constant.

メンバー

変数がオブジェクトでメンバーを持つ場合、他の言語でも良くあるようにピリオドでメンバへアクセスできる。

$childitem = Get-ChildItem
$childitem.Name
(out)desktop
(out)downloads
(out)files
(out)music
(out)pictures
(out)programs
(out)videos

変数の種類

変数には3種類ある。

変数名に使用できる文字

変数には様々な文字が使用できるがベストプラクティスとしては英数字とアンダースコア (_)だけを使う。

$var = "text"
$var_1 = "text"

その他の文字を含める場合は{}で囲む。

# 例えば ハイフン - はそのままでは使えない。
$var-1 = "text"
(out)ParserError:
(out)Line |
(out)   1 |  $var-1 = "text"
(out)     |  ~~~~~~
(out)     | The assignment expression is not valid. The input to an assignment operator must be an object that is able to
(out)     | accept assignments, such as a variable or a property.
(out)
${var-1} = "text"
${変数}  = "text"

なお、変数名に閉じ中括弧}とバッククォート`は使用できない。

コレクション

配列

PowerShellでは@()で配列を表す。複数行で定義することもでき、その場合はカンマを省略できる。

$array = @('a','b','c')
(out)
$array1 = @(
(con)    'a'
(con)    'b'
(con)    'c'
(con))

また、コンマ区切りリストも使用できる。

$arrray2 = 'a','b','c'

指定番目の要素を取り出すには[]を使う。PowerShellは0ベースのインデックスである。

$array = @('a','b','c')
$array[0]
(out)a

特殊なインデックス指定

スライスのような記法や、負数インデックスもサポートされる。また、カンマで区切って複数のインデックスをまとめて指定できる。

$narray = 0,1,2,3,4,5,6,7,8,9
$narray[3..5]
(out)3
(out)4
(out)5
$narray[-1]
(out)9
$narray[3..-2]
(out)3
(out)2
(out)1
(out)0
(out)9
(out)8
$narray[1,5,7,8]
(out)1
(out)5
(out)7
(out)8

範囲外のインデックス

PowerShellでは範囲外のインデックスにアクセスしてもエラーにはならない。単にnullが返される。

$narray = 0,1,2,3,4,5,6,7,8,9
$narray[100]
$narray[100] -eq $null
(out)True

ハッシュテーブル

ハッシュテーブルはキーバリュー型のデータ構造。配列とは違い中括弧@{}を、区切りには;を使う。

$ht = @{ Path="downloads"; Filter="*.png" }
(out)
$ht = @{
(con)    Path="downloads"
(con)    Filter="*.png"
(con)}
(out)
$ht["Path"]
(out)downloads
$ht["Filter"]
(out)*.png
$ht["NoKey"]
$ht["NoKey"] -eq $null
(out)True

配列と同様に、存在しないキーにアクセスしてもエラーとならない。

スプラッティング

コマンドレットの引数を配列またはハッシュテーブルでまとめて指定できる。これをスプラッティングと呼び@演算子を使用する。スプラッティングを使うとパラメータが多く長くなってしまうコマンドを見やすく書くことができる。

例えば、Get-ChildItem -Path downloads -Filter *.pngというコマンドはスプラッティングを使うと以下のように書ける。プロパティ名と値をもつ場合はハッシュテーブルで、値だけをもつ場合は配列を使う。

$ht = @{
(con)    Path="downloads"
(con)    Filter="*.png"
(con)}
(out)
Get-ChildItem @ht

$ht = @{
(con)    Path="downloads"
(con)    Filter="*.png"
(con)    Directory=$true
(con)}
Get-ChildItem @ht

文字列

文字列は引用符で囲む。一重、二重のどちらでも使用できるが、二重引用符では変数が展開される、エスケープシーケンスが解釈されるという違いがある。

$var1 = "text"
$var2 = 'text'
$var1 -eq $var2
(out)True
'$var1'
(out)$var1
"$var2"
(out)text

二重引用符の文字列で、変数名の後に英数字または_が続く場合は、{}でどこまでが変数名かを示す。ミスを防ぐためには文字列の中では変数名は{}で囲む方が良いだろう。

$noun = "pen"
"I have a $noun."
(out)I have a pen.
"I have two $nouns."
(out)I have two .
"I have two ${noun}s."
(out)I have two pens.

ヒア文字列リテラル

@'と'@でまたは@"と"@で囲むとヒア文字列リテラルになる。複数行にまたがる文字列を表すことができる。一重と二重の違いは変数が展開されるかどうかで普通の文字列と同じである。

$here_string = @'
(out)  ∧ ∧
(out)/(´Д`)ノ
(out)￣￣￣￣|
(out)'@
(out)
echo $here_string
(out)  ∧ ∧
(out)/(´Д`)ノ
(out)￣￣￣￣|

エスケープシーケンス

二重引用符で囲まれた文字では特殊文字シーケンスがサポートされる。PowerShellではバッククォート(`)がエスケープ文字であり、改行であれば"`n"と書く。

文字列の結合

文字列を結合するときは+演算子や結合演算子-joinを使う。

"text" + "text"
(out)texttext
"text" + 0
(out)text0
-join ("text", "text")
(out)texttext
-join (0, "text")
(out)0text

数値など文字列以外と結合する場合、+演算子では計算順序によってエラーとなる。以下の例では"text"を数値へ変換しようとしてエラーとなる。

0 + "text"
(out)InvalidArgument: Cannot convert value "text" to type "System.Int32". Error: "The input string 'text' was not in a correct format."

#区切り文字なし
-Join (結合する文字1, ..., 結合する文字N)

#区切り文字有り
(結合する文字1, ..., 結合する文字N) -Join 区切り文字

構文

コメント

# 行コメント

<# ブロックコメント #>

コメントベースヘルプ

指定のフォーマットでコメントを書くと、コメントを元にヘルプテキストを生成してくれる。

<#
.

#>

関数のヘルプコメントなら以下のように書く。コメント位置はこの例で使っているfunction定義の前の他に、functionブロックの先頭か末尾に書いても良い。こうするとGet-Helpでコメントの内容がヘルプとして表示される。

<#
.SYNOPSIS
概要：○○する関数

.DESCRIPTION
詳細説明：○○して××する関数

.PARAMETER a
文字列A

.PARAMETER b
文字列B

.EXAMPLE
PS> Test-CommentBasedHelp -a "A" -b "B"

AとBを結合する。

.EXAMPLE
PS> Test-CommentBasedHelp -a "TEST"

TESTとBを結合する。

.NOTES
○○に注意

#>
function Test-CommentBasedHelp
{
    param($a="A", $b="B")

    ($a, $b) -join ' '
}

この関数を定義した後に、Get-Helpしたときの表示例を示す。このような表示されない場合は必須のキーワードが足りていないか、タイプミス等の可能性がある。

Get-Help Test-CommentBasedHelp
(out)
(out)名前
(out)    Test-CommentBasedHelp
(out)    
(out)概要
(out)    概要：○○する関数
(out)    
(out)    
(out)構文
(out)    Test-CommentBasedHelp [[-a]