EnvironmentVariables is used to configure and manage environment variables for a machine or process.
Source |
|
DSC Resource |
|
Documentation |
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
Hashtable[] |
Set of environment variables. |
Parameter | Attribute | DataType | Description | Allowed Values |
---|---|---|---|---|
Name |
Key |
String |
The name of the environment variable for which you want to ensure a specific state. |
|
Value |
String |
The desired value for the environment variable. The default value is an empty string which either indicates that the variable should be removed entirely or that the value does not matter when testing its existence. Multiple entries can be entered and separated by semicolons. |
||
Ensure |
String |
Specifies if the environment variable should exist. |
|
|
Path |
Boolean |
Indicates whether or not the environment variable is a path variable. If the variable being configured is a path variable, the value provided will be appended to or removed from the existing value, otherwise the existing value will be replaced by the new value. When configured as a Path variable, multiple entries separated by semicolons are ensured to be either present or absent without affecting other Path entries. |
|
|
Target |
String[] |
Indicates the target where the environment variable should be set. |
|
EnvironmentVariables:
Variables:
- Name: var1
Target: Machine
Value: 123
- Name: var2
Target: Machine
Value: 456