Set-Variable

模組:: Microsoft.PowerShell.Utility Module

設定變數的值。如果其中一個具有要求的名稱不存在，則建立變數。

語法

Default (預設值)

Set-Variable
    [-Name] <String[]>
    [[-Value] <Object>]
    [-Include <String[]>]
    [-Exclude <String[]>]
    [-Description <String>]
    [-Option <ScopedItemOptions>]
    [-Force]
    [-Visibility <SessionStateEntryVisibility>]
    [-PassThru]
    [-Scope <String>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Set-Variable Cmdlet 會將值指派給指定的變數，或變更目前的值。如果變數不存在，Cmdlet 會建立它。

範例

範例 1：設定變數並取得其值

PS C:\> Set-Variable -Name "desc" -Value "A description"
PS C:\> Get-Variable -Name "desc"

這些命令會將 desc 變數的值設定為 A 描述，然後取得變數的值。

範例 2：設定全域只讀變數

PS C:\> Set-Variable -Name "processes" -Value (Get-Process) -Option constant -Scope global -Description "All processes" -PassThru | Format-List -Property *

此命令會建立全域只讀變數，其中包含系統上的所有進程，然後顯示變數的所有屬性。

命令會使用 Set-Variable Cmdlet 來建立變數。它會使用 PassThru 參數來建立代表新變數的物件，並使用管線運算符（|）將對象傳遞至 Format-List Cmdlet。它會使用 Format-List 的 Property 參數搭配 all ≦ 的值來顯示新建立變數的所有屬性。

值 “（Get-Process）”會以括弧括住，以確保在變數中儲存之前先執行該值。否則，變數會包含「Get-Process」一詞。

範例 3：瞭解公用變數與私用變數

PS C:\> New-Variable -Name "counter" -Visibility Public -Value 26
PS C:\> $Counter
26
PS C:\> Get-Variable c*

Name                  Value
----                  -----
Culture               en-US
ConsoleFileName
ConfirmPreference     High
CommandLineParameters {}
Counter               26

PS C:\> Set-Variable -Name "counter" -Visibility Private
PS C:\> Get-Variable c*

Name                  Value
----                  -----
Culture               en-US
ConsoleFileName
ConfirmPreference     High
CommandLineParameters {}

 PS C:\> $counter
"Cannot access the variable '$counter' because it is a private variable"

PS C:\> .\use-counter.ps1
#Commands completed successfully.

此命令示範如何將變數的可見性變更為 Private。此變數可由具有必要許可權的腳本讀取和變更，但使用者看不到此變數。

範例輸出會顯示公用和私用變數行為的差異。

參數

-Confirm

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

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False
別名:	cf

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Description

指定變數的描述。

參數屬性

類型:	String
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Exclude

指定此 Cmdlet 從作業中排除的項目列表。此參數的值對路徑參數進行限定。輸入路徑元素或模式，例如 *.txt。允許使用通配符。

參數屬性

類型:	String[]
預設值:	None
支援萬用字元:	True
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Force

可讓您建立名稱與現有唯讀變數相同的變數，或變更只讀變數的值。

根據預設，您可以覆寫變數，除非變數具有 ReadOnly 或 Constant 的選項值。如需詳細資訊，請參閱 Option 參數。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Include

指定此 Cmdlet 包含在作業中的項目陣列。此參數的值用來說明 Name 參數。輸入名稱或名稱模式，例如 c*。允許使用通配符。

參數屬性

類型:	String[]
預設值:	None
支援萬用字元:	True
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Name

指定變數名稱。

參數屬性

類型:	String[]
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	0
必要:	True
來自管線的值:	False
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Option

指定變數 Options 屬性的值。

有效值為：

無：未設定任何選項。（“None” 是預設值。
ReadOnly：可以刪除。除非使用 Force 參數，否則無法變更。
常數：無法刪除或變更。只有在您建立變數時，「常數」才有效。您無法將現有變數的選項變更為「Constant」。
私用：變數只能在目前的範圍內使用。
AllScope：變數會複製到任何已建立的新範圍。

若要檢視工作階段中所有變數的 Options 屬性，請輸入 Get-Variable | Format-Table -Property name, options -Autosize。

參數屬性

類型:	ScopedItemOptions
預設值:	None
接受的值:	None, ReadOnly, Constant, Private, AllScope, Unspecified
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-PassThru

傳回代表新變數的物件。根據預設，此 Cmdlet 不會產生任何輸出。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Scope

指定變數的範圍。此參數可接受的值為：

全球
本地
劇本
私人
相對於目前範圍的數位（0 到範圍的數目，其中0是目前的範圍，1是其父系）。

本機是預設值。

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

參數屬性

類型:	String
預設值:	Local
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-Value

指定變數的值。

參數屬性

類型:	Object
預設值:	None
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	1
必要:	False
來自管線的值:	True
來自管線按屬性名稱的值:	True
來自剩餘引數的值:	False

-Visibility

判斷變數是否顯示在建立該變數的會話之外。此參數的設計目的是要用於將傳遞給其他使用者的腳本和命令中。

有效值為：

公用：可見變數。（“Public” 是預設值。
私用：看不到變數。

當變數為私用時，它不會出現在變數清單中，例如 Get-Variable 所傳回的變數，或顯示在 Variable：磁碟驅動器的清單中。讀取或變更私用變數值的命令會傳回錯誤。不過，如果使用者在定義變數的會話中寫入命令，則可以執行使用私用變數的命令。

參數屬性

類型:	SessionStateEntryVisibility
預設值:	Public
接受的值:	Public, Private
支援萬用字元:	False
不要顯示:	False

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

-WhatIf

顯示 Cmdlet 執行時會發生什麼事。指令未執行。

參數屬性

類型:	SwitchParameter
預設值:	False
支援萬用字元:	False
不要顯示:	False
別名:	無線

參數集

(All)

Position:	Named
必要:	False
來自管線的值:	False
來自管線按屬性名稱的值:	False
來自剩餘引數的值:	False

CommonParameters

此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。如需詳細資訊，請參閱 about_CommonParameters。

輸入

Object

您可以使用管線將代表變數值的物件傳送至 set-Variable。

輸出

None or System.Management.Automation.PSVariable

當您使用 PassThru 參數時，Set-Variable 會產生代表新變數或已變更變數的 System.Management.Automation.PSVariable 物件。否則，此 Cmdlet 不會產生任何輸出。

共用方式為

Set-Variable

語法

Default (預設值)

Description

範例

範例 1：設定變數並取得其值

範例 2：設定全域只讀變數

範例 3：瞭解公用變數與私用變數

參數

-Confirm

參數屬性

參數集

-Description

參數屬性

參數集

-Exclude

參數屬性

參數集

-Force

參數屬性

參數集

-Include

參數屬性

參數集

-Name

參數屬性

參數集

-Option

參數屬性

參數集

-PassThru

參數屬性

參數集

-Scope

參數屬性

參數集

-Value

參數屬性

參數集

-Visibility

參數屬性

參數集

-WhatIf

參數屬性

參數集

CommonParameters

輸入

Object

輸出

None or System.Management.Automation.PSVariable

相關連結