tentang Parameter Umum

Deskripsi singkat

Menjelaskan parameter yang dapat digunakan dengan cmdlet apa pun.

Deskripsi panjang

Parameter umum adalah sekumpulan parameter cmdlet yang dapat Anda gunakan dengan cmdlet apa pun. Mereka diimplementasikan oleh PowerShell, bukan oleh pengembang cmdlet, dan secara otomatis tersedia untuk cmdlet apa pun.

Anda dapat menggunakan parameter umum dengan cmdlet apa pun, tetapi mungkin tidak berpengaruh pada semua cmdlet. Misalnya, jika cmdlet tidak menghasilkan output verbose apa pun, menggunakan parameter umum Verbose tidak berpengaruh.

Parameter umum juga tersedia pada fungsi lanjutan yang menggunakan CmdletBinding atribut atau Parameter atribut . Saat Anda menggunakan atribut ini, PowerShell secara otomatis menambahkan Parameter Umum. Anda tidak dapat membuat parameter apa pun yang menggunakan nama yang sama dengan Parameter Umum.

Beberapa parameter umum mengambil alih default atau preferensi sistem yang Anda tetapkan menggunakan variabel preferensi PowerShell. Tidak seperti variabel preferensi, parameter umum hanya memengaruhi perintah tempat mereka digunakan.

Untuk informasi selengkapnya, lihat about_Preference_Variables.

Daftar berikut menampilkan parameter umum. Aliasnya tercantum dalam tanda kurung.

DebugAku akan menemuinya.db
ErrorActionAku akan menemuinya.ea
ErrorVariableAku akan menemuinya.ev
InformationActionAku akan menemuinya.infa
InformationVariableAku akan menemuinya.iv
OutVariableAku akan menemuinya.ov
OutBufferAku akan menemuinya.ob
PipelineVariableAku akan menemuinya.pv
ProgressActionAku akan menemuinya.proga
VerboseAku akan menemuinya.vb
WarningActionAku akan menemuinya.wa
WarningVariableAku akan menemuinya.wv

Parameter Tindakan adalah ActionPreference nilai jenis. ActionPreference adalah enumerasi dengan nilai berikut:

Nama	Nilai
`Break`	6
`Suspend`	5
`Ignore`	4
`Inquire`	3
`Continue`	2
`Stop`	1
`SilentlyContinue`	0

Anda dapat menggunakan nama atau nilai dengan parameter .

Selain parameter umum, banyak cmdlet menawarkan parameter mitigasi risiko. Cmdlet yang melibatkan risiko terhadap sistem atau data pengguna biasanya menawarkan parameter ini.

Parameter mitigasi risiko adalah:

WhatIf (Wi)
Confirm (lih)

Parameter umum

-Debug

Menampilkan detail tingkat programmer tentang operasi yang dilakukan oleh perintah. Parameter ini hanya berfungsi ketika perintah menghasilkan pesan penelusuran kesalahan. Misalnya, parameter ini berfungsi saat perintah berisi Write-Debug cmdlet.

Type: SwitchParameter
Aliases: db
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Secara default, pesan penelusuran kesalahan tidak ditampilkan karena nilai $DebugPreference variabel adalah SilentlyContinue.

Parameter Debug mengambil alih nilai $DebugPreference variabel untuk perintah saat ini, mengatur nilai $DebugPreference ke Continue.

-Debug:$true memiliki efek yang sama dengan -Debug. Gunakan -Debug:$false untuk menekan tampilan pesan penelusuran kesalahan saat $DebugPreference tidak SilentlyContinue, yang merupakan default.

-ErrorAction

Menentukan bagaimana cmdlet merespons kesalahan yang tidak mengakhiri dari perintah. Parameter ini hanya berfungsi ketika perintah menghasilkan kesalahan yang tidak mengakhiri, seperti yang berasal dari Write-Error cmdlet.

Type: ActionPreference
Aliases: ea
Accepted values: Break, Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

