DSC-miljöresurs

Gäller för: Windows PowerShell 4.0, Windows PowerShell 5.x

Miljöresursen i Windows PowerShell Desired State Configuration (DSC) tillhandahåller en mekanism för att hantera systemmiljövariabler.

Anteckning

Den här dokumentationen för den här DSC-resursen omfattar den version som ingår i PowerShell före version 7.2. MODULen PSDscResources innehåller nya och uppdaterade DSC-resurser som stöds officiellt av Microsoft. Modulen PSDscResources är tillgänglig från PowerShell-galleriet.

Mer information och uppdaterad dokumentation finns i referensdokumentationen för PSDscResources.

Syntax

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

Egenskaper

Egenskap	Beskrivning
Name	Anger namnet på miljövariabeln som du vill säkerställa ett visst tillstånd för.
Sökväg	Definierar miljövariabeln som konfigureras. Ange den här egenskapen till $true om variabeln är variabeln Sökväg . Annars anger du den till $false. Standardvärdet är $false. Om variabeln som konfigureras är variabeln Sökväg läggs värdet som tillhandahålls via egenskapen Value till det befintliga värdet.
Värde	Värdet som ska tilldelas till miljövariabeln.

Gemensamma egenskaper

Egenskap	Beskrivning
DependsOn	Anger att konfigurationen av en annan resurs måste köras innan den här resursen har konfigurerats. Om till exempel ID:t för det resurskonfigurationsskriptblock som du vill köra först är ResourceName och dess typ är ResourceType är DependsOn = "[ResourceType]ResourceName"syntaxen för att använda den här egenskapen .
Säkerställa	Anger om det finns en variabel. Ställ in den här egenskapen på Presentera för att skapa miljövariabeln om den inte finns eller för att säkerställa att dess värde matchar det som tillhandahålls via egenskapen Value om variabeln redan finns. Ställ in den på Frånvarande för att ta bort variabeln om den finns.
PsDscRunAsCredential	Anger autentiseringsuppgifterna för att köra hela resursen som.

Anteckning

Den vanliga egenskapen PsDscRunAsCredential lades till i WMF 5.0 för att tillåta körning av valfri DSC-resurs i kontexten för andra autentiseringsuppgifter. Mer information finns i Använda autentiseringsuppgifter med DSC-resurser.

Exempel

I följande exempel ser du till att TestEnvironmentVariable finns och att det har värdet TestValue. Om den inte finns skapar den den.

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