コマンドレット説明書【Expand-Archive】の使い方 (PowerShell v5.1)

こんにちは。チェシャ男です。(-皿-)

今回は、Expand-Archive について概要から使用例について簡単にご紹介します。

「コマンドレットリファレンス」カテゴリの記事では省略している情報を参照したい場合に本記事をご覧ください。

はじめに

本記事は英語のリファレンス情報しかないコマンドレットについて「Get-Help」等の情報を参考に検証した結果を掲載しています。公式見解ではないことにご注意ください。

正式なヘルプを参照したい場合は、「Get-help Expand-Archive -online」を実行し公式ヘルプをご覧ください。

また、本記事内の例は動作を確認していますが、動作を確約しているわけではありません。

Expand-Archive の概要

Expand-Archive では、指定された ZIPファイル（アーカイブ）からファイルを抽出・解凍します。

[blogcard url=”https://cheshire-wara.com/powershell/ps-cmdlets/item-file/expand-archive/”]

基本の構文

#パターン①
Expand-Archive [[-DestinationPath] <String>] [-Confirm] [-Force] -LiteralPath <String> [-WhatIf] [<CommonParameters>]

#パターン②
Expand-Archive [-Path] <String> [[-DestinationPath] <String>] [-Confirm] [-Force] [-WhatIf] [<CommonParameters>]

[] で囲まれたパラメーターは任意のオプションです。
{}で囲まれた箇所は要素を選択してください。
<>で囲まれた箇所はオブジェクトの型名を示しています。

動作の説明

Expand-Archiveコマンドレットは、指定された圧縮ファイル（アーカイブ）を指定された保存先フォルダに解凍（抽出）します。

アーカイブファイルとは、複数のファイルを1つのZIPファイルにパッケージ化したものです。必要に応じて圧縮することで配布しやすくなります。

各パラメータについて

-Confirm [<SwitchParameter>]

コマンドレットを実行する前に確認を求めるプロンプトが表示されます。

-DestinationPath <String>

解凍したファイルの保存先パスを指定します。このパラメータは必須です。

フォルダへのパスを指定します。（ファイル名またはファイル名の拡張子は指定しないでください。）

-Force [<SwitchParameter>]

ユーザーの確認を求めずにコマンドを強制実行します。

-LiteralPath

アーカイブファイルへのパスを指定します。

Pathパラメーターとは異なり LiteralPath に指定された値通りに使用されます。文字はワイルドカードとして解釈されません。

パスにエスケープ文字が含まれている場合は、各エスケープ文字を一重引用符で囲んで、エスケープシーケンスとして解釈されないように指示します。

-Path <String[]>

アーカイブファイルへのパスを指定します。

Pathパラメータにはワイルドカード文字を使用できます。

-WhatIf [<SwitchParameter>]

コマンドレットは実際には実行されず、コマンドレットが実行された場合の動作を示します。

<CommonParameters>

このコマンドレットでは、

Verbose、Debug、ErrorAction、ErrorVariable、WarningAction、WarningVariable、OutBuffer、PipelineVariable、OutVariable

の各共通パラメーターを使用することができます。

入力値

System.String

（パスを含む文字列を1つまたは複数のファイルにパイプすることができます。

出力値

System.IO.FileInfo or System.IO.DirectoryInfo

使用例

例1：アーカイブの内容を解凍する

PS C:\> Expand-Archive -Path C:\Archives\Draft.zip -DestinationPath C:\work\

この例では、既存のアーカイブファイル「C:\Archives\Draft」の内容を“-DestinationPath”パラメータで指定されたフォルダ「C:\work\」に解凍します。

例2：現在のフォルダ内のアーカイブの内容を解凍する

PS C:\> Expand-Archive -Path .\Draft.zip -DestinationPath C:\work\

この例では、現在のフォルダにある既存のアーカイブファイル「Draft.zip」の内容を“-DestinationPath”パラメータで指定されたフォルダ「C:\work\」に解凍します。