Udostępnij za pomocą


UseShouldProcessForStateChangingFunctions

poziom ważności: ostrzeżenie

Opis

Funkcje, których czasowniki zmieniają stan systemu, powinny obsługiwać ShouldProcess. Aby włączyć funkcję ShouldProcess, ustaw argument SupportsShouldProcess w atrybucie CmdletBinding. Argument SupportsShouldProcess dodaje parametry Confirm i WhatIf funkcji. Parametr Confirm monituje użytkownika przed uruchomieniem polecenia dla każdego obiektu w potoku. Parametr WhatIf zawiera listę zmian, które należy wprowadzić w poleceniu, zamiast uruchamiać polecenie .

Czasowniki, które powinny obsługiwać ShouldProcess:

  • New
  • Set
  • Remove
  • Start
  • Stop
  • Restart
  • Reset
  • Update

Jak

Uwzględnij argument SupportsShouldProcess w atrybucie CmdletBinding.

Przykład

Błędny

function Set-ServiceObject
{
    [CmdletBinding()]
    param
    (
        [string]
        $Parameter1
    )
    ...
}

Poprawny

function Set-ServiceObject
{
    [CmdletBinding(SupportsShouldProcess = $true)]
    param
    (
        [string]
        $Parameter1
    )
    ...
}

Więcej informacji