CommonParameters Hakkında

  • Makale

KıSA AÇıKLAMA

Herhangi bir cmdlet ile kullanılabilecek parametreleri açıklar.

UZUN AÇıKLAMA

Ortak parametreler, herhangi bir cmdlet ile kullanabileceğiniz bir cmdlet parametreleri kümesidir. Bunlar, cmdlet geliştiricisi tarafından değil PowerShell tarafından uygulanır ve tüm cmdlet'ler tarafından otomatik olarak kullanılabilir.

Ortak parametreleri herhangi bir cmdlet ile kullanabilirsiniz, ancak tüm cmdlet'ler üzerinde bir etkisi olmayabilir. Örneğin, bir cmdlet herhangi bir ayrıntılı çıkış oluşturmazsa, Ayrıntılı ortak parametresinin kullanılmasının hiçbir etkisi yoktur.

Ortak parametreler, CmdletBinding özniteliğini veya Parameter özniteliğini kullanan gelişmiş işlevlerde de kullanılabilir.

Bazı yaygın parametreler, PowerShell tercih değişkenlerini kullanarak ayarladığınız sistem varsayılanlarını veya tercihlerini geçersiz kılar. Tercih değişkenlerinden farklı olarak, ortak parametreler yalnızca kullanıldıkları komutları etkiler.

Daha fazla bilgi için bkz. about_Preference_Variables.

Aşağıdaki listede ortak parametreler görüntülenir. Diğer adları parantez içinde listelenir.

  • Hata ayıklama (db)
  • ErrorAction (ea)
  • ErrorVariable (ev)
  • InformationAction (infa)
  • InformationVariable (iv)
  • OutVariable (ov)
  • OutBuffer (ob)
  • PipelineVariable (bd)
  • Ayrıntılı (vb)
  • WarningAction (wa)
  • WarningVariable (wv)

Action parametreleri ActionPreference tür değerleridir. ActionPreference , aşağıdaki değerlere sahip bir numaralandırmadır:

Name Değer
Askıya Alma 5
Yoksayma 4
Sorgulamak 3
Devam et 2
Durdur 1
SilentlyContinue 0

adı veya değeri parametresiyle kullanabilirsiniz.

Ortak parametrelere ek olarak, birçok cmdlet risk azaltma parametreleri sunar. Sistem veya kullanıcı verileri için risk içeren cmdlet'ler genellikle bu parametreleri sunar.

Risk azaltma parametreleri şunlardır:

  • WhatIf (wi)
  • Onayla (cf)

ORTAK PARAMETRE AÇıKLAMALARı

Hata Ayıklama

komutu tarafından yapılan işlemle ilgili programcı düzeyindeki ayrıntıları görüntüler. Bu parametre yalnızca komut hata ayıklama iletisi oluşturduğunda çalışır. Örneğin, bir komut cmdlet'ini içerdiğinde Write-Debug bu parametre çalışır.

Type: SwitchParameter
Aliases: db

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Varsayılan olarak, değişkenin değeri $DebugPreferenceSilentlyContinue olduğundan hata ayıklama iletileri görüntülenmez.

Etkileşimli modda Debug parametresi geçerli komutun değişkeninin $DebugPreference değerini geçersiz kılar ve değerini $DebugPreferenceInquire olarak ayarlar.

Etkileşimli olmayan modda Debug parametresi geçerli komutun değişkeninin $DebugPreference değerini geçersiz kılar ve değerini $DebugPreferenceDevam olarak ayarlar.

-Debug:$true ile aynı etkiye -Debugsahiptir. Varsayılan olan SilentlyContinue olmadığında $DebugPreference hata ayıklama iletilerinin görüntülenmesini engellemek için kullanın-Debug:$false.

Erroraction

cmdlet'in komuttan sonlandırıcı olmayan bir hataya nasıl yanıt vereceğini belirler. Bu parametre yalnızca komut cmdlet'indekiler gibi sonlandırıcı olmayan bir hata oluşturduğunda Write-Error çalışır.

Type: ActionPreference
Aliases: ea
Accepted values: Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue

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

