DSC környezeti erőforrás

A következőkre vonatkozik: Windows PowerShell 4.0, Windows PowerShell 5.x

A Windows PowerShell Desired State Configuration környezeti erőforrása (DSC) a rendszer környezeti változóinak kezelésére szolgál.

Megjegyzés

A DSC-erőforrás dokumentációja a PowerShell 7.2-es verzió előtti verzióját tartalmazza. A PSDscResources modul a Microsoft által hivatalosan támogatott új és frissített DSC-erőforrásokat tartalmaz. A PSDscResources modul elérhető a PowerShell-galéria.

További információkért és a frissített dokumentációért tekintse meg a PSDscResources referenciadokumentációját.

Syntax

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

Tulajdonságok

Tulajdonság	Leírás
Name (Név)	Annak a környezeti változónak a nevét jelzi, amelyhez egy adott állapotot szeretne biztosítani.
Elérési út	Meghatározza a konfigurált környezeti változót. Állítsa ezt a tulajdonságot arra $true az esetre, ha a változó az Elérési út változó, ellenkező esetben állítsa a értékre $false. A mező alapértelmezett értéke: $false. Ha a konfigurált változó az Elérési út változó, az Érték tulajdonságon keresztül megadott érték hozzá lesz fűzve a meglévő értékhez.
Érték	A környezeti változóhoz hozzárendelendő érték.

Közös tulajdonságok

Tulajdonság	Leírás
DependsOn	Azt jelzi, hogy egy másik erőforrás konfigurációjának futnia kell az erőforrás konfigurálása előtt. Ha például az először futtatni kívánt erőforrás-konfigurációs szkriptblokk azonosítója ResourceName, és típusa ResourceType, akkor a tulajdonság használatának szintaxisa a DependsOn = "[ResourceType]ResourceName"következő: .
Biztosítja	Azt jelzi, hogy létezik-e változó. Állítsa ezt a tulajdonságot Present értékre, hogy létrehozza a környezeti változót, ha nem létezik, vagy győződjön meg arról, hogy az értéke megegyezik az Érték tulajdonságon keresztül megadott értékkel, ha a változó már létezik. Állítsa a Hiányzó értékre a változó törléséhez, ha létezik.
PsDscRunAsCredential	Beállítja a hitelesítő adatokat a teljes erőforrás futtatásához.

Megjegyzés

A PsDscRunAsCredential common tulajdonság hozzá lett adva a WMF 5.0-s verziójához, hogy bármely DSC-erőforrást más hitelesítő adatokkal összefüggésben futtathasson. További információ: Hitelesítő adatok használata DSC-erőforrásokkal.

Példa

Az alábbi példa biztosítja, hogy a TestEnvironmentVariable jelen legyen, és a TestValue értékkel rendelkezik. Ha nincs jelen, létrehozza.

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