DSC-Resource voor registerDSC Registry Resource

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

De register in Windows PowerShell Desired State Configuration (DSC)-bron biedt een mechanisme voor het beheren van registersleutels en -waarden in 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 waarvoor 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 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 ook specificeren 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 Hiermee wordt aangegeven als de sleutel en waarde bestaan.Indicates if the key and value exist. Om ervoor te zorgen dat ze doen, stel deze eigenschap in op 'Aanwezig'.To ensure that they do, set this property to "Present". Om ervoor te zorgen dat ze niet bestaat, de eigenschap instellen op 'Afwezig'.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 met 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
HexHex Hiermee wordt aangegeven als gegevens zullen worden uitgedrukt in hexadecimale notatie.Indicates if data will be expressed in hexadecimal format. Als u opgeeft, wordt de waardegegevens DWORD/QWORD is opgenomen 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 Hiermee wordt aangegeven dat de configuratie van een andere resource uitvoeren moet voordat deze bron 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 registerwaarde.The data for the registry value.
ValueTypeValueType Geeft het type van de waarde.Indicates the type of the value. De ondersteunde typen zijn:The supported types are:
  • Tekenreeks (REG_SZ)String (REG_SZ)
  • Binair (REG-BINARY)Binary (REG-BINARY)
  • DWORD 32-bits (REG_DWORD)Dword 32-bit (REG_DWORD)
  • Qword 64-bits (REG_QWORD)Qword 64-bit (REG_QWORD)
  • Met meerdere tekenreeksen (REG_MULTI_SZ)Multi-string (REG_MULTI_SZ)
  • Uit te breiden tekenreeks (REG_EXPAND_SZ)Expandable string (REG_EXPAND_SZ)

VoorbeeldExample

In dit voorbeeld zorgt ervoor dat een sleutel met de naam 'ExampleKey' aanwezig is 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"
    }
}

Opmerking: aanbrengen in een registerinstelling in de HKEY_huidige_gebruiker hive vereist dat de configuratie wordt uitgevoerd met gebruikersgegevens, in plaats van als het systeem.Note: 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 gebruikersreferenties voor de configuratie opgeven.You can use the PsDscRunAsCredential property to specify user credentials for the configuration. Zie voor een voorbeeld DSC uitgevoerd met gebruikersgegevensFor an example, see Running DSC with user credentials