Parameter ErrorAction mengambil alih nilai $ErrorActionPreference variabel untuk perintah saat ini. Karena nilai $ErrorActionPreference default variabel adalah Continue, pesan kesalahan ditampilkan dan eksekusi berlanjut kecuali Anda menggunakan ErrorAction parameter .

Parameter ErrorAction tidak berpengaruh pada penghentian kesalahan (seperti data yang hilang, parameter yang tidak valid, atau tidak cukup izin) yang mencegah perintah berhasil diselesaikan.

Break Masukkan debugger ketika terjadi kesalahan atau pengecualian dimunculkan.
Continue menampilkan pesan kesalahan dan melanjutkan menjalankan perintah. Continue adalah defaultnya.
Ignore menyembunyikan pesan kesalahan dan terus menjalankan perintah. Tidak seperti SilentlyContinue, Ignore tidak menambahkan pesan kesalahan ke $Error variabel otomatis. Nilai Ignore diperkenalkan di PowerShell 3.0.
Inquire menampilkan pesan kesalahan dan meminta konfirmasi sebelum melanjutkan eksekusi. Nilai ini jarang digunakan.
SilentlyContinue menyembunyikan pesan kesalahan dan terus menjalankan perintah.
Stop menampilkan pesan kesalahan dan berhenti menjalankan perintah.
Suspend hanya tersedia untuk alur kerja yang tidak didukung di PowerShell 6 dan yang lebih baru.

Catatan

Parameter ErrorAction mengambil alih, tetapi tidak menggantikan nilai $ErrorActionPreference variabel saat parameter digunakan dalam perintah untuk menjalankan skrip atau fungsi.

-ErrorVariable

Rekaman kesalahan secara otomatis disimpan dalam $Error variabel otomatis. Untuk informasi selengkapnya, lihat about_Automatic_Variables.

Saat Anda menggunakan ErrorVariable parameter pada perintah, PowerShell juga menyimpan rekaman kesalahan yang dipancarkan oleh perintah dalam variabel yang ditentukan oleh parameter .

Type: String
Aliases: ev
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Secara default, pesan kesalahan baru menimpa pesan kesalahan yang sudah disimpan dalam variabel. Untuk menambahkan pesan kesalahan ke konten variabel, letakkan tanda plus (+) sebelum nama variabel.

Misalnya, perintah berikut membuat $a variabel lalu menyimpan kesalahan apa pun di dalamnya:

Get-Process -Id 6 -ErrorVariable a

Perintah berikut menambahkan pesan kesalahan apa pun ke $a variabel:

Get-Process -Id 2 -ErrorVariable +a

Perintah berikut menampilkan konten $a:

$a

Anda dapat menggunakan parameter ini untuk membuat variabel yang hanya berisi pesan kesalahan dari perintah tertentu dan tidak memengaruhi perilaku $Error variabel otomatis. Variabel $Error otomatis berisi pesan kesalahan dari semua perintah dalam sesi. Anda dapat menggunakan notasi array, seperti $a[0] atau $Error[1,2] untuk merujuk ke kesalahan tertentu yang disimpan dalam variabel.

Catatan

Variabel kesalahan kustom berisi semua kesalahan yang dihasilkan oleh perintah, termasuk kesalahan dari panggilan ke fungsi atau skrip berlapis.

-InformationAction

Diperkenalkan di PowerShell 5.0. Dalam perintah atau skrip tempat parameter digunakan, InformationAction parameter umum mengambil alih nilai $InformationPreference variabel preferensi, yang secara default diatur ke SilentlyContinue. Saat Anda menggunakan Write-Information dalam skrip dengan InformationAction, Write-Information nilai ditampilkan tergantung pada nilai InformationAction parameter. Untuk informasi selengkapnya tentang $InformationPreference, lihat about_Preference_Variables.

Type: ActionPreference
Aliases: infa
Accepted values: Break, Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

