about_CommonParameters

發行項
07/03/2024

簡短描述

描述可與任何 Cmdlet 搭配使用的參數。

詳細描述

常見的參數是一組 Cmdlet 參數，您可以搭配任何 Cmdlet 使用。它們是由PowerShell實作，而不是由 Cmdlet 開發人員實作，而且它們會自動提供給任何 Cmdlet。

您可以將通用參數與任何 Cmdlet 搭配使用，但是它們可能不會對所有 Cmdlet 造成影響。例如，如果 Cmdlet 不會產生任何 verbose 輸出，則使用 Verbose 通用參數沒有任何作用。

您也可以在使用 CmdletBinding 屬性或 Parameter 屬性的進階函式上使用通用參數。當您使用這些屬性時，PowerShell 會自動新增 Common Parameters。您無法建立任何使用與一般參數相同名稱的參數。

數個常見的參數會覆寫您使用 PowerShell 喜好設定變數所設定的系統預設值或喜好設定。與喜好設定變數不同，通用參數只會影響所使用的命令。

如需詳細資訊，請參閱 about_Preference_Variables。

下列清單會顯示一般參數。其別名會列在括弧中。

Debug （db）
ErrorAction （ea）
ErrorVariable （ev）
InformationAction （infa）
InformationVariable （iv）
OutVariable （ov）
OutBuffer （ob）
PipelineVariable （pv）
ProgressAction （proga）
Verbose （vb）
WarningAction （wa）
WarningVariable （wv）

Action 參數為 ActionPreference 類型值。 ActionPreference 是具有下列值的列舉：

名稱	值
`Suspend`	5
`Ignore`	4
`Inquire`	3
`Continue`	2
`Stop`	1
`SilentlyContinue`	0

您可以使用名稱或值搭配參數。

除了一般參數之外，許多 Cmdlet 還提供風險風險降低參數。牽涉到系統或用戶數據風險的 Cmdlet 通常會提供這些參數。

風險風險降低參數包括：

WhatIf （wi）
Confirm （cf）

一般參數描述

-Debug

顯示命令所完成作業的程式設計人員層級詳細數據。只有當命令產生偵錯訊息時，此參數才有效。例如，當命令包含 Write-Debug Cmdlet 時，這個參數會運作。

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

根據預設，不會顯示偵錯訊息，因為變數的值 $DebugPreference 是 SilentlyContinue。

在互動式模式中 Debug ，參數會覆寫目前命令的 $DebugPreference 變數值，並將的值 $DebugPreference 設定為 [查詢]。

在非互動式模式中 Debug ，參數會覆寫目前命令的 $DebugPreference 變數值，並將的值 $DebugPreference 設定為 [繼續]。

-Debug:$true 的效果與 -Debug相同。當不是 SilentlyContinue 時$DebugPreference，使用 -Debug:$false 來隱藏偵錯訊息的顯示，這是預設值。

-ErrorAction

決定 Cmdlet 如何回應命令中的非終止錯誤。只有當命令產生非終止錯誤時，此參數才有效，例如 Cmdlet 中的 Write-Error 錯誤。

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 參數會覆寫目前命令的$ErrorActionPreference變數值。因為變數的 $ErrorActionPreference 預設值是 Continue，因此除非您使用 ErrorAction 參數，否則會顯示錯誤訊息並繼續執行。

ErrorAction 參數不會影響終止錯誤（例如遺漏的數據、無效的參數或許可權不足），而無法順利完成命令。

-ErrorAction:Break 當發生錯誤或引發例外狀況時，輸入調試程式。
-ErrorAction:Continue 會顯示錯誤訊息，並繼續執行命令。 Continue 是預設值。
-ErrorAction:Ignore 會隱藏錯誤訊息，並繼續執行命令。與 SilentlyContinue 不同，Ignore 不會將錯誤訊息新增至$Error自動變數。忽略值是在PowerShell 3.0中引進。
-ErrorAction:Inquire 會顯示錯誤訊息，並在繼續執行之前提示您確認。這個值很少使用。
-ErrorAction:SilentlyContinue 會隱藏錯誤訊息，並繼續執行命令。
-ErrorAction:Stop 會顯示錯誤訊息，並停止執行命令。
-ErrorAction:Suspend 僅適用於PowerShell 6和更新版本不支援的工作流程。

注意

ErrorAction 參數會覆寫，但在命令中使用參數來執行腳本或函式時，不會取代變數的值$ErrorActionPreference。

