參數

  • 發行項

 

適用版本： Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1, Exchange Server 2007

上次修改主題的時間： 2007-06-20

大多數指令程式都依賴參數。參數是提供資訊給指令程式的元素，用以識別所要運用的物件及其屬性，或控制指令程式執行工作的方式。參數名稱前面有連字號 (-)，後面有參數值，如下所示：

Verb-Noun -ParameterName <ParameterValue>

在此簡單範例中，參數名稱前面的連字號告訴 Exchange 管理命令介面，緊跟在連字號之後的字是傳遞至指令程式的參數，而在參數之後下一個前面有空格的字則是參數值。

位置參數

位置參數是讓您指定參數值但不需要指定參數名稱的參數。如果 Parameter Position 屬性是整數，則此參數是位置參數。此整數指出指令程式可以在命令列上找到參數值的位置。

大多數指令程式都只有一個位置參數 Identity。如果 Identity 可以在指令程式上使用，則永遠是在位置 1。如果參數不是位置參數，則會視為 named 參數。您必須指定 named 參數的參數名稱及參數值。

下列兩個命令執行相同的工作：傳回名為 "Contoso" 之接收連接器的組態資訊。

Get-ReceiveConnector -Identity "Contoso"
Get-ReceiveConnector "Contoso"

參數詳細資料

在 Get-Help 指令程式所擷取的資訊中，Parameters 區段含有每個參數的詳細資料，也稱為中繼資料。下列範例是來自 Get-Service 指令程式。

PARAMETERS
    -ServiceName System.String[]

        Parameter required?           false
        Parameter position?           1
        Default value                 *
        Accept pipeline input?       true
        Accept wildcard characters?  True

此範例來自 Get-Service 指令程式，其中包含一些關於 ServiceName 參數可傳遞之值類型的詳細資料。並非所有指令程式都會包含這類詳細資料。不過，大多數指令程式確實會包含每個參數的某些設定，如表 1 所述。

表 1 參數設定

設定 描述

Required?

此設定指出如果未提供此參數，是否要執行指令程式。當 Required? 設定為 True 時，如果未在命令列上提供此參數，則 Exchange 管理命令介面會提示您提供該值。

Position?

此設定指出您是否必須將參數名稱放在參數值前面。當 Position? 設定為 Named 時，需要參數名稱。

當 Position? 設定為整數時，不需要參數名稱，只需要值。

Default value

此設定指出如果未提供任何其他值，此參數將使用的預設值。

Accept pipeline input?

此設定指出參數是否可以接收由另一個指令程式透過管線輸入的值。

Accept wildcard characters?

此設定指出參數值是否可以包含萬用字元，以及是否可以對應至多個物件。

布林參數

布林參數用於 Exchange 管理命令介面，以判定某個功能或選項為啟用 ($True) 或停用 ($False) 狀態。您指派給布林參數的值會儲存在所修改物件的組態中。提供布林參數的值時，必須使用值 $True (或 1)，或 $False (或 0)。$True 及 $False 必須包含貨幣符號 ($)。您可能注意到某些命令會在布林參數名稱與布林值之間插入冒號 (:)。在布林參數上，此冒號是選用的。下列範例會停用接收連接器 "Contoso.com"：

Set-ReceiveConnector "Contoso.com" -Enabled $False

切換參數

在 Exchange 管理命令介面中，「切換參數」可用於設定命令的立即執行狀態。此狀態不會保留在其他命令中。切換參數類似於布林參數，但是有不同目的和不同語法。切換參數不需要有值。如果在命令列上指定不含值的切換參數，則參數預設會評估為 $True。切換參數和布林參數一樣只接受 $True (或 1)，或 $False (或 0)。$True 及 $False 必須包含貨幣符號 ($)。與布林參數不同的是，您必須在切換參數名稱與切換參數值之間加上冒號 (:)。下列第一個範例會指示 Exchange 管理命令介面在進行 EdgeSync 同步處理之前，先顯示確認提示。第二個範例會指示 Exchange 管理命令介面不要在刪除接收連接器 "Contoso.com" 之前顯示確認提示：

Start-EdgeSynchronization -Confirm
Remove-ReceiveConnector "Contoso.com" -Confirm:$False

共用參數

「共用參數」是 Exchange 管理命令介面會自動新增至所有命令的參數。這些參數所執行的功能可以配合所搭配的命令使用，或是由這些命令使用。表 2 列出所有可在 Exchange 管理命令介面中使用的共用參數。另外三個參數 WhatIf、Confirm 及 ValidateOnly 也可以加到指令程式中。如需這三個參數的相關資訊，請參閱 WhatIf、Confirm 及 ValidateOnly 參數。

表 2 Exchange 管理命令介面中的共用參數

參數名稱 必要 類型 描述

Verbose

選用

System.Boolean

此參數會指示命令提供作業的詳細資訊。

note附註：
大多數 Get 指令程式只會在您執行它們時傳回摘要資訊。若要告訴 Get 指令程式在您執行命令時傳回詳細資訊，請利用管線將命令送至 Format-List 指令程式。
如需管線的相關資訊，請參閱管線。如需命令輸出的相關資訊，請參閱使用命令列輸出。

Debug

選用

System.Boolean

此參數會指示命令提供作業的程式設計師等級詳細資料。

ErrorAction

選用

System.Enum

此參數控制錯誤發生時命令的行為。值如下：

  • NotifyContinue，此為預設值。

  • NotifyStop

  • SilentContinue

  • SilentStop

  • Inquire，詢問使用者要執行的動作

ErrorVariable

選用

System.String

此參數指定命令用來儲存在處理期間發現之錯誤的變數名稱。除了 $ERROR 之外，也會填入此變數。

OutVariable

選用

System.String

此參數指定用於儲存此命令所輸出物件的變數名稱。這相當於利用管線將命令送至 Set-Variable <name> -Passthru:$true