Ресурс Environment в DSC

Область применения: Windows PowerShell 4.0, Windows PowerShell 5.x

Ресурс Environment в DSC Windows PowerShell предоставляет механизм управления системными переменными среды.

Примечание

В этой документации по этому ресурсу DSC рассматривается версия, которая входит в состав PowerShell до версии 7.2. Модуль PSDscResources содержит новые и обновленные ресурсы DSC, которые официально поддерживаются корпорацией Майкрософт. Модуль PSDscResources доступен из коллекции PowerShell.

Дополнительные сведения и обновленную документацию см. в справочной документации по PSDscResources.

Синтаксис

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

Свойства

Свойство	Описание
Имя	Указывает имя переменной среды, для которой требуется обеспечить определенное состояние.
путь	Определяет настраиваемую переменную среды. Для переменной 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"
}