-ErrorVariable

錯誤記錄會自動儲存在自動變數中 $Error 。如需詳細資訊，請參閱 about_Automatic_Variables。

當您在 命令上使用 ErrorVariable 參數時，PowerShell 也會將命令發出的錯誤記錄儲存在參數所指定的變數中。

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

根據預設，新的錯誤訊息會覆寫已儲存在變數中的錯誤訊息。若要將錯誤訊息附加至變數內容，請將加號（+）放在變數名稱之前。

例如，下列命令會 $a 建立變數，然後將任何錯誤儲存在變數中：

Get-Process -Id 6 -ErrorVariable a

下列命令會將任何錯誤訊息新增至 $a 變數：

Get-Process -Id 2 -ErrorVariable +a

下列命令會顯示的內容 $a：

$a

您可以使用此參數來建立只包含來自特定命令之錯誤訊息的變數，且不會影響自動變數的行為 $Error 。自動 $Error 變數包含會話中所有命令的錯誤訊息。您可以使用數位表示法，例如 $a[0] 或 $error[1,2] 來參考儲存在變數中的特定錯誤。

注意

自定義錯誤變數包含命令所產生的所有錯誤，包括從呼叫巢狀函式或腳本的錯誤。

-InformationAction

PowerShell 5.0 中引進。在所使用的命令或腳本內， InformationAction 一般參數會覆寫喜好設定變數的值 $InformationPreference ，預設會設定為 SilentlyContinue。當您搭配 InformationAction 在腳本中使用Write-Information時，Write-Information會根據 InformationAction 參數的值來顯示值。如需的詳細資訊 $InformationPreference，請參閱 about_Preference_Variables。

Type: ActionPreference
Aliases: infa
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:Break 在命令出現時 Write-Information 輸入調試程式。
-InformationAction:Stop 在命令出現 Write-Information 時停止命令或腳本。
-InformationAction:Ignore 會隱藏參考訊息，並繼續執行命令。與 SilentlyContinue 不同，Ignore 會完全忘記資訊訊息;它不會將參考訊息新增至信息數據流。
-InformationAction:Inquire 會顯示您在命令中指定的 Write-Information 參考訊息，然後詢問是否要繼續。
-InformationAction:Continue 會顯示參考訊息，並繼續執行。
-InformationAction:Suspend PowerShell 6 和更新版本不支援，因為它僅適用於工作流程。
-InformationAction:SilentlyContinue 當資訊訊息未顯示時，不會有任何作用，而且腳本會繼續而不會中斷。

注意

InformationAction 參數會覆寫，但在命令中使用參數來執行腳本或函式時，不會取代喜好設定變數的值$InformationAction。

-InformationVariable

PowerShell 5.0 中引進。當您使用 InformationVariable 通用參數時，信息記錄會儲存在參數指定的變數中。 PowerShell Cmdlet 可以將資訊記錄 寫入信息 數據流。您也可以使用 Write-Information Cmdlet 來寫入信息記錄。

信息記錄預設會顯示為控制台中的訊息。您可以使用 InformationAction 一般參數來控制資訊記錄的顯示。您也可以使用 $InformationPreference 喜好設定變數來變更行為。如需的詳細資訊 $InformationPreference，請參閱 about_Preference_Variables。

注意

資訊變數包含命令所產生的所有資訊訊息，包括來自呼叫巢狀函式或腳本的資訊訊息。

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

根據預設，新的資訊記錄會覆寫變數中已儲存的值。若要將錯誤訊息附加至變數內容，請將加號（+）放在變數名稱之前。

-OutBuffer

決定在透過管線傳送任何物件之前，要累積在緩衝區中的物件數目。如果您省略此參數，則會在產生物件時傳送物件。

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

此資源管理參數是針對進階用戶所設計。當您使用此參數時，PowerShell 會分批 OutBuffer + 1將數據傳送至下一個 Cmdlet。

下列範例會以處理使用 Cmdlet 的Write-Host區塊之間ForEach-Object顯示。顯示替代的批次為 2 或 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

除了沿著管線傳送輸出之外，也會將命令的輸出物件儲存在指定的變數中。

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

若要將輸出新增至變數，而不是取代可能儲存在該處的任何輸出，請在變數名稱之前輸入加號（+）。

例如，下列命令會 $out 建立變數，並將進程物件儲存在其中：

Get-Process PowerShell -OutVariable out

下列命令會將行程物件新增至 $out 變數：