Break Memasukkan debugger pada kemunculan Write-Information perintah.
Stop menghentikan perintah atau skrip pada kemunculan Write-Information perintah.
Ignore menekan pesan informasi dan terus menjalankan perintah. Tidak seperti SilentlyContinue, Ignore sepenuhnya melupakan pesan informasi; itu tidak menambahkan pesan informasi ke aliran informasi.
Inquire menampilkan pesan informasi yang Anda tentukan dalam Write-Information perintah, lalu menanyakan apakah Anda ingin melanjutkan.
Continue menampilkan pesan informasi, dan terus berjalan.
Suspend tidak didukung di PowerShell 6 dan yang lebih tinggi karena hanya tersedia untuk alur kerja.
SilentlyContinue tidak ada efek karena pesan informasi tidak (Default) ditampilkan, dan skrip berlanjut tanpa gangguan.

Catatan

Parameter InformationAction mengambil alih, tetapi tidak menggantikan nilai $InformationAction variabel preferensi saat parameter digunakan dalam perintah untuk menjalankan skrip atau fungsi.

-InformationVariable

Diperkenalkan di PowerShell 5.0. Saat Anda menggunakan InformationVariable parameter umum, rekaman informasi disimpan dalam variabel yang ditentukan oleh parameter . Dan cmdlet PowerShell dapat menulis rekaman informasi ke Information aliran. Anda juga dapat menggunakan Write-Information cmdlet untuk menulis rekaman informasi.

Rekaman informasi ditampilkan sebagai pesan di konsol secara default. Anda dapat mengontrol tampilan rekaman informasi dengan menggunakan InformationAction parameter umum. Anda juga dapat mengubah perilaku menggunakan $InformationPreference variabel preferensi. Untuk informasi selengkapnya tentang $InformationPreference, lihat about_Preference_Variables.

Catatan

Variabel informasi berisi semua pesan informasi yang dihasilkan oleh perintah, termasuk pesan informasi dari panggilan ke fungsi atau skrip berlapis.

Type: String
Aliases: iv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Secara default, rekaman informasi baru menimpa nilai yang sudah disimpan dalam variabel. Untuk menambahkan pesan kesalahan ke konten variabel, letakkan tanda plus (+) sebelum nama variabel.

-OutBuffer

Menentukan jumlah objek yang akan terakumulasi dalam buffer sebelum objek dikirim melalui alur. Jika Anda menghilangkan parameter ini, objek dikirim saat dibuat.

Type: Int32
Aliases: ob
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Parameter manajemen sumber daya ini dirancang untuk pengguna tingkat lanjut. Saat Anda menggunakan parameter ini, PowerShell mengirim data ke cmdlet berikutnya dalam batch OutBuffer + 1.

Contoh berikut bergantian ditampilkan antara untuk ForEach-Object memproses blok yang menggunakan Write-Host cmdlet. Tampilan bergantian dalam batch 2 atau OutBuffer + 1.

1..4 | ForEach-Object {
        Write-Host "$($_): First"; $_
      } -OutBuffer 1 | ForEach-Object {
                        Write-Host "$($_): Second" }

1: First
2: First
1: Second
2: Second
3: First
4: First
3: Second
4: Second

-OutVariable

Menyimpan objek output dari perintah dalam variabel yang ditentukan selain mengirim output di sepanjang alur.

Type: String
Aliases: ov
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Untuk menambahkan output ke variabel, alih-alih mengganti output apa pun yang mungkin sudah disimpan di sana, ketik tanda plus (+) sebelum nama variabel.

Misalnya, perintah berikut membuat $out variabel dan menyimpan objek proses di dalamnya:

Get-Process powershell -OutVariable out

Perintah berikut menambahkan objek proses ke $out variabel:

Get-Process iexplore -OutVariable +out

Perintah berikut menampilkan konten $out variabel:

$out

Catatan

Variabel yang OutVariable dibuat oleh parameter adalah [System.Collections.ArrayList].

-PipelineVariable

