Среда
Краткий обзор
Управление переменной среды для компьютера или процесса.
Синтаксис
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
значение , убедитесь, что значениеPresent
не включено в текущее значение переменной среды, ресурс добавляет значение к текущему значению переменной среды. - Если путь имеет
$true
значение , убедитесь, что иAbsent
значение включено в текущее значение переменной среды, ресурс удаляет значение из текущего значения переменной среды. - Если задан
$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]
Значение
Укажите значение переменной среды в виде строки. Указывает, является ли значение пустой строкой (''
) модифицирует поведение проверки для переменной среды:
- Если значение является пустой строкой, убедитесь , что
Present
и переменная среды существует, ресурс не обновляет переменную среды. - Если значение является пустой строкой, убедитесь , что и
Present
переменная среды не существует, ресурс создает недопустимое исключение операции. - Если значение является пустой строкой, убедитесь , что
Absent
и существует переменная среды, ресурс удаляет переменную среды.
Значение по умолчанию — пустая строка.
Type: System.String
Default Value: ''
Примеры
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по