Recursos de DSC Environment

Se aplica a: Windows PowerShell 4.0, Windows PowerShell 5.x

El recurso Environment de la configuración de estado deseado (DSC) de PowerShell ofrece un mecanismo para administrar variables de entorno del sistema.

Nota

Esta documentación de este recurso de DSC trata la versión que se incluye con PowerShell antes de la versión 7.2. El módulo PSDscResources contiene recursos de DSC nuevos y actualizados compatibles oficialmente con Microsoft. El módulo PSDscResources está disponible en la Galería de PowerShell.

Para obtener más información y documentación actualizada, consulte la documentación de referencia de PSDscResources.

Sintaxis

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

Propiedades

Propiedad	Descripción
Nombre	Indica el nombre de la variable de entorno para la que quiere garantizar un estado específico.
Path	Define la variable de entorno que se está configurando. Establezca esta propiedad en $true si la variable es la variable Path; de lo contrario, establézcala en $false. El valor predeterminado es $false. Si la variable que se está configurando es la variable Path, el valor facilitado mediante la propiedad Value se anexará al valor existente.
Valor	Valor que se asigna a la variable de entorno.

Propiedades comunes

Propiedad	Descripción
DependsOn	Indica que la configuración de otro recurso debe ejecutarse antes de que se configure este recurso. Por ejemplo, si el elemento ID del bloque del script de configuración del recurso que quiere ejecutar primero es ResourceName y su tipo es ResourceType, la sintaxis para usar esta propiedad es DependsOn = "[ResourceType]ResourceName".
Ensure	Indica si existe una variable. Establezca esta propiedad en Present para crear la variable de entorno si no existe o para garantizar que su valor coincida con el que se proporciona mediante la propiedad Value si la variable ya existe. Establézcala en Absent para eliminar la variable si existe.
PsDscRunAsCredential	Establece la credencial con la que se ejecutará todo el recurso.

Nota

Se ha agregado la propiedad común PsDscRunAsCredential en WMF 5.0 para permitir la ejecución de cualquier recurso de DSC en el contexto de otras credenciales. Para obtener más información, vea Uso de las credenciales con recursos de DSC.

Ejemplo

El ejemplo siguiente se asegura de que TestEnvironmentVariable exista y tenga el valor TestValue. Si no existe, se crea.

Environment EnvironmentExample
{
    Ensure = "Present"  # You can also set Ensure to "Absent"
    Name = "TestEnvironmentVariable"
    Value = "TestValue"
}