Review of ConfirmImpact/ConfirmPreference comparison

[jikuja]

Type of issue

Other (describe below)

Feedback

If Confirm parameter is not used, the ShouldProcess() call requests confirmation if the $ConfirmPreference preference variable is equal to or greater than the ConfirmImpact setting of the cmdlet or provider.

If I understood other sources correctly the comparison is being inverted here.

There should be larger rewiew and update if the logic is

IF ConfirmImpact >= ConfirmPreference 
THEN prompt

or

IF ConfirmImpact > ConfirmPreference 
THEN prompt

Other sources / analysis:

• https://learn.microsoft.com/en-us/dotnet/api/system.management.automation.confirmimpact?view=powershellsdk-7.4.0

  • Operations with ConfirmImpact equal to or greater than $ConfirmPreference are confirmed
  • IF ConfirmImpact >= ConfirmPreference THEN prompt
  • Also:
    • Operations with ConfirmImpact.None are never confirmed
    • no operations are confirmed when $ConfirmPreference is ConfirmImpact.None (except when explicitly requested with -Confirm).

• https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_preference_variables?view=powershell-7.4

  • When the value of the $ConfirmPreference variable is less than or equal to the risk assigned to a cmdlet or function, PowerShell automatically prompts you for confirmation before running the cmdlet or function.
  • IF ConfirmPreference <= ConfirmImpact THEN prompt
  • IF ConfirmImpact > ConfirmPreference THEN prompt

• https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_functions_cmdletbindingattribute?view=powershell-7.4

  • The call to the ShouldProcess method displays a confirmation prompt only when the ConfirmImpact argument is equal to or greater than the value of the $ConfirmPreference preference variable.
  • IF ConfirmImpact >= ConfirmPreference THEN prompt

• https://learn.microsoft.com/en-us/powershell/scripting/developer/cmdlet/users-requesting-confirmation?view=powershell-7.4

  • If Confirm parameter is not used, the ShouldProcess() call requests confirmation if the $ConfirmPreference preference variable is equal to or greater than the ConfirmImpact setting of the cmdlet or provider.
  • IF ConfirmPreference >= ConfirmImpact THEN prompt
  • IF ConfirmImpact < ConfirmPreference THEN prompt

• https://github.com/PowerShell/PowerShell/blob/master/src/System.Management.Automation/engine/MshCommandRuntime.cs#L1456-L1461

  • IF ((threshold == ConfirmImpact.None) || (threshold > cmdletConfirmImpact)) THEN autoconfirm
  • => IF ConfirmPreference <= ConfirmImpact THEN prompt
  • IF ConfirmImpact > ConfirmPreference THEN prompt

Page URL

https://learn.microsoft.com/en-us/powershell/scripting/developer/cmdlet/users-requesting-confirmation?view=powershell-7.4

Content source URL

https://github.com/MicrosoftDocs/PowerShell-Docs/blob/main/reference/docs-conceptual/developer/cmdlet/users-requesting-confirmation.md

Author

@sdwheeler

Document Id

52e61b94-396a-b5aa-5b39-b79a0e74a8d3