DSC 環境資源

適用於：Windows PowerShell 4.0、Windows PowerShell 5.x

Windows PowerShell 預期狀態設定 (DSC) 的環境資源會提供管理系統環境變數的機制。

注意

此 DSC 資源的本檔涵蓋 7.2 版之前 PowerShell 隨附的版本。 PSDscResources模組包含 Microsoft 正式支援的全新和更新 DSC 資源。 PSDscResources 模組可從 PowerShell 資源庫中取得。

如需詳細資訊和更新的檔，請參閱 PSDscResources 參考檔。

語法

Environment [string] #ResourceName
{
    Name = [string]
    [ Path = [bool] ]
    [ Value = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

屬性

屬性	描述
名稱	指出您要確保其特定狀態的環境變數名稱。
Path	定義設定中的環境變數。 如果變數是 Path 變數，請將這個屬性設定為 $true；否則請設定為 $false。 預設值為 $false。 如果要設定的變數是 Path 變數，則透過 Value 屬性提供的值就會附加至現有的值。
值	要指派給環境變數的值。

通用屬性

屬性	描述
DependsOn	表示必須先執行另一個資源的設定，再設定這個資源。 例如，如果第一個想要執行的資源設定指令碼區塊識別碼是 ResourceName，而其類型是 ResourceType，則使用這個屬性的語法就是 DependsOn = "[ResourceType]ResourceName"。
Ensure	指出變數是否存在。 如果沒有環境變數，請將這個屬性設為 Present 以建立環境變數；或如果已有變數，則確保其值符合透過 Value 屬性所提供的值。 如果有變數，將它設為 Absent 可刪除變數。
PsDscRunAsCredential	設定用於執行整個資源的認證。

注意

已在 WMF 5.0 中新增 PsDscRunAsCredential 通用屬性，以允許在其他認證的內容中執行任何 DSC 資源。 如需詳細資訊，請參閱搭配 DSC 資源使用認證。

範例

下例確保 TestEnvironmentVariable 存在，且有值 TestValue。 如果不存在，就會建立它。

Environment EnvironmentExample
{
    Ensure = "Present"  # You can also set Ensure to "Absent"
    Name = "TestEnvironmentVariable"
    Value = "TestValue"
}