DSC beállításjegyzék-erőforrás

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

A Windows PowerShell Desired State Configuration (DSC) beállításjegyzék-erőforrása mechanizmust biztosít a beállításkulcsok és értékek kezelésére a célcsomóponton.

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

Registry [string] #ResourceName
{
    Key = [string]
    ValueName = [string]
    [ Force =  [bool]   ]
    [ Hex = [bool] ]
    [ ValueData = [string[]] ]
    [ ValueType = [string] { Binary | Dword | ExpandString | MultiString | Qword | String }  ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Present | Absent }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Tulajdonságok

Tulajdonság	Leírás
Kulcs	Annak a beállításkulcsnak az elérési útját jelzi, amelyhez egy adott állapotot szeretne biztosítani. Ennek az elérési útnak tartalmaznia kell a kaptárat.
ValueName	A beállításjegyzék-érték nevét jelzi. Beállításkulcs hozzáadásához vagy eltávolításához adja meg ezt a tulajdonságot üres sztringként a ValueType vagy a ValueData megadása nélkül. A beállításkulcs alapértelmezett értékének módosításához vagy eltávolításához adja meg ezt a tulajdonságot üres sztringként, miközben a ValueType vagy a ValueData értéket is megadja.
Force	Ha a megadott beállításkulcs jelen van, a Force felülírja azt az új értékkel. Ha egy beállításkulcsot alkulcsokkal töröl, annak a következőnek kell lennie $true: .
Hex	Azt jelzi, hogy az adatok hexadecimális formátumban lesznek-e kifejezve. Ha meg van adva, a DWORD/QWORD értékadatok hexadecimális formátumban jelennek meg. Más típusokra nem érvényes. Az alapértelmezett érték $false.
ValueData	A beállításjegyzék-érték adatai.
ÉrtékTípusa	Az érték típusát jelzi. Támogatott típusok: Sztring (REG_SZ), Bináris (REG_BINARY), Dword (32 bites REG_DWORD), Qword (64 bites REG_QWORD), MultiString (REG_MULTI_SZ), ExpandString (REG_EXPAND_SZ).

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 a kulcs és az érték létezik-e. Ennek biztosításához állítsa ezt a tulajdonságot a Present (Megjelenítés) értékre. Ha meg szeretné győződni arról, hogy nem léteznek, állítsa a tulajdonságot Hiányzó értékre. Az alapértelmezett érték a Jelen.
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éldák

1. példa: A megadott érték és adatok biztosítása a megadott beállításkulcs alatt

Ez a példa biztosítja, hogy a "ExampleKey1" nevű kulcs "TestValue" beállításjegyzék-értéke jelen legyen a HKEY\_LOCAL\_MACHINE hive-ben, és a "TestData" adatokkal rendelkezik.

Configuration RegistryTest
{
    Import-DscResource -ModuleName 'PSDesiredStateConfiguration'

    Registry RegistryExample
    {
        Ensure      = "Present"  # You can also set Ensure to "Absent"
        Key         = "HKEY_LOCAL_MACHINE\SOFTWARE\ExampleKey1"
        ValueName   = "TestValue"
        ValueData   = "TestData"
    }
}

2. példa: Győződjön meg arról, hogy a megadott beállításkulcs létezik

Ez a példa biztosítja, hogy egy "ExampleKey2" nevű kulcs szerepel a HKEY_LOCAL_MACHINE hive-ben.

Configuration RegistryTest
{
    Import-DscResource -ModuleName 'PSDesiredStateConfiguration'

    Registry RegistryExample
    {
        Ensure      = "Present"  # You can also set Ensure to "Absent"
        Key         = "HKEY_LOCAL_MACHINE\SOFTWARE\ExampleKey2"
        ValueName   = ""
    }
}

Megjegyzés

A hive beállításjegyzék-beállításainak HKEY_CURRENT_USER módosításához a konfigurációnak nem rendszerként, hanem felhasználói hitelesítő adatokkal kell futnia. A PsDscRunAsCredential tulajdonság használatával megadhatja a konfigurációhoz tartozó felhasználói hitelesítő adatokat. Példa: DSC futtatása felhasználói hitelesítő adatokkal.