PipelineVariable memungkinkan akses ke nilai terbaru yang diteruskan ke segmen alur berikutnya oleh perintah yang menggunakan parameter ini. Perintah apa pun dalam alur dapat mengakses nilai menggunakan bernama PipelineVariable. Nilai ditetapkan ke variabel ketika diteruskan ke segmen alur berikutnya. Ini membuat PipelineVariable lebih mudah digunakan daripada variabel sementara tertentu, yang mungkin perlu ditetapkan di beberapa lokasi.

Tidak seperti $_ atau $PSItem, menggunakan PipelineVariable perintah memungkinkan setiap perintah alur untuk mengakses nilai alur yang diteruskan (dan disimpan) oleh perintah selain perintah sebelumnya segera. Perintah alur dapat mengakses nilai terakhir yang disalurkan saat memproses item berikutnya yang melewati alur. Ini memungkinkan perintah untuk mengumpankan kembali outputnya ke perintah sebelumnya (atau itu sendiri).

Catatan

Fungsi tingkat lanjut dapat memiliki hingga tiga blokir skrip: begin, , processdan end. Saat menggunakan PipelineVariable parameter dengan fungsi tingkat lanjut, hanya nilai dari blok skrip pertama yang ditentukan yang ditetapkan ke variabel saat fungsi berjalan. Untuk informasi selengkapnya, lihat Fungsi tingkat lanjut. PowerShell 7.2 mengoreksi perilaku ini.

Type: String
Aliases: pv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Nilai yang valid adalah string, sama seperti untuk nama variabel apa pun.

Perhatian

PipelineVariable dilingkup ke alur tempat alur dipanggil. Variabel di luar alur, yang menggunakan nama yang sama, dibersihkan sebelum alur dijalankan. Keluar PipelineVariable dari cakupan ketika alur berakhir. Jika beberapa perintah dalam alur menentukan hal yang sama PipelineVariable , maka hanya ada satu variabel bersama. Variabel tersebut diperbarui dengan output piped terbaru dari perintah yang menentukan variabel.

Beberapa perintah pemblokiran mengumpulkan semua item dalam pipeline sebelum menghasilkan keluaran apa pun, misalnya Sort-Object atau Select-Object -Last. Setiap PipelineVariable yang ditetapkan dalam perintah sebelum perintah pemblokiran seperti itu selalu berisi item pipa akhir dari perintah sebelumnya saat digunakan dalam perintah setelah perintah pemblokiran.

Contoh berikut mengilustrasikan cara kerjanya PipelineVariable . Dalam contoh ini, lima angka disalurkan ke perintah pertama ForEach-Object . Setiap item dalam alur disimpan dalam variabel alur bernama $Temp.

Process Blok perintah pertama ForEach-Object menyalurkan item alur ke perintah hilirForEach-Object. Status variabel ditampilkan di setiap langkah.

# Create a variable named $Temp
$Temp = 8
Get-Variable Temp | Format-Table

$InformationPreference = 'Continue'
Write-Information '-------------------------------------------------'
111,222,333,444,555 | ForEach-Object -PipelineVariable Temp -Begin {

  # Note that the newly create $Temp variable doesn't contain the value 8
  # assigned before the pipeline started and that $PSItem is empty in
  # the Begin block.
  Write-Information "Upstream (Begin):   PSItem = '$PSItem', Temp = '$Temp'"

} -Process {

  Write-Information "Upstream (Process): PSItem = '$PSItem', Temp = '$Temp'"
  return $PSItem

} | ForEach-Object -Process {

  Write-Information "`tDownstream: PSItem = '$PSItem', Temp = '$Temp'"

}
Write-Information '-------------------------------------------------'

# The $Temp variable is deleted when the pipeline finishes
Get-Variable Temp | Format-Table

Name                           Value
----                           -----
Temp                           8

-------------------------------------------------
Upstream (Begin):   PSItem = '', Temp = ''
Upstream (Process): PSItem = '111', Temp = ''
        Downstream: PSItem = '111', Temp = '111'
Upstream (Process): PSItem = '222', Temp = '111'
        Downstream: PSItem = '222', Temp = '222'
Upstream (Process): PSItem = '333', Temp = '222'
        Downstream: PSItem = '333', Temp = '333'
