共用方式為

環境

  • 發行項

概要

管理機器或進程的環境變數。

語法

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

描述

資源 Environment 可讓您在 和 Process 目標中 Machine 建立、更新和移除環境變數。 它可以管理路徑類型環境變數，確保包含或移除環境變數中的特定值。

規格需求

無。

金鑰屬性

名稱

指定環境變數的名稱。

Type: System.String

選擇性屬性

Ensure

指定環境變數是否應該存在。 將此屬性指定為 Absent ，以在存在時移除環境變數。 將此屬性指定為 Present ，以在環境變數不存在時建立，並在設定時強制執行 Value 屬性。 預設值是 Present。

Type: System.String
Accepted Values:
  - Absent
  - Present
Default Value: Present

路徑

指定是否要將環境變數視為路徑變數。 這會修改環境變數的 Ensure 行為：

  • 當 Path 為 $true 時， 請確定 為 Present ，且 值 未包含在環境變數的目前值中，資源會將 Value 附加至環境變數的目前值。
  • 當 Path 為 $true 時， 請確定 為 Absent ，且 Value 包含在環境變數的目前值中，資源會從環境變數的目前值中移除 Value 。
  • 當Path為 且[確定] 為 Present$false 時，資源會將環境變數設定為Value。
  • 當Path為 且[確定] 為 Absent$false 時，資源會移除環境變數。

預設值是 $false。

Type: System.Boolean
Default Value: false

目標

指定要在其中設定環境變數的一或多個目標。 有效值包括：

  • Process
  • Machine

根據預設，環境變數會在 和 Machine 目標中 Process 設定。

Type: System.String[]
Accepted Values:
  - Process
  - Machine
Default Value: [Process, Machine]

值

將環境變數的值指定為字串。 Value是否為空字串 ('') 修改環境變數的Ensure行為：

  • 當 Value 是空字串時， 請確定 為 Present ，而且環境變數存在，資源就不會更新環境變數。
  • 當 Value 是空字串時， 請確定 為 Present ，而且環境變數不存在，資源會擲回不正確作業例外狀況。
  • 當 Value 是空字串時， 請確定 為 Absent ，而且環境變數存在，資源會移除環境變數。

預設值為空字串。

Type: System.String
Default Value: ''

範例