Freigeben über

DSC-Resource „Environment“

  • Artikel

Gilt für: Windows PowerShell 4.0, Windows PowerShell 5.x

Die Ressource Environment in Windows PowerShell DSC bietet einen Mechanismus zum Verwalten von Systemumgebungsvariablen.

Hinweis

In dieser Dokumentation dieser DSC-Ressource wird die Version behandelt, die in PowerShell vor Version 7.2 enthalten ist. Das PSDscResources-Modul enthält neue und aktualisierte DSC-Ressourcen, die offiziell von Microsoft unterstützt werden. Das Modul PSDscResources ist im PowerShell-Katalog verfügbar.

Weitere Informationen und aktualisierte Dokumentation finden Sie in der PSDscResources-Referenzdokumentation.

Syntax

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

Eigenschaften

Eigenschaft BESCHREIBUNG
Name Gibt den Namen der Umgebungsvariablen an, für die Sie einen bestimmten Zustand sicherstellen möchten.
`Path` Definiert die Umgebungsvariable, die konfiguriert wird. Legen Sie diese Eigenschaft auf $true fest, wenn die Variable die Path-Variable ist. Legen Sie sie andernfalls auf $false fest. Der Standardwert lautet $false. Wenn die konfigurierte Variable die Path-Variable ist, wird der von der Value-Eigenschaft bereitgestellte Wert an den vorhandenen Wert angefügt.
Wert Der Wert, der der Umgebungsvariablen zugewiesen werden soll.

Allgemeine Eigenschaften

Eigenschaft BESCHREIBUNG
DependsOn Gibt an, dass die Konfiguration einer anderen Ressource ausgeführt werden muss, bevor diese Ressource konfiguriert wird. Wenn beispielsweise die ID des Skriptblocks mit der Ressourcenkonfiguration, den Sie zuerst ausführen möchten, „ResourceName“ und dessen Typ „ResourceType“ ist, lautet die Syntax für das Verwenden dieser Eigenschaft DependsOn = "[ResourceType]ResourceName".
Ensure Gibt an, ob eine Variable vorhanden ist. Legen Sie diese Eigenschaft auf Present fest, um die Umgebungsvariable zu erstellen, falls sie noch nicht vorhanden ist, oder um sicherzustellen, dass ihr Wert der Angabe durch die Value-Eigenschaft entspricht, wenn die Variable bereits vorhanden ist. Legen Sie sie auf Absent fest, um die Variable zu löschen, falls sie vorhanden ist.
PsDscRunAsCredential Legt die Anmeldeinformationen für die Ausführung der gesamten Ressource fest.

Hinweis

Die allgemeine Eigenschaft PsDscRunAsCredential wurde in WMF 5.0 hinzugefügt, um das Ausführen einer beliebigen DSC-Ressource in Verbindung mit anderen Anmeldeinformationen zu ermöglichen. Weitere Informationen finden Sie unter Use Credentials with DSC Resources (Verwenden von Anmeldeinformationen mit DSC-Ressourcen).

Beispiel

Im folgende Beispiel wird sichergestellt, dass TestEnvironmentVariable vorhanden ist und den Wert TestValue hat. Falls sie nicht vorhanden ist, wird sie erstellt.

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