about_CommonParameters

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 bunların tüm cmdlet'ler üzerinde bir etkisi olmayabilir. Örneğin, bir cmdlet herhangi bir verbose çıkış oluşturmazsa, ortak parametrenin kullanılmasının Verbose hiçbir etkisi yoktur.

Ortak parametreler, özniteliğini veya özniteliğini kullanan gelişmiş işlevlerde CmdletBinding Parameter de kullanılabilir. Bu öznitelikleri kullandığınızda PowerShell, Ortak Parametreleri otomatik olarak ekler. Common Parameters ile aynı adları kullanan hiçbir parametre oluşturamazsınız.

Çeşitli 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.

• Debug (db)
• ErrorAction (ea)
• ErrorVariable (ev)
• InformationAction (infa)
• InformationVariable (iv)
• OutVariable (ov)
• OutBuffer (ob)
• PipelineVariable (bd)
• ProgressAction (proga)
• Verbose (vb)
• WarningAction (wa)
• WarningVariable (wv)

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

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)
• Confirm (cf)

Ortak parametre açıklamaları

-Debug

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 $DebugPreference SilentlyContinue olduğundan hata ayıklama iletileri görüntülenmez.

Debug parametresi geçerli komut için değişkenin $DebugPreference değerini geçersiz kılar ve değerini $DebugPreference Devam 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ılmayan 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: 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

ErrorAction parametresi, geçerli komut için değişkenin $ErrorActionPreference değerini geçersiz kılar. Değişkenin varsayılan değeri $ErrorActionPreference 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 hataları (eksik veriler, geçerli olmayan parametreler veya yetersiz izinler gibi) sonlandırma üzerinde hiçbir etkisi yoktur.

• Break Hata oluştuğunda veya özel durum oluştuğunda hata ayıklayıcıyı girer.
• Continue hata iletisini görüntüler ve komutu yürütmeye devam eder. Continue varsayılan değerdir.
• Ignore hata iletisini gizler ve komutu yürütmeye devam eder. SilentlyContinue'un aksine Ignore, hata iletisini otomatik değişkene $Error eklemez. Ignore değeri PowerShell 3.0'da kullanıma sunulmuştur.
• Inquire hata iletisini görüntüler ve yürütmeye devam etmeden önce sizden onay ister. Bu değer nadiren kullanılır.
• SilentlyContinue hata iletisini gizler ve komutu yürütmeye devam eder.
• Stop hata iletisini görüntüler ve komutu yürütmeyi durdurur.
• Suspend yalnızca PowerShell 6 ve sonrasında desteklenmeyen iş akışları için kullanılabilir.

-ErrorVariable

Hata kayıtları otomatik değişkende $Error otomatik olarak depolanır. Daha fazla bilgi için bkz . about_Automatic_Variables.

Bir komutta ErrorVariable parametresini kullandığınızda, PowerShell komutu tarafından yayılan hata kayıtlarını parametresi tarafından belirtilen değişkende de depolar.

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ının önüne bir artı işareti (+) koyun.

Örneğin, aşağıdaki komut değişkeni oluşturur $a ve ardından 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.

-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 InformationAction parametresinin değerine bağlı olarak değerler gösterilir. hakkında $InformationPreferencedaha fazla bilgi için bkz. 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 Hata ayıklayıcısını komutun bir örneğinde Write-Information girer.
• Stop komutu veya betiği, komutun Write-Information bir örneğinde durdurur.
• Ignore bilgilendirme iletisini gizler ve komutu çalıştırmaya devam eder. SilentlyContinue'un aksine Yoksay, bilgilendirici iletiyi tamamen unutur; bilgi akışına bilgilendirici iletiyi eklemez.
• Inquire , bir Write-Information komutta belirttiğiniz bilgilendirme iletisini görüntüler ve devam etmek isteyip istemediğinizi sorar.
• Continue bilgilendirme iletisini görüntüler ve çalışmaya devam eder.
• Suspend yalnızca iş akışları için kullanılabilir olduğundan PowerShell 6 ve üzeri sürümlerde desteklenmez.
• SilentlyContinue bilgilendirme iletisi (Varsayılan) görüntülenmediğinden ve betik kesintisiz olarak devam ettiğinden hiçbir etkisi olmaz.

-InformationVariable

PowerShell 5.0'da kullanıma sunulmuştur. InformationVariable ortak parametresini kullandığınızda, bilgi kayıtları parametresi tarafından belirtilen değişkende depolanır. PowerShell cmdlet'i, Bilgi akışına bilgi kayıtları yazabilir. Bilgi kayıtlarını yazmak için cmdlet'ini Write-Information de kullanabilirsiniz.

Bilgi kayıtları varsayılan olarak konsolda ileti olarak görüntülenir. InformationAction ortak parametresini kullanarak bilgi kaydının görüntülenmesini denetleyebilirsiniz. Tercih değişkenini kullanarak $InformationPreference davranışı da değiştirebilirsiniz. hakkında $InformationPreferencedaha fazla bilgi için bkz. about_Preference_Variables.

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

Varsayılan olarak, yeni bilgi kaydı değişkende zaten depolanmış olan değerlerin üzerine yazar. Hata iletisini değişken içeriğine eklemek için, değişken adının önüne bir artı işareti (+) koyun.

-OutBuffer

İşlem hattı üzerinden herhangi bir nesne 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 işlem blokları arasında ForEach-Object görüntülenir. 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

-OutVariable

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şkene 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

-PipelineVariable

PipelineVariable , bu parametreyi kullanan komut tarafından bir sonraki işlem hattı kesimine geçirilen en son değere erişim sağlar. İşlem hattındaki herhangi bir komut PipelineVariable adlı değeri kullanarak değere erişebilir. Değer, bir sonraki işlem hattı kesimine geçirildiğinde değişkene atanır. Bu işlem PipelineVariable'ın kullanımını, birden çok konuma atanılması gerekebilecek belirli bir geçici değişkene göre daha kolay hale getirir.

