以下に、Copy-Itemコマンドレットのすべてのオプションと例を、より詳しくわかりやすく説明した表をまとめました。
| オプション | 説明 | 例 |
|---|---|---|
-Path |
コピーするアイテムのパスを指定します。複数のパスを指定することも可能です。相対パスまたは絶対パスを使用できます。 | Copy-Item -Path "C:\\\\source\\\\file.txt" |
-Destination |
アイテムをコピーする先のパスを指定します。存在しないディレクトリを指定すると、自動的に作成されます。 | Copy-Item -Path "C:\\\\source\\\\file.txt" -Destination "C:\\\\destination" |
-Container |
コピー元のディレクトリ構造を保持するかどうかを指定します。デフォルトは$trueで、サブディレクトリも含めてコピーします。 |
Copy-Item -Path "C:\\\\source" -Destination "C:\\\\destination" -Container $false |
-Credential |
コピー操作に使用するユーザーの資格情報を指定します。ネットワークパスやリモートサーバーにアクセスする際に使用します。 | $cred = Get-Credential; Copy-Item -Path "\\\\\\\\server\\\\share\\\\file.txt" -Destination "C:\\\\destination" -Credential $cred |
-Exclude |
コピー操作から除外するアイテムのパターンを指定します。ワイルドカード文字（*や?）を使用して特定のファイルやフォルダを除外できます。 |
Copy-Item -Path "C:\\\\source\\\\*" -Destination "C:\\\\destination" -Exclude "*.tmp" |
-Filter |
コピー操作で使用するフィルターを指定します。特定のファイルタイプや名前にマッチするアイテムだけをコピーします。 | Copy-Item -Path "C:\\\\source\\\\*" -Destination "C:\\\\destination" -Filter "*.txt" |
-Force |
読み取り専用ファイルや隠しファイルなど、通常はコピーできないアイテムを強制的にコピーします。 | Copy-Item -Path "C:\\\\source\\\\file.txt" -Destination "C:\\\\destination" -Force |
-Include |
コピー操作に含めるアイテムのパターンを指定します。ワイルドカード文字を使用して特定のファイルやフォルダを指定できます。 | Copy-Item -Path "C:\\\\source\\\\*" -Destination "C:\\\\destination" -Include "*.txt" |
-PassThru |
コピーされたアイテムを出力オブジェクトとして返します。これにより、パイプラインでの後続処理が可能になります。 | Copy-Item -Path "C:\\\\source\\\\file.txt" -Destination "C:\\\\destination" -PassThru |
-Recurse |
指定したディレクトリとそのサブディレクトリ内のすべてのアイテムを再帰的にコピーします。サブフォルダ内のファイルもすべてコピーします。 | Copy-Item -Path "C:\\\\source" -Destination "C:\\\\destination" -Recurse |
-Verbose |
コマンドの実行中に詳細な操作情報を表示します。デバッグやトラブルシューティングに役立ちます。 | Copy-Item -Path "C:\\\\source\\\\file.txt" -Destination "C:\\\\destination" -Verbose |
-WhatIf |
コマンドを実行した場合にどのような動作になるかを表示しますが、実際には実行しません。安全にコマンドの結果を確認するのに役立ちます。 | Copy-Item -Path "C:\\\\source\\\\file.txt" -Destination "C:\\\\destination" -WhatIf |
-Confirm |
コマンドを実行する前に確認を求めます。誤操作を防止するために使用します。 | Copy-Item -Path "C:\\\\source\\\\file.txt" -Destination "C:\\\\destination" -Confirm |
-ErrorAction |
エラー発生時の動作を指定します。例えば、エラーが発生した場合にスクリプトの実行を停止するなどの制御が可能です。 | Copy-Item -Path "C:\\\\source\\\\file.txt" -Destination "C:\\\\destination" -ErrorAction Stop |
-ErrorVariable |
エラー情報を格納する変数を指定します。エラーの詳細を後で参照するために使用できます。 | Copy-Item -Path "C:\\\\source\\\\file.txt" -Destination "C:\\\\destination" -ErrorVariable myError |
-OutVariable |
出力情報を格納する変数を指定します。コマンドの出力を変数に保存して後で使用することができます。 | Copy-Item -Path "C:\\\\source\\\\file.txt" -Destination "C:\\\\destination" -OutVariable myOutput |
-OutBuffer |
出力バッファのサイズを指定します。大きな出力を扱う際に、バッファサイズを調整するために使用します。 | Copy-Item -Path "C:\\\\source\\\\file.txt" -Destination "C:\\\\destination" -OutBuffer 10 |
-UseTransaction |
トランザクション内でコマンドを実行するかどうかを指定します。トランザクションは、一連の操作をまとめて実行し、途中で失敗した場合にすべてをロールバックするのに使用します。 | Copy-Item -Path "C:\\\\source\\\\file.txt" -Destination "C:\\\\destination" -UseTransaction |