通过

环境

  • 项目

摘要

管理计算机或进程的环境变量。

语法

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

路径

指定是否将环境变量视为路径变量。 这会修改环境变量的 “确保 ”行为：

  • 当 Path 为 $true， Ensure is Present，且 值 不包含在环境变量的当前值中时，资源会将 Value 追加到环境变量的当前值。
  • 当路径为$true，“确保”和Absent“值”包含在环境变量的当前值中时，资源将从环境变量的当前值中删除 Value。
  • 路径为$false“确保Present”时，资源会将环境变量设置为“值”。
  • 路径为$false“确保Absent”时，资源将删除环境变量。

默认值为 $false。

Type: System.Boolean
Default Value: false

目标

指定要在其中配置环境变量的一个或多个目标。 有效值包括：

  • Process
  • Machine

默认情况下，环境变量同时在目标Machine中Process配置。

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

值

将环境变量的值指定为字符串。 Value 是否为空字符串 ('') 修改环境变量的“确保”行为：

  • 如果 Value 是空字符串， 则确保 存在 Present，并且环境变量存在，则资源不会更新环境变量。
  • 当 Value 是空字符串时， 确保 不存在 Present，并且环境变量不存在，则资源将引发无效的操作异常。
  • 如果 Value 是空字符串， 则确保 存在 Absent，并且环境变量存在，则资源将删除环境变量。

默认值为空字符串。

Type: System.String
Default Value: ''

示例