Get-Process iexplore -OutVariable +out

下列命令會顯示變數的內容 $out ：

$out

注意

OutVariable 參數所建立的變數是 [System.Collections.ArrayList]。

-PipelineVariable

PipelineVariable 允許使用此參數的命令存取傳入下一個管線區段的最新值。管線中的任何命令都可以使用具名 PipelineVariable 存取值。值會在傳遞至下一個管線區段時指派給變數。這可讓 PipelineVariable 比特定暫存變數更容易使用，這可能需要在多個位置指派。

與或 $PSItem不同$_，使用 PipelineVariable 可讓任何管線命令存取先前命令以外的命令所傳遞或儲存的管線值。管線命令可以在處理傳遞管線的下一個專案時，存取從管線傳送的最後一個值。這可讓命令 將其輸出摘要回 上一個命令（或本身）。

注意

進階函式最多可以有三個腳本區塊： begin、 process和 end。搭配進階函式使用 PipelineVariable 參數時，只有第一個定義腳本區塊中的值會在函式執行時指派給變數。如需詳細資訊，請參閱進階函式。 PowerShell 7.2 會更正此行為。

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

有效值為字串，與任何變數名稱相同。

警告

PipelineVariable 的範圍設定為叫用管線的管線。在管線執行之前，會清除管線外部使用相同名稱的變數。 當管線終止時，PipelineVariable 超出範圍。如果管線內的多個命令指定相同的 PipelineVariable ，則只有一個共用變數。該變數會使用指定變數之命令的最新管線輸出來更新。

某些封鎖命令會在產生任何輸出之前收集所有管線專案，例如 Sort-Object 或 Select-Object -Last。在這類封鎖命令之前，在命令中指派的任何 PipelineVariable ，在封鎖命令之後，一律包含上述命令的最後一個管線專案。

以下是 PipelineVariable 運作方式的範例。在此範例中 ，PipelineVariable 參數會新增至 Foreach-Object 命令，以將命令的結果儲存在變數中。數位範圍 1 到 5 會管線傳送至第一 Foreach-Object 個命令，結果會儲存在名為 $temp的變數中。

第一Foreach-Object個命令的結果會管線傳送至第二Foreach-Object個命令，以顯示和$_的目前值$temp。

# 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

Get-Variable : Cannot find a variable with the name 'temp'.
At line:1 char:1
+ Get-Variable temp
+ ~~~~~~~~~~~~~~~~~
    + CategoryInfo          : ObjectNotFound: (temp:String) [Get-Variable], ItemNotFoundException
    + FullyQualifiedErrorId : VariableNotFound,Microsoft.PowerShell.Commands.GetVariableCommand

-ProgressAction

決定 PowerShell 如何回應腳本、Cmdlet 或提供者所產生的進度更新，例如 Write-Progress Cmdlet 所產生的進度列。 Cmdlet Write-Progress 會建立進度列，以顯示命令的狀態。 ProgressAction 參數已在 PowerShell 7.4 中新增。

ProgressAction 參數會採用其中ActionPreference一個列舉值：SilentlyContinue、、Stop、ContinueInquire、Ignore、、 Suspend或 Break。

有效值如下：