ErrorAction parametresi, geçerli komut için değişkenin $ErrorActionPreference değerini geçersiz kılar. Değişkenin $ErrorActionPreference varsayılan değeri Devam olduğundan, ErrorAction parametresini kullanmadığınız sürece hata iletileri görüntülenir ve yürütme devam eder.

ErrorAction parametresinin, bir komutun başarıyla tamamlanmasını engelleyen sonlandırıcı hataları (eksik veriler, geçerli olmayan parametreler veya yetersiz izinler gibi) hiçbir etkisi yoktur.

-ErrorAction:Continue hata iletisini görüntüler ve komutu yürütmeye devam eder. Continue varsayılan değerdir.

-ErrorAction:Ignore hata iletisini gizler ve komutu yürütmeye devam eder. SilentlyContinue'dan farklı olarakIgnore, hata iletisini otomatik değişkene $Error eklemez. Ignore değeri PowerShell 3.0'da kullanıma sunulmuştur.

-ErrorAction:Inquire hata iletisini görüntüler ve yürütmeye devam etmeden önce sizden onay ister. Bu değer nadiren kullanılır.

-ErrorAction:SilentlyContinue hata iletisini gizler ve komutu yürütmeye devam eder.

-ErrorAction:Stop hata iletisini görüntüler ve komutu yürütmeyi durdurur.

-ErrorAction:Suspend yalnızca PowerShell 6 ve sonrasında desteklenmeyen iş akışları için kullanılabilir.

Not

ErrorAction parametresi, komutta bir betik veya işlev çalıştırmak için kullanıldığında tercih değişkeninin değerini $ErrorAction geçersiz kılar, ancak değiştirmez.

ErrorVariable

ErrorVariable , komutla ilgili hata iletilerini belirtilen değişkende ve otomatik değişkende $Error depolar. Daha fazla bilgi için bkz . about_Automatic_Variables

Type: String
Aliases: ev

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Varsayılan olarak, yeni hata iletileri zaten değişkende depolanan hata iletilerinin üzerine yazar. Hata iletisini değişken içeriğine eklemek için, değişken adından önce bir artı işareti (+) yazın.

Örneğin, aşağıdaki komut değişkenini $a oluşturur ve içindeki hataları depolar:

Get-Process -Id 6 -ErrorVariable a

Aşağıdaki komut değişkene $a hata iletileri ekler:

Get-Process -Id 2 -ErrorVariable +a

Aşağıdaki komut içeriğini $agörüntüler:

$a

Bu parametreyi, yalnızca belirli komutlardan gelen hata iletilerini içeren ve otomatik değişkenin $Error davranışını etkilemeyen bir değişken oluşturmak için kullanabilirsiniz. Otomatik $Error değişken, oturumdaki tüm komutlardan gelen hata iletilerini içerir. Değişkenlerde depolanan belirli hatalara başvurmak için veya $error[1,2] gibi $a[0] dizi gösterimini kullanabilirsiniz.

Not

Özel hata değişkeni, iç içe işlevlere veya betiklere yapılan çağrılardan gelen hatalar da dahil olmak üzere komut tarafından oluşturulan tüm hataları içerir.

InformationAction

PowerShell 5.0'da kullanıma sunulmuştur. Kullanıldığı komut veya betik içinde, InformationAction ortak parametresi varsayılan olarak SilentlyContinue olarak ayarlanan tercih değişkeninin $InformationPreference değerini geçersiz kılar. InformationAction ile bir betikte kullandığınızdaWrite-Information, Write-Information değerler InformationAction parametresinin değerine bağlı olarak gösterilir. hakkında $InformationPreferencedaha fazla bilgi için bkz. about_Preference_Variables.

Type: ActionPreference
Aliases: ia
Accepted values: Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue

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

-InformationAction:Stop komutun bir örneğinde Write-Information bir komutu veya betiği durdurur.

-InformationAction:Ignore bilgilendirme iletisini gizler ve komutu çalıştırmaya devam eder. SilentlyContinue'un aksine, Yoksay bilgilendirme iletisini tamamen unutur; bilgi akışına bilgilendiren iletiyi eklemez.