Upstream (Process): PSItem = '444', Temp = '333'
        Downstream: PSItem = '444', Temp = '444'
Upstream (Process): PSItem = '555', Temp = '444'
        Downstream: PSItem = '555', Temp = '555'
-------------------------------------------------

Name                           Value
----                           -----
Temp

Perhatian

Ada dua masalah yang diketahui dengan menggunakan PipelineVariable parameter dalam alur yang mencakup cmdlet CimCmdlets atau CDXML. Dalam contoh berikut, Get-Partition adalah fungsi CDXML dan Get-CimInstance merupakan CimCmdlet.

Masalah 1: Fungsi CDXML menggunakan [CmdletBinding()], yang memungkinkan PipelineVariable parameter .

Get-Partition -pv pvar

Namun, saat Anda menggunakan PipelineVariable di Windows PowerShell v5.1, Anda menerima kesalahan berikut.

Get-Partition : Cannot retrieve the dynamic parameters for the cmdlet.
Object reference not set to an instance of an object.

At line:1 char:1
+ get-partition -PipelineVariable pvar
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : InvalidArgument: (:) [Get-Partition], ParameterBindingException
    + FullyQualifiedErrorId : GetDynamicParametersException,Get-Partition

Masalah 2: Ketika perintah sebelumnya bukan perintah CDXML dan hilir berisi salah satu jenis perintah, PipelineVariable tetap sebagai objek akumulasi terakhir.

Get-CimInstance Win32_DiskDrive -pv pvar |
    ForEach-Object {
        Write-Host "Upstream: Disk $($pvar.Index)"
        return [pscustomobject]@{ DiskNumber = $_.Index }
    } | Get-Partition | ForEach-Object {
        Write-Host "Downstream: Disk $($pvar.Index)"
    }

Perhatikan bahwa nilai $pvar diatur ke objek terakhir dalam alur untuk perintah kedua ForEach-Object .

Upstream: Disk 1
Upstream: Disk 2
Upstream: Disk 0
Downstream: Disk 0
Downstream: Disk 0
Downstream: Disk 0
Downstream: Disk 0
Downstream: Disk 0
Downstream: Disk 0

-ProgressAction

Menentukan bagaimana PowerShell merespons pembaruan kemajuan yang dihasilkan oleh skrip, cmdlet, atau penyedia, seperti bilah kemajuan yang dihasilkan oleh cmdlet Write-Progress . Write-Progress Cmdlet membuat bilah kemajuan yang memperlihatkan status perintah. Parameter ProgressAction ditambahkan di PowerShell 7.4.

Parameter ProgressAction mengambil salah ActionPreference satu nilai enumerasi: SilentlyContinue, , Stop, Continue, Inquire, IgnoreSuspend, atau Break.

Nilai yang valid adalah sebagai berikut:

Break Memasukkan debugger pada kemunculan Write-Progress perintah.
Stop: Tidak menampilkan bilah kemajuan. Sebaliknya, ia menampilkan pesan kesalahan dan berhenti mengeksekusi.
Inquire: Tidak menampilkan bilah kemajuan. Meminta izin untuk melanjutkan. Jika Anda membalas dengan Y atau A, maka akan menampilkan bilah kemajuan.
Continue: (Default) Menampilkan bilah kemajuan dan dilanjutkan dengan eksekusi.
SilentlyContinue: Menjalankan perintah, tetapi tidak menampilkan bilah kemajuan.

Type: ActionPreference
Aliases: proga
Accepted values: Break, Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

-Verbose

Menampilkan informasi terperinci tentang operasi yang dilakukan oleh perintah. Informasi ini menyerupan informasi dalam jejak atau dalam log transaksi. Parameter ini hanya berfungsi ketika perintah menghasilkan pesan verbose. Misalnya, parameter ini berfungsi saat perintah berisi Write-Verbose cmdlet.

Type: SwitchParameter
Aliases: vb
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Parameter Verbose mengambil alih nilai $VerbosePreference variabel untuk perintah saat ini. Karena nilai $VerbosePreference default variabel adalah SilentlyContinue, pesan verbose tidak ditampilkan secara default.

