DSC-RegisterresourceDSC Registry Resource

Van toepassing op: Windows PowerShell 4.0, Windows PowerShell 5.0Applies To: Windows PowerShell 4.0, Windows PowerShell 5.0

De register resource in Windows PowerShell Desired State Configuration (DSC) biedt een mechanisme voor het beheren van registersleutels en -waarden op een doelknooppunt.The Registry resource in Windows PowerShell Desired State Configuration (DSC) provides a mechanism to manage registry keys and values on a target node.

SyntaxisSyntax

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

EigenschappenProperties

EigenschapProperty BeschrijvingDescription
ToetsKey Geeft het pad van de registersleutel die u wilt om te controleren of een specifieke status.Indicates the path of the registry key for which you want to ensure a specific state. Dit pad moet de component bevatten.This path must include the hive.
WaardenaamValueName Geeft de naam van de registerwaarde.Indicates the name of the registry value. Als u wilt toevoegen of verwijderen van een registersleutel, moet u deze eigenschap opgeven als een lege tekenreeks zonder ValueType of Waardegegevens op te geven.To add or remove a registry key, specify this property as an empty string without specifying ValueType or ValueData. Als u wilt wijzigen of verwijderen van de standaardwaarde van een registersleutel, moet u deze eigenschap opgeven als een lege tekenreeks tijdens het instellen van ook ValueType of Waardegegevens.To modify or remove the default value of a registry key, specify this property as an empty string while also specifying ValueType or ValueData.
Zorg ervoor datEnsure Geeft aan of de sleutel en waarde bestaan.Indicates if the key and value exist. Om ervoor te zorgen dat ze doen, stelt u deze eigenschap in 'Aanwezig'.To ensure that they do, set this property to "Present". Om ervoor te zorgen dat deze niet bestaan, de eigenschap instellen op 'Ontbreekt'.To ensure that they do not exist, set the property to "Absent". De standaardwaarde is 'Aanwezig'.The default value is "Present".
ForceForce Als de opgegeven registersleutel aanwezig is, Force overschreven door de nieuwe waarde.If the specified registry key is present, Force overwrites it with the new value. Als een registersleutel met subsleutels verwijdert, moet dit $trueIf deleting a registry key with subkeys, this needs to be $true
HexadecimaalHex Hiermee wordt aangegeven als gegevens zullen worden uitgedrukt in hexadecimale notatie.Indicates if data will be expressed in hexadecimal format. Als u opgeeft, worden de gegevens van de DWORD-/ QWORD-waarde wordt weergegeven in hexadecimale notatie.If specified, the DWORD/QWORD value data is presented in hexadecimal format. Niet geldig voor andere typen.Not valid for other types. De standaardwaarde is $false.The default value is $false.
DependsOnDependsOn Geeft aan dat de configuratie van een andere resource uitvoeren moet voordat deze resource is geconfigureerd.Indicates that the configuration of another resource must run before this resource is configured. Bijvoorbeeld, als de ID van de resourceconfiguratie scriptblok die u wilt uitvoeren eerst is ResourceName en het type ResourceType, de syntaxis voor het gebruik van deze eigenschap is DependsOn = "[ResourceType]ResourceName".For example, if the ID of the resource configuration script block that you want to run first is ResourceName and its type is ResourceType, the syntax for using this property is DependsOn = "[ResourceType]ResourceName".
WaardegegevensValueData De gegevens voor de waarde van het register.The data for the registry value.
ValueTypeValueType Geeft het type van de waarde.Indicates the type of the value. De ondersteunde typen zijn: tekenreeks (REG_SZ), binair (REG-BINARY), DWORD-32-bits (REG_DWORD), Qword 64-bits (REG_QWORD), met meerdere tekenreeksen (REG_MULTI_SZ), uitbreidbare tekenreeks (REG_EXPAND_SZ)The supported types are: String (REG_SZ), Binary (REG-BINARY), Dword 32-bit (REG_DWORD), Qword 64-bit (REG_QWORD), Multi-string (REG_MULTI_SZ), Expandable string (REG_EXPAND_SZ)

VoorbeeldExample

In dit voorbeeld zorgt ervoor dat een sleutel met de naam "ExampleKey" aanwezig zijn in de HKEY_lokale_MACHINE hive.This example ensures that a key named "ExampleKey" is present in the HKEY_LOCAL_MACHINE hive.

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

Notitie

Wijzigen van een instelling in het register in de HKEY\CURRENT\USER hive vereist dat de configuratie wordt uitgevoerd met de referenties van gebruiker, in plaats van als het systeem.Changing a registry setting in the HKEY\CURRENT\USER hive requires that the configuration runs with user credentials, rather than as the system. U kunt de PsDscRunAsCredential eigenschap om op te geven voor de configuratie van de gebruikersreferenties.You can use the PsDscRunAsCredential property to specify user credentials for the configuration. Zie voor een voorbeeld DSC uitvoeren met gebruikersreferenties.For an example, see Running DSC with user credentials.