veya $PSItem'den farklı $_ olarak PipelineVariable kullanmak, herhangi bir işlem hattı komutunun hemen önceki komut dışındaki komutlar tarafından geçirilen (ve kaydedilen) işlem hattı değerlerine erişmesine izin verir. İşlem hattı komutları, işlem hattından geçen sonraki öğeyi işlerken gelen son değere erişebilir. Bu, komutun çıkışını önceki bir komuta (veya kendisine) döndürmesine olanak tanır.

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şkenler halinde depolamak için bir Foreach-Object komuta eklenir. 1 ile 5 arasında bir sayı aralığı ilk Foreach-Object komuta aktarılır ve sonuçları adlı $tempdeğişkende depolanır.

İlk Foreach-Object komutun sonuçları, geçerli ve $_değerlerini $temp görüntüleyen ikinci Foreach-Object bir komuta aktarılır.

# Create a variable named $temp
$temp=8
Get-Variable temp
# Note that the variable just created isn't available on the
# pipeline when -PipelineVariable creates the same variable name
1..5 | ForEach-Object -PipelineVariable temp -Begin {
    Write-Host "Step1[BEGIN]:`$temp=$temp"
} -Process {
  Write-Host "Step1[PROCESS]:`$temp=$temp - `$_=$_"
  Write-Output $_
} | ForEach-Object {
  Write-Host "`tStep2[PROCESS]:`$temp=$temp - `$_=$_"
}
# The $temp variable is deleted when the pipeline finishes
Get-Variable temp

Name                           Value
----                           -----
temp                           8

Step1[BEGIN]:$temp=
Step1[PROCESS]:$temp= - $_=1
        Step2[PROCESS]:$temp=1 - $_=1
Step1[PROCESS]:$temp=1 - $_=2
        Step2[PROCESS]:$temp=2 - $_=2
Step1[PROCESS]:$temp=2 - $_=3
        Step2[PROCESS]:$temp=3 - $_=3
Step1[PROCESS]:$temp=3 - $_=4
        Step2[PROCESS]:$temp=4 - $_=4
Step1[PROCESS]:$temp=4 - $_=5
        Step2[PROCESS]:$temp=5 - $_=5

Name                           Value
----                           -----
temp

-ProgressAction

PowerShell'in, Yazma İlerlemesi cmdlet'i tarafından oluşturulan ilerleme çubukları gibi bir betik, cmdlet veya sağlayıcı tarafından oluşturulan ilerleme güncelleştirmelerine nasıl yanıt vereceğini belirler. Cmdlet, Write-Progress bir komutun durumunu gösteren ilerleme çubukları oluşturur. ProgressAction parametresi PowerShell 7.4'e eklendi.

ProgressAction parametresi numaralandırma değerlerinden ActionPreference birini alır: SilentlyContinue, Stop, Continue, Inquire, , Ignore, Suspendveya Break.

Geçerli değerler şunlardır:

• Break Hata ayıklayıcısını komutun bir örneğinde Write-Progress girer.
• Stop: İlerleme çubuğunu görüntülemez. Bunun yerine bir hata iletisi görüntüler ve yürütmeyi durdurur.
• Inquire: İlerleme çubuğunu görüntülemez. Devam etmek için izin ister. veya Aile Y yanıtlarsanız ilerleme çubuğu görüntülenir.
• Continue: (Varsayılan) İlerleme çubuğunu görüntüler ve yürütmeye devam eder.
• SilentlyContinue: komutu yürütür, ancak ilerleme çubuğunu görüntülemez.

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

komutu tarafından yapılan işlemle ilgili ayrıntılı bilgileri görüntüler. Bu bilgiler, izlemedeki veya işlem günlüğündeki bilgilere benzer. Bu parametre yalnızca komut bir verbose 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

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

• -Verbose:$true ile aynı etkiye sahiptir -Verbose
• -Verbose:$false iletilerin görüntülenmesini verbose engeller. değeri $VerbosePreference SilentlyContinue (varsayılan) olmadığında bu parametreyi kullanın.

-WarningAction

Cmdlet'in komuttan gelen bir 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: 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

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

• Break bir uyarı oluştuğunda hata ayıklayıcısını girer.
• Continue uyarı iletilerini görüntüler ve komutu yürütmeye devam eder. Continue varsayılan değerdir.
• Inquire uyarı iletisini görüntüler ve yürütmeye devam etmeden önce sizden onay ister. Bu değer nadiren kullanılır.
• SilentlyContinue uyarı iletisini bastırır ve komutu yürütmeye devam eder.
• Stop uyarı iletisini görüntüler ve komutu yürütmeyi durdurur.

-WarningVariable

Komutla ilgili uyarı kayıtlarını 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 sonra içinde tüm 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

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

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.

• $true ile aynı etkiye -WhatIfsahiptir.
• $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

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

• $true ile aynı etkiye -Confirmsahiptir.
• $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 parametresini Confirm bir Remove-Item komutla 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 Confirm seçenekleri şunlardır:

Askıya Al seçeneği komutu beklemeye alır ve bir seçenek belirlemeye hazır olana kadar çalışabileceğiniz geçici bir Confirm 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ş işareti (>>) vardır. İç içe oturumda komutları ve betikleri çalıştırabilirsiniz. İç içe oturumu sonlandırmak ve özgün komutun Confirm 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 sorguya Evet (y) yanıtını Confirm 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

Ayrıca bkz.

• about_Preference_Variables
• Yazmak-Debug
• Yazma Hatası
• Yazmak-Verbose
• Yazma Uyarısı