Break 在命令出現時 Write-Progress 輸入調試程式。
Stop：不會顯示進度列。相反地，它會顯示錯誤訊息並停止執行。
Inquire：不會顯示進度列。提示輸入許可權以繼續。如果您使用或A回復Y，則會顯示進度列。
Continue:(預設值）顯示進度列，並繼續執行。
SilentlyContinue：執行命令，但不會顯示進度列。

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

顯示命令所完成作業的詳細資訊。這項信息類似於追蹤或事務歷史記錄中的資訊。只有當命令產生 verbose 訊息時，此參數才有效。例如，當命令包含 Write-Verbose Cmdlet 時，這個參數會運作。

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

參數 Verbose 會覆寫目前命令的 $VerbosePreference 變數值。因為變數的 $VerbosePreference 預設值是 SilentlyContinue， verbose 因此預設不會顯示訊息。

-Verbose:$true 的效果與相同 -Verbose
-Verbose:$false 隱藏訊息的 verbose 顯示。當的值 $VerbosePreference 不是 SilentlyContinue 時，請使用此參數（預設值）。

-WarningAction

決定 Cmdlet 如何回應命令中的警告。 Continue 是預設值。只有當命令產生警告訊息時，此參數才有效。例如，當命令包含 Write-Warning Cmdlet 時，這個參數會運作。

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 參數會覆寫目前命令的$WarningPreference變數值。因為變數的 $WarningPreference 預設值是 Continue，因此除非您使用 WarningAction 參數，否則會顯示警告並繼續執行。

-WarningAction:Break 當發生警告時，會輸入調試程式。
-WarningAction:Continue 會顯示警告訊息，並繼續執行命令。 Continue 是預設值。
-WarningAction:Inquire 會顯示警告訊息，並在繼續執行之前提示您確認。這個值很少使用。
-WarningAction:SilentlyContinue 會隱藏警告訊息，並繼續執行命令。
-WarningAction:Stop 會顯示警告訊息，並停止執行命令。

注意

WarningAction 參數會覆寫，但在命令中使用參數來執行腳本或函式時，不會取代喜好設定變數的值$WarningAction。

-WarningVariable

將命令的相關警告記錄儲存在指定的變數中。

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

所有產生的警告都會儲存在變數中，即使不會向用戶顯示警告也一樣。

若要將警告附加至變數內容，而不是取代可能儲存在該處的任何警告，請在變數名稱之前輸入加號（+）。

例如，下列命令會 $a 建立變數，然後將任何警告儲存在變數中：

Get-Process -Id 6 -WarningVariable a

下列命令會將任何警告新增至 $a 變數：

Get-Process -Id 2 -WarningVariable +a

下列命令會顯示的內容 $a：

$a

您可以使用此參數來建立只包含來自特定命令之警告的變數。您可以使用數位表示法，例如 $a[0] 或 $warning[1,2] 來參考儲存在變數中的特定警告。

注意

警告變數包含命令所產生的所有警告，包括來自呼叫巢狀函式或腳本的警告。

風險管理參數描述

-WhatIf

顯示描述命令效果的訊息，而不是執行命令。

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

WhatIf 參數會覆寫目前命令的$WhatIfPreference變數值。因為變數的$WhatIfPreference預設值是 0（已停用），因此 WhatIf 行為不會在沒有 WhatIf 參數的情況下完成。如需詳細資訊，請參閱 about_Preference_Variables。

-WhatIf:$true 的效果與 -WhatIf相同。
-WhatIf:$false 會隱藏變數值為 $WhatIfPreference 1 時所產生的自動 WhatIf 行為。

例如，下列命令會在 -WhatIf 命令中使用 Remove-Item 參數：

Remove-Item Date.csv -WhatIf

PowerShell 不會移除專案，而是列出其所要執行的作業，以及受影響的專案。此命令會產生下列輸出：

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

-Confirm

在執行命令之前，提示您進行確認。

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

參數 Confirm 會覆寫目前命令的 $ConfirmPreference 變數值。預設值為 true。如需詳細資訊，請參閱 about_Preference_Variables。

-Confirm:$true 的效果與 -Confirm相同。
-Confirm:$false 會隱藏自動確認，當的值 $ConfirmPreference 小於或等於 Cmdlet 的估計風險時，就會發生這種確認。

例如，下列命令會搭配 Remove-Item 命令使用 Confirm 參數。拿掉專案之前，PowerShell 會列出其所要執行的作業，以及受影響的專案，並要求核准。

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

Confirm回應選項如下所示：

回應	結果
`Yes` （`Y`）	執行該動作。
`Yes to All` （`A`）	執行所有動作並隱藏後續的動作 Confirm
	此命令的查詢。
`No` （`N`）：	請勿執行動作。
`No to All` （`L`）：	請勿執行任何動作並隱藏後續動作
	Confirm 此命令的查詢。
`Suspend` （`S`）：	暫停命令並建立暫存會話。
`Help` （`?`）	顯示這些選項的說明。

[ 暫停 ] 選項會將命令置於保留狀態，並建立暫存巢狀會話，您可以在其中工作，直到您準備好選擇選項 Confirm 為止。巢狀會話的命令提示字元有兩個額外的插入號（>>）表示它是原始父命令的子作業。您可以在巢狀會話中執行命令和腳稿。若要結束巢狀會話並返回 Confirm 原始命令的選項，請輸入「exit」。

在下列範例中，當使用者檢查命令參數的說明時， 會使用 Suspend 選項（S）暫時停止命令。取得所需的信息之後，使用者輸入「exit」以結束巢狀提示，然後選取 [是] （y）回應查詢 Confirm 。

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

共用方式為