-InformationAction:Inquire , bir Write-Information komutta belirttiğiniz bilgilendirme iletisini görüntüler ve devam etmek isteyip istemediğinizi sorar.

-InformationAction:Continue bilgilendirme iletisini görüntüler ve çalışmaya devam eder.

-InformationAction:Suspend yalnızca iş akışları için kullanılabilir olduğundan PowerShell Core'da desteklenmez.

-InformationAction:SilentlyContinue bilgilendirme iletisi (Varsayılan) görüntülenmediğinden ve betik kesintisiz devam ettiğinden hiçbir etkisi olmaz.

Not

InformationAction parametresi, komutta bir betik veya işlev çalıştırmak için kullanıldığında tercih değişkeninin $InformationAction değerini geçersiz kılar, ancak değiştirmez.

InformationVariable

PowerShell 5.0'da kullanıma sunulmuştur. InformationVariable ortak parametresi, kullanıldığı komut veya betik içinde, komutunu ekleyerek belirttiğiniz bir dizeyi bir değişkende Write-Information depolar. Write-Information değerler InformationAction ortak parametresinin değerine bağlı olarak gösterilir; InformationAction ortak parametresini eklemezseniz, Write-Information tercih değişkeninin değerine $InformationPreference bağlı olarak dizeler gösterilir. hakkında $InformationPreferencedaha fazla bilgi için bkz. about_Preference_Variables.

Not

Bilgi değişkeni, iç içe işlevlere veya betiklere yapılan çağrılardan gelen bilgi iletileri de dahil olmak üzere komut tarafından oluşturulan tüm bilgi iletilerini içerir.

Type: String
Aliases: iv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

OutBuffer

Herhangi bir nesne işlem hattı üzerinden gönderilmeden önce arabellekte birikecek nesne sayısını belirler. Bu parametreyi atlarsanız, nesneler oluşturuldukları sırada gönderilir.

Type: Int32
Aliases: ob

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Bu kaynak yönetimi parametresi ileri düzey kullanıcılar için tasarlanmıştır. Bu parametreyi kullandığınızda, PowerShell verileri toplu olarak OutBuffer + 1sonraki cmdlet'e gönderir.

Aşağıdaki örnek, cmdlet'ini kullanan Write-Host blokları işlemek için ForEach-Object arasında bir alternatif görüntüler. Görüntü, 2 veya OutBuffer + 1toplu olarak değiştirilir.

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

Sabit Değer

Komuttaki çıkış nesnelerini, çıkışı işlem hattı boyunca göndermeye ek olarak belirtilen değişkende depolar.

Type: String
Aliases: ov

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Çıktıyı değişkenine eklemek için, orada zaten depolanmış olabilecek herhangi bir çıkışı değiştirmek yerine, değişken adından önce bir artı işareti (+) yazın.

Örneğin, aşağıdaki komut değişkeni oluşturur $out ve işlem nesnesini içinde depolar:

Get-Process PowerShell -OutVariable out

Aşağıdaki komut, işlem nesnesini değişkenine $out ekler:

Get-Process iexplore -OutVariable +out

Aşağıdaki komut değişkenin $out içeriğini görüntüler:

$out

Not

OutVariable parametresi tarafından oluşturulan değişken bir [System.Collections.ArrayList]'dir.

PipelineVariable

PipelineVariable , geçerli işlem hattı öğesinin değerini, işlem hattı üzerinden akan adlandırılmış komutlar için bir değişken olarak depolar.

Type: String
Aliases: pv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Geçerli değerler, herhangi bir değişken adıyla aynı olan dizelerdir.

Aşağıda PipelineVariable'ın nasıl çalıştığına ilişkin bir örnek verilmiştir. Bu örnekte pipelinevariable parametresi, komutun sonuçlarını değişkenlerde depolamak için bir Foreach-Object komuta eklenir. 1 ile 10 arasında bir sayı aralığı, sonuçları Left adlı bir değişkende depolanan ilk Foreach-Object komuta aktarılır.

İlk komutun sonuçları, ilk Foreach-Object komut tarafından Foreach-Object döndürülen nesneleri filtreleyen ikinci Foreach-Object bir komuta aktarılır. İkinci komutun sonuçları Right adlı bir değişkende depolanır.

