ユーザーの確認要求

コマンドレット属性宣言の パラメーターに の値を指定すると、Confirm パラメーターがコマンドレットの true SupportsShouldProcess パラメーターに追加されます。

既定の環境では、ユーザーは Confirm パラメーターを指定するか、メソッドの呼び出し時に確認 "-Confirm:$true ShouldProcess() が要求されます。 これにより、影響レベルの設定に関係なく、確認が強制的に行います。

Confirm パラメーター を使用しない場合、呼び出しは、基本設定変数がコマンドレットまたはプロバイダーの設定以上の場合に確認 ShouldProcess() $ConfirmPreference ConfirmImpact を要求します。 の既定の設定は $ConfirmPreference High です。 そのため、既定の環境では、影響の大きなアクション要求の確認を指定するコマンドレットとプロバイダーのみです。

Confirm 明示的に false ( ) に設定されている場合、コマンドレットは確認を求めずに実行され、 -Confirm:$false $ConfirmPreference シェル変数は無視されます。

解説

  • を指定するが、 を指定しないコマンドレットとプロバイダーの場合、これらのアクションは "中程度の影響" アクションとして処理され、既定ではプロンプト SupportsShouldProcess ConfirmImpact は表示されません。 影響レベルは、基本設定変数の既定の設定より $ConfirmPreference 小さい値です。

  • ユーザーがパラメーターを指定すると、確認を求めなくても操作 Verbose が通知されます。

参照