Compartilhar via

UseShouldProcessForStateChangingFunctions

Nível de gravidade: aviso

Descrição

Funções cujos verbos alteram o estado do sistema devem dar suporte a ShouldProcess. Para habilitar o recurso ShouldProcess, defina o argumento SupportsShouldProcess no atributo CmdletBinding. O argumento SupportsShouldProcess adiciona parâmetros Confirmar e WhatIf à função. O parâmetro Confirme solicita ao usuário antes de executar o comando em cada objeto no pipeline. O parâmetro WhatIf lista as alterações que o comando faria, em vez de executar o comando.

Verbos que devem dar suporte a ShouldProcess:

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

Como

Inclua o argumento SupportsShouldProcess no atributo CmdletBinding.

Exemplo

Errado

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

Correto

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

Mais informações

  • Last updated on