DSC-registerresurs

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

Registerresursen i Windows PowerShell Desired State Configuration (DSC) tillhandahåller en mekanism för att hantera registernycklar och värden på en målnod.

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

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] ]
}

Egenskaper

Egenskap	Beskrivning
Nyckel	Anger sökvägen till registernyckeln som du vill säkerställa ett visst tillstånd för. Den här sökvägen måste innehålla registreringsdatafilen.
ValueName	Anger namnet på registervärdet. Om du vill lägga till eller ta bort en registernyckel anger du den här egenskapen som en tom sträng utan att ange ValueType eller ValueData. Om du vill ändra eller ta bort standardvärdet för en registernyckel anger du den här egenskapen som en tom sträng samtidigt som du anger ValueType eller ValueData.
Force	Om den angivna registernyckeln finns skriver Force över den med det nya värdet. Om du tar bort en registernyckel med undernycklar måste detta vara $true.
Hex	Anger om data ska uttryckas i hexadecimalt format. Om detta anges visas DWORD/QWORD-värdedata i hexadecimalt format. Ogiltigt för andra typer. Standardvärdet är $false.
ValueData	Data för registervärdet.
Värdetyp	Anger typen av värde. De typer som stöds är: String (REG_SZ), Binary (REG_BINARY), Dword (32-bitars REG_DWORD), Qword (64-bitars REG_QWORD), MultiString (REG_MULTI_SZ), ExpandString (REG_EXPAND_SZ).

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 resurskonfigurationsskriptblocket 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 nyckeln och värdet finns. För att säkerställa att de gör det ställer du in den här egenskapen på Presentera. För att säkerställa att de inte finns anger du egenskapen till Frånvarande. Standardvärdet är Present.
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

Exempel 1: Kontrollera angivet värde och data under den angivna registernyckeln

Det här exemplet säkerställer att registervärdet "TestValue" under en nyckel med namnet "ExampleKey1" finns i HKEY\_LOCAL\_MACHINE registreringsdatafilen och har data "TestData".

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"
    }
}

Exempel 2: Kontrollera att den angivna registernyckeln finns

Det här exemplet säkerställer att en nyckel med namnet "ExampleKey2" finns i den HKEY_LOCAL_MACHINE registreringsdatafilen.

Configuration RegistryTest
{
    Import-DscResource -ModuleName 'PSDesiredStateConfiguration'

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

Anteckning

Om du ändrar en registerinställning i HKEY_CURRENT_USER registreringsdatafilen måste konfigurationen köras med användarautentiseringsuppgifter i stället för som system. Du kan använda egenskapen PsDscRunAsCredential för att ange användarautentiseringsuppgifter för konfigurationen. Ett exempel finns i Köra DSC med användarautentiseringsuppgifter.