Bagikan melalui


UseShouldProcessForStateChangingFunctions

Tingkat Keparahan : Peringatan

Deskripsi

Fungsi yang kata kerjanya mengubah status sistem harus mendukung ShouldProcess. Untuk mengaktifkan fitur ShouldProcess, atur argumen SupportsShouldProcess di atribut CmdletBinding. Argumen SupportsShouldProcess menambahkan parameter Konfirmasi dan WhatIf ke fungsi. Parameter Konfirmasi meminta pengguna sebelum menjalankan perintah pada setiap objek dalam alur. Parameter WhatIf mencantumkan perubahan yang akan dilakukan perintah, alih-alih menjalankan perintah.

Kata kerja yang harus mendukung ShouldProcess:

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

Bagaimana

Sertakan argumen SupportsShouldProcess dalam atribut CmdletBinding.

Contoh

Salah

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

Benar

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

Informasi selengkapnya