Üçüncü Foreach-Object komutta, Sol ve Sağ değişkenleriyle temsil edilen ilk iki Foreach-Object kanallı komutun sonuçları çarpma işleci kullanılarak işlenir. Komut, Sol ve Sağ değişkenlerinde depolanan nesnelerin çarpılması talimatını verir ve sonuçların "Sol aralık üyesi * Sağ aralık üyesi = ürün" olarak görüntülenmesi gerektiğini belirtir.

1..10 | Foreach-Object -PipelineVariable Left -Process { $_ } |
  Foreach-Object -PV Right -Process { 1..10 } |
  Foreach-Object -Process { "$Left * $Right = " + ($Left*$Right) }

1 * 1 = 1
1 * 2 = 2
1 * 3 = 3
1 * 4 = 4
1 * 5 = 5
...

Ayrıntılı

komutu tarafından yapılan işlemle ilgili ayrıntılı bilgileri görüntüler. Bu bilgiler bir izlemedeki veya işlem günlüğündeki bilgilere benzer. Bu parametre yalnızca komut ayrıntılı bir ileti oluşturduğunda çalışır. Örneğin, bir komut cmdlet'ini içerdiğinde Write-Verbose bu parametre çalışır.

Type: SwitchParameter
Aliases: vb

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

Verbose parametresi, geçerli komut için değişkenin $VerbosePreference değerini geçersiz kılar. Değişkenin varsayılan değeri $VerbosePreferenceSilentlyContinue olduğundan, ayrıntılı iletiler varsayılan olarak görüntülenmez.

-Verbose:$true ile aynı etkiye sahip -Verbose

-Verbose:$false ayrıntılı iletilerin görüntülenmesini engeller. değeri $VerbosePreferenceSilentlyContinue (varsayılan) olmadığında bu parametreyi kullanın.

Warningaction

Cmdlet'in komuttan gelen uyarıya nasıl yanıt vereceğini belirler. Devam varsayılan değerdir. Bu parametre yalnızca komut bir uyarı iletisi oluşturduğunda çalışır. Örneğin, bir komut cmdlet'ini içerdiğinde Write-Warning bu parametre çalışır.

Type: ActionPreference
Aliases: wa
Accepted values: Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue

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

WarningAction parametresi, geçerli komut için değişkenin $WarningPreference değerini geçersiz kılar. Değişkenin varsayılan değeri $WarningPreferenceDevam olduğundan uyarılar görüntülenir ve WarningAction parametresini kullanmadığınız sürece yürütme devam eder.

-WarningAction:Continue uyarı iletilerini görüntüler ve komutu yürütmeye devam eder. Continue varsayılan değerdir.

-WarningAction:Inquire uyarı iletisini görüntüler ve yürütmeye devam etmeden önce sizden onay ister. Bu değer nadiren kullanılır.

-WarningAction:SilentlyContinue uyarı iletisini bastırır ve komutu yürütmeye devam eder.

-WarningAction:Stop uyarı iletisini görüntüler ve komutu yürütmeyi durdurur.

Not

WarningAction parametresi, komutta betik veya işlev çalıştırmak için kullanıldığında tercih değişkeninin $WarningAction değerini geçersiz kılar, ancak değiştirmez.

WarningVariable

Komutla ilgili uyarıları belirtilen değişkende depolar.

Type: String
Aliases: wv

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Oluşturulan tüm uyarılar kullanıcıya görüntülenmese bile değişkene kaydedilir.

Uyarıları değişken içeriğine eklemek için, orada zaten depolanmış olabilecek uyarıları değiştirmek yerine, değişken adından önce bir artı işareti (+) yazın.

Örneğin, aşağıdaki komut değişkeni oluşturur $a ve ardından içinde uyarıları depolar:

Get-Process -Id 6 -WarningVariable a

Aşağıdaki komut değişkene $a herhangi bir uyarı ekler:

Get-Process -Id 2 -WarningVariable +a

Aşağıdaki komut içeriğini $agörüntüler:

$a

