アクティビティのパラメーター

次の表に、アクティビティ パラメーターに推奨される名前と機能を示します。

パラメーター	機能
Append データ型: SwitchParameter	ユーザーがパラメーターを指定したときにリソースの末尾にコンテンツを追加できるように、このパラメーターを実装します。
[CaseSensitive] データ型: SwitchParameter	ユーザーがパラメーターを指定するときに大文字と小文字の区別を要求できるように、このパラメーターを実装します。
Command データ型: String	ユーザーが実行するコマンド文字列を指定できるように、このパラメーターを実装します。
CompatibleVersion データ型: System.Version オブジェクト	ユーザーが以前のバージョンとの互換性のためにコマンドレットと互換性がある必要があるセマンティクスを指定できるように、このパラメーターを実装します。
Compress データ型: SwitchParameter	パラメーターが指定されたときにデータ圧縮が使用されるように、このパラメーターを実装します。
Compress データ型: Keyword	ユーザーがデータ圧縮に使用するアルゴリズムを指定できるように、このパラメーターを実装します。
Continuous データ型: SwitchParameter	パラメーターが指定されたときにユーザーがコマンドレットを終了するまでデータが処理されるように、このパラメーターを実装します。 パラメーターが指定されていない場合、コマンドレットは定義済みの量のデータを処理し、操作を終了します。
Create データ型: SwitchParameter	このパラメーターを実装して、パラメーターの指定時にリソースがまだ存在しない場合にリソースが作成されることを示します。
Delete データ型: SwitchParameter	パラメーターが指定されたときにコマンドレットの操作が完了したときにリソースが削除されるように、このパラメーターを実装します。
Drain データ型: SwitchParameter	このパラメーターを実装して、パラメーターが指定されたときにコマンドレットが新しいデータを処理する前に未処理の作業項目が処理されることを示します。 パラメーターが指定されていない場合、作業項目はすぐに処理されます。
Erase データ型: Int32	ユーザーが削除される前にリソースを消去する回数を指定できるように、このパラメーターを実装します。
[ErrorLevel] データ型: Int32	ユーザーがレポートするエラーのレベルを指定できるように、このパラメーターを実装します。
Exclude (除外) データ型: String[]	ユーザーがアクティビティから何かを除外できるように、このパラメーターを実装します。 入力フィルターの使用方法の詳細については、「 入力フィルター パラメーター」を参照してください。
Assert データ型: Keyword	ユーザーがコマンドレット アクションを実行するリソースを選択するフィルターを指定できるように、このパラメーターを実装します。 入力フィルターの使用方法の詳細については、「 入力フィルター パラメーター」を参照してください。
こちらに従ってください データ型: SwitchParameter	パラメーターが指定されたときに進行状況が追跡されるように、このパラメーターを実装します。
Force データ型: SwitchParameter	このパラメーターを実装して、パラメーターが指定されたときに制限が発生した場合でも、ユーザーがアクションを実行できることを示します。 このパラメーターでは、セキュリティを侵害することはできません。 たとえば、このパラメーターを使用すると、ユーザーは読み取り専用ファイルを上書きできます。
Include データ型: String[]	ユーザーがアクティビティに何かを含めることができるように、このパラメーターを実装します。 入力フィルターの使用方法の詳細については、「 入力フィルター パラメーター」を参照してください。
Incremental データ型: SwitchParameter	このパラメーターを実装して、パラメーターが指定されたときに処理が増分実行されることを示します。 たとえば、このパラメーターを使用すると、ユーザーは前回のバックアップ以降にのみファイルをバックアップする増分バックアップを実行できます。
入力Object データ型: Object	コマンドレットが他のコマンドレットから入力を受け取るときに、このパラメーターを実装します。 InputObject パラメーターを定義するときは、Parameter 属性を宣言するときに 常に ValueFromPipeline キーワードを指定します。 入力フィルターの使用方法の詳細については、「 入力フィルター パラメーター」を参照してください。
Insert データ型: SwitchParameter	パラメーターが指定されたときにコマンドレットによって項目が挿入されるように、このパラメーターを実装します。
対話 データ型: SwitchParameter	パラメーターが指定されたときにコマンドレットがユーザーと対話形式で動作するように、このパラメーターを実装します。
Interval データ型: HashTable	ユーザーが値を含むキーワードのハッシュ テーブルを指定できるように、このパラメーターを実装します。 次の例は、パラメーター-interval @{ResumeScan=15; Retry=3}のサンプル値を Interval 示しています。
Log データ型: SwitchParameter	このパラメーターを実装すると、パラメーターが指定されたときにコマンドレットのアクションが監査されます。
NoClobber データ型: SwitchParameter	パラメーターが指定されたときにリソースが上書きされないように、このパラメーターを実装します。 通常、このパラメーターは、同じ名前の既存のオブジェクトを上書きできないように、新しいオブジェクトを作成するコマンドレットに適用されます。
Notify データ型: SwitchParameter	パラメーターが指定されたときにアクティビティが完了したことをユーザーに通知するように、このパラメーターを実装します。
NotifyAddress データ型: 電子メール アドレス	ユーザーがパラメーターを指定したときに通知を送信するために使用する電子メール アドレスを指定できるように、このパラメーターを Notify 実装します。
Overwrite データ型: SwitchParameter	パラメーターが指定されたときにコマンドレットによって既存のデータが上書きされるように、このパラメーターを実装します。
Prompt データ型: String	ユーザーがコマンドレットのプロンプトを指定できるように、このパラメーターを実装します。
Quiet データ型: SwitchParameter	このパラメーターを実装して、パラメーターが指定されたときに、コマンドレットがアクション中にユーザーのフィードバックを抑制できるようにします。
Recurse データ型: SwitchParameter	パラメーターが指定されたときにコマンドレットがリソースに対してアクションを再帰的に実行するように、このパラメーターを実装します。
修復 データ型: SwitchParameter	このパラメーターを実装して、パラメーターが指定されたときに壊れた状態から何かを修正するようにします。
修理String データ型: String	Repair パラメーターが指定されたときに使用する文字列をユーザーが指定できるように、このパラメーターを実装します。
Retry データ型: Int32	ユーザーがコマンドレットでアクションを試行する回数を指定できるように、このパラメーターを実装します。
Select データ型: Keyword array	ユーザーが項目の種類を指定できるように、 array このパラメーターを実装します。
Stream データ型: SwitchParameter	パラメーターが指定されたときに、ユーザーがパイプラインを介して複数の出力オブジェクトをストリーミングできるように、このパラメーターを実装します。
Strict データ型: SwitchParameter	パラメーターが指定されたときに、すべてのエラーが終了エラーとして処理されるように、このパラメーターを実装します。
TempLocation データ型: String	ユーザーがコマンドレットの操作中に使用される一時データの場所を指定できるように、このパラメーターを実装します。
タイムアウト データ型: Int32	ユーザーがタイムアウト間隔 (ミリ秒単位) を指定できるように、このパラメーターを実装します。
Truncate データ型: SwitchParameter	パラメーターが指定されたときにコマンドレットがアクションを切り捨てるように、このパラメーターを実装します。 パラメーターが指定されていない場合、コマンドレットは別のアクションを実行します。
Verify データ型: SwitchParameter	このパラメーターを実装して、パラメーターが指定されたときにアクションが発生したかどうかを判断するコマンドレットをテストします。
Wait データ型: SwitchParameter	このパラメーターを実装して、パラメーターが指定されたときにコマンドレットがユーザー入力を待機してから続行できるようにします。
WaitTime データ型: Int32	Wait パラメーターが指定されたときにコマンドレットがユーザー入力を待機する期間 (秒単位) をユーザーが指定できるように、このパラメーターを実装します。

関連項目

コマンドレットのパラメーター

Windows PowerShell コマンドレットの記述

Windows PowerShell SDK