Umgebung

  • Artikel

Übersicht

Verwalten einer Umgebungsvariable für einen Computer oder Prozess.

Syntax

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

BESCHREIBUNG

Mit der Environment Ressource können Sie Umgebungsvariablen in den Machine und Process zielen erstellen, aktualisieren und entfernen. Sie kann Umgebungsvariablen vom Pfadtyp verwalten, um sicherzustellen, dass ein bestimmter Wert enthalten oder aus der Umgebungsvariable entfernt wird.

Requirements (Anforderungen)

Keine

Schlüsseleigenschaften

Name

Geben Sie den Namen der Umgebungsvariable an.

Type: System.String

Optionale Eigenschaften

Ensure

Geben Sie an, ob die Umgebungsvariable vorhanden sein soll. Geben Sie diese Eigenschaft an, um Absent die Umgebungsvariable zu entfernen, wenn sie vorhanden ist. Geben Sie diese Eigenschaft an, um Present die Umgebungsvariable zu erstellen, wenn sie nicht vorhanden ist, und erzwingen Sie die Value-Eigenschaft , wenn sie festgelegt ist. Standardwert: Present.

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

Pfad

Geben Sie an, ob die Umgebungsvariable als Pfadvariable behandelt werden soll. Dadurch wird das Verhalten "Sicherstellen " für die Umgebungsvariable geändert:

  • Wenn "Pfad"$truelautet, stellen Sie sicherPresent, dass der Wert nicht in den aktuellen Wert der Umgebungsvariable eingeschlossen ist, fügt die Ressource den Wert an den aktuellen Wert der Umgebungsvariable an.
  • Wenn "Pfad$true" lautet, stellen Sie sicherAbsent, dass der Wert in den aktuellen Wert der Umgebungsvariable eingeschlossen ist, entfernt die Ressource den Wert aus dem aktuellen Wert der Umgebungsvariable.
  • Wenn "Pfad " $false und "Sicherstellen " lautet Present, legt die Ressource die Umgebungsvariable auf "Value" fest.
  • Wenn "Pfad " $false und "Sicherstellen " ist Absent, entfernt die Ressource die Umgebungsvariable.

Standardwert: $false.

Type: System.Boolean
Default Value: false

Ziel

Geben Sie ein oder mehrere Ziel an, um die Umgebungsvariable zu konfigurieren. Gültige Werte:

  • Process
  • Machine

Standardmäßig wird die Umgebungsvariable sowohl in den als Machine auch in den Process Zielen konfiguriert.

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

Wert

Geben Sie den Wert der Umgebungsvariable als Zeichenfolge an. Gibt an, ob Value eine leere Zeichenfolge ('') das Verhalten für die Umgebungsvariable ändert:

  • Wenn Value eine leere Zeichenfolge ist, stellen Sie sicherPresent, dass die Umgebungsvariable vorhanden ist, aktualisiert die Ressource die Umgebungsvariable nicht.
  • Wenn Value eine leere Zeichenfolge ist, stellen Sie sicherPresent, dass die Umgebungsvariable nicht vorhanden ist, löst die Ressource eine ungültige Vorgangs ausnahme aus.
  • Wenn Value eine leere Zeichenfolge ist, stellen Sie sicherAbsent, dass die Umgebungsvariable vorhanden ist, entfernt die Ressource die Umgebungsvariable.

Der Standardwert ist eine leere Zeichenfolge.

Type: System.String
Default Value: ''

Beispiele