Compartir a través de

UseShouldProcessForStateChangingFunctions

Nivel de gravedad de : advertencia

Descripción

Funciones cuyos verbos cambian el estado del sistema deben admitir ShouldProcess. Para habilitar la característica ShouldProcess, establezca el argumento SupportsShouldProcess en el atributo CmdletBinding. El argumento SupportsShouldProcess agrega parámetros Confirm y WhatIf a la función. El parámetro Confirm solicita al usuario antes de ejecutar el comando en cada objeto de la canalización. El parámetro WhatIf enumera los cambios que realizaría el comando, en lugar de ejecutar el comando.

Verbos que deben admitir ShouldProcess:

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

Cómo

Incluya el argumento SupportsShouldProcess en el atributo CmdletBinding.

Ejemplo

Incorrecto

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

Correcto

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

Más información

  • Last updated on