-Verbose:$true memiliki efek yang sama dengan -Verbose
-Verbose:$false menekan tampilan pesan verbose. Gunakan parameter ini saat nilai $VerbosePreference tidak SilentlyContinue (default).

-WarningAction

Menentukan bagaimana cmdlet merespons peringatan dari perintah. Continue adalah nilai default. Parameter ini hanya berfungsi ketika perintah menghasilkan pesan peringatan. Misalnya, parameter ini berfungsi saat perintah berisi Write-Warning cmdlet.

Type: ActionPreference
Aliases: wa
Accepted values: Break, Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

Parameter WarningAction mengambil alih nilai $WarningPreference variabel untuk perintah saat ini. Karena nilai $WarningPreference default variabel adalah Continue, peringatan ditampilkan dan eksekusi berlanjut kecuali Anda menggunakan WarningAction parameter .

Break memasukkan debugger saat peringatan terjadi.
Continue menampilkan pesan peringatan dan melanjutkan menjalankan perintah. Continue adalah defaultnya.
Inquire menampilkan pesan peringatan dan meminta konfirmasi sebelum melanjutkan eksekusi. Nilai ini jarang digunakan.
SilentlyContinue menekan pesan peringatan dan terus menjalankan perintah.
Stop menampilkan pesan peringatan dan berhenti menjalankan perintah.

Catatan

Parameter WarningAction mengambil alih, tetapi tidak menggantikan nilai $WarningAction variabel preferensi saat parameter digunakan dalam perintah untuk menjalankan skrip atau fungsi.

-WarningVariable

Menyimpan rekaman peringatan tentang perintah dalam variabel yang ditentukan.

Type: String
Aliases: wv
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Semua peringatan yang dihasilkan disimpan dalam variabel bahkan jika peringatan tidak ditampilkan kepada pengguna.

Untuk menambahkan peringatan ke konten variabel, alih-alih mengganti peringatan apa pun yang mungkin sudah disimpan di sana, ketik tanda plus (+) sebelum nama variabel.

Misalnya, perintah berikut membuat $a variabel lalu menyimpan peringatan apa pun di dalamnya:

Get-Process -Id 6 -WarningVariable a

Perintah berikut menambahkan peringatan apa pun ke $a variabel:

Get-Process -Id 2 -WarningVariable +a

Perintah berikut menampilkan konten $a:

$a

Anda dapat menggunakan parameter ini untuk membuat variabel yang hanya berisi peringatan dari perintah tertentu. Anda dapat menggunakan notasi array, seperti $a[0] atau $warning[1,2] untuk merujuk ke peringatan tertentu yang disimpan dalam variabel.

Catatan

Variabel peringatan berisi semua peringatan yang dihasilkan oleh perintah, termasuk peringatan dari panggilan ke fungsi atau skrip berlapis.

Parameter manajemen risiko

-WhatIf

Menampilkan pesan yang menjelaskan efek perintah, alih-alih menjalankan perintah.

Type: SwitchParameter
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Parameter WhatIf mengambil alih nilai $WhatIfPreference variabel untuk perintah saat ini. Karena nilai $WhatIfPreference default variabel adalah 0 (dinonaktifkan), WhatIf perilaku tidak dilakukan tanpa WhatIf parameter . Untuk informasi selengkapnya, lihat about_Preference_Variables.

$true memiliki efek yang sama dengan -WhatIf.
$false menekan perilaku otomatis WhatIf yang menghasilkan ketika nilai $WhatIfPreference variabel adalah 1.

Misalnya, perintah berikut menggunakan -WhatIf parameter dalam Remove-Item perintah:

Remove-Item Date.csv -WhatIf

Alih-alih menghapus item, PowerShell mencantumkan operasi yang akan dilakukannya dan item yang akan terpengaruh. Perintah ini menghasilkan output berikut:

What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv".

-Confirm

