Entorno

  • Artículo

Sinopsis

Administrar una variable de entorno para una máquina o proceso.

Sintaxis

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

Descripción

El Environment recurso permite crear, actualizar y quitar variables de entorno en los Machine destinos y Process . Puede administrar variables de entorno de tipo path, lo que garantiza que se incluye o se quita un valor específico de la variable de entorno.

Requisitos

Ninguno.

Propiedades de la clave

Nombre

Especifique el nombre de la variable de entorno.

Type: System.String

Propiedades opcionales

Ensure

Especifique si la variable de entorno debe existir. Especifique esta propiedad como Absent para quitar la variable de entorno si existe. Especifique esta propiedad como Present para crear la variable de entorno si no existe y aplicar la propiedad Value si está establecida. El valor predeterminado es Present.

Type: System.String
Accepted Values:
  - Absent
  - Present
Default Value: Present

Ruta de acceso

Especifique si se va a tratar la variable de entorno como una variable de ruta de acceso. Esto modifica el comportamiento De garantizar para la variable de entorno:

  • Cuando Path es $true, Asegúrese de que es Presenty value no se incluye en el valor actual de la variable de entorno, el recurso anexa el valor al valor actual de la variable de entorno.
  • Cuando Path es $true, Asegúrese de que es Absenty value se incluye en el valor actual de la variable de entorno, el recurso quita el valor del valor actual de la variable de entorno.
  • Cuando Path es y Ensure es Present$false , el recurso establece la variable de entorno en Value.
  • Cuando Path es $false y Ensure es Absent, el recurso quita la variable de entorno.

El valor predeterminado es $false.

Type: System.Boolean
Default Value: false

Destino

Especifique uno o varios destinos en los que configurar la variable de entorno. Los valores válidos son:

  • Process
  • Machine

De forma predeterminada, la variable de entorno se configura en los Process destinos y Machine .

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

Value

Especifique el valor de la variable de entorno como una cadena. Si Value es una cadena vacía ('') modifica el comportamiento De garantizar para la variable de entorno:

  • Cuando Value es una cadena vacía, Asegúrese de que es Presenty la variable de entorno existe, el recurso no actualiza la variable de entorno.
  • Cuando Value es una cadena vacía, Ensure es Presenty la variable de entorno no existe, el recurso produce una excepción de operación no válida.
  • Cuando Value es una cadena vacía, Asegúrese de que es Absenty la variable de entorno existe, el recurso quita la variable de entorno.

El valor predeterminado es una cadena vacía.

Type: System.String
Default Value: ''

Ejemplos