Yalnızca belirli komutlardan gelen uyarıları içeren bir değişken oluşturmak için bu parametreyi kullanabilirsiniz. değişkeninde depolanan belirli uyarılara başvurmak için veya $warning[1,2] gibi $a[0] dizi gösterimini kullanabilirsiniz.

Not

Uyarı değişkeni, iç içe işlevlere veya betiklere yapılan çağrılar dahil olmak üzere komut tarafından oluşturulan tüm uyarıları içerir.

Risk Yönetimi Parametre Açıklamaları

WhatIf

Komutu yürütmek yerine komutunun etkisini açıklayan bir ileti görüntüler.

Type: SwitchParameter
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

WhatIf parametresi, geçerli komut için değişkenin $WhatIfPreference değerini geçersiz kılar. Değişkenin varsayılan değeri $WhatIfPreference 0 (devre dışı) olduğundan WhatIf davranışı WhatIf parametresi olmadan yapılmaz. Daha fazla bilgi için bkz. about_Preference_Variables

-WhatIf:$true ile aynı etkiye -WhatIfsahiptir.

-WhatIf:$false değişkeninin değeri $WhatIfPreference 1 olduğunda sonuç veren otomatik WhatIf davranışını bastırır.

Örneğin, aşağıdaki komut bir Remove-Item komutta parametresini -WhatIf kullanır:

Remove-Item Date.csv -WhatIf

PowerShell, öğeyi kaldırmak yerine yapacağı işlemleri ve etkilenecek öğeleri listeler. Bu komut aşağıdaki çıkışı oluşturur:

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

Confirm

Komutu yürütmeden önce sizden onay ister.

Type: SwitchParameter
Aliases: cf

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

Confirm parametresi, geçerli komut için değişkenin $ConfirmPreference değerini geçersiz kılar. Varsayılan değer true şeklindedir. Daha fazla bilgi için bkz. about_Preference_Variables

-Confirm:$true ile aynı etkiye -Confirmsahiptir.

-Confirm:$false değeri, cmdlet'in $ConfirmPreference tahmini riskinden küçük veya buna eşit olduğunda oluşan otomatik onayı bastırır.

Örneğin, aşağıdaki komut bir Remove-Item komutla Confirm parametresini kullanır. Öğeyi kaldırmadan önce PowerShell, yapacağı işlemleri ve etkilenecek öğeleri listeler ve onay ister.

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"):

Yanıtı onayla seçenekleri şunlardır:

Yanıt Sonuç
Evet (Y) Eylemi gerçekleştirin.
Tümüne Evet (A) Tüm eylemleri gerçekleştirme ve sonraki Confirm sorgularını gizleme
öğesini seçin.
Hayır (N): Eylemi gerçekleştirmeyin.
Tümüne Hayır (L): Hiçbir eylem gerçekleştirmeyin ve izleyen Onayla'yı gizleme
bu komut için sorgular.
Askıya alma (S): Komutu duraklatın ve geçici bir oturum oluşturun.
Yardım (?) Bu seçenekler için yardım görüntüleyin.

Askıya Al seçeneği komutu beklemeye alır ve onayla seçeneğini belirlemeye hazır olana kadar çalışabileceğiniz geçici bir iç içe oturum oluşturur. İç içe oturum için komut isteminde, bunun özgün üst komutun alt işlemi olduğunu belirten iki ek giriş öğesi (>>) vardır. komutları ve betikleri iç içe oturumda çalıştırabilirsiniz. İç içe oturumu sonlandırmak ve özgün komutun Onaylama seçeneklerine dönmek için "exit" yazın.

Aşağıdaki örnekte, kullanıcı bir komut parametresi için yardımı denetlerken bir komutu geçici olarak durdurmak için Askıya Al seçeneği (S) kullanılır. Gerekli bilgileri aldıktan sonra, kullanıcı iç içe istemi sonlandırmak için "exit" yazıp Onayla sorgusuna Evet (y) yanıtını seçer.

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

ANAHTAR KELİME -LER

about_Common_Parameters

AYRıCA BKZ.

about_Preference_Variables

Yazma-Hata Ayıklama

Yazma Uyarısı

Yazma Hatası

Ayrıntılı Yazma