Meminta konfirmasi sebelum menjalankan perintah.

Type: SwitchParameter
Aliases: cf
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

Parameter Confirm mengambil alih nilai $ConfirmPreference variabel untuk perintah saat ini. Nilai defaultnya adalah true. Untuk informasi selengkapnya, lihat about_Preference_Variables.

$true memiliki efek yang sama dengan -Confirm.
$false menekan konfirmasi otomatis, yang terjadi ketika nilai kurang dari $ConfirmPreference atau sama dengan perkiraan risiko cmdlet.

Misalnya, perintah berikut menggunakan Confirm parameter dengan Remove-Item perintah . Sebelum menghapus item, PowerShell mencantumkan operasi yang akan dilakukannya dan item yang akan terpengaruh, dan meminta persetujuan.

PS C:\ps-test> Remove-Item tmp*.txt -Confirm

Confirm
Are you sure you want to perform this action?
Performing operation "Remove File" on Target " C:\ps-test\tmp1.txt
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend
[?] Help (default is "Y"):

Opsi Confirm responsnya adalah sebagai berikut:

Respons	Hasil
`Yes`Aku akan menemuinya.`Y`	Lakukan aksinya.
`Yes to All`Aku akan menemuinya.`A`	Lakukan semua tindakan dan tekan berikutnya Confirm
	kueri untuk perintah ini.
`No` (`N`):	Jangan lakukan tindakan.
`No to All` (`L`):	Jangan melakukan tindakan apa pun dan menekan tindakan berikutnya
	Confirm kueri untuk perintah ini.
`Suspend` (`S`):	Jeda perintah dan buat sesi sementara.
`Help`Aku akan menemuinya.`?`	Tampilkan bantuan untuk opsi ini.

Opsi menempatkan Suspend perintah ditangguhkan dan membuat sesi berlapis sementara tempat Anda dapat bekerja hingga Anda siap untuk memilih Confirm opsi. Perintah untuk sesi berlapis memiliki dua tanda sisipan tambahan (>>) untuk menunjukkan bahwa itu adalah operasi turunan dari perintah induk asli. Anda dapat menjalankan perintah dan skrip dalam sesi berlapis. Untuk mengakhiri sesi berlapis dan kembali ke Confirm opsi untuk perintah asli, ketik "exit".

Dalam contoh berikut, Suspend opsi (S) digunakan untuk menghentikan perintah sementara saat pengguna memeriksa bantuan untuk parameter perintah. Setelah mendapatkan informasi yang diperlukan, jenis pengguna "keluar" untuk mengakhiri perintah berlapis lalu memilih respons Ya (y) ke Confirm kueri.

PS C:\ps-test> New-Item -ItemType File -Name Test.txt -Confirm

Confirm
Are you sure you want to perform this action?

Performing operation "Create File" on Target "Destination:
C:\ps-test\test.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default
is "Y"): s

PS C:\ps-test> Get-Help New-Item -Parameter ItemType

-ItemType <string>
Specifies the provider-specified type of the new item.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       true (ByPropertyName)
Accept wildcard characters?  false

PS C:\ps-test> exit

Confirm
Are you sure you want to perform this action?
Performing operation "Create File" on Target "Destination: C:\ps-test\test
.txt".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (defau
lt is "Y"): y

Directory: C:\ps-test

Mode                LastWriteTime     Length Name
----                -------------     ------ ----
-a---         8/27/2010   2:41 PM          0 test.txt

Lihat juga

Saran dan Komentar

Apakah halaman ini membantu?

Last updated on 2026-01-18

Bagikan melalui

tentang Parameter Umum

Deskripsi singkat

Deskripsi panjang

Parameter umum

-Debug

-ErrorAction

-ErrorVariable

-InformationAction

-InformationVariable

-OutBuffer

-OutVariable

-PipelineVariable

-ProgressAction

-Verbose

-WarningAction

-WarningVariable

Parameter manajemen risiko

-WhatIf

-Confirm

Lihat juga

Saran dan Komentar

Sumber Daya Tambahan: