Risorsa Registry DSC

Si applica a: Windows PowerShell 4.0, Windows PowerShell 5.x

La risorsa Registry in Windows PowerShell DSC (Desired State Configuration) fornisce un meccanismo per gestire i valori e le chiavi del Registro di sistema in un nodo di destinazione.

Nota

Questa documentazione di questa risorsa DSC illustra la versione inclusa in PowerShell prima della versione 7.2. Il modulo PSDscResources contiene risorse DSC nuove e aggiornate supportate ufficialmente da Microsoft. Il modulo PSDscResources è disponibile da PowerShell Gallery.

Per altre informazioni e documentazione aggiornata, vedere la documentazione di riferimento psDscResources.

Sintassi

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

Proprietà

Proprietà	Descrizione
Chiave	Indica il percorso della chiave del Registro di sistema per cui si vuole specificare un determinato stato. Questo percorso deve includere l'hive.
ValueName	Indica il nome del valore del Registro di sistema. Per aggiungere o rimuovere una chiave del Registro di sistema, specificare questa proprietà come stringa vuota, senza specificare ValueType o ValueData. Per modificare o rimuovere il valore predefinito di una chiave del Registro di sistema, specificare questa proprietà come stringa vuota e specificare anche ValueType o ValueData.
Force	Se la chiave del Registro di sistema è presente, Force la sovrascrive con il nuovo valore. Se si elimina una chiave del Registro di sistema con sottochiavi il valore deve essere $true.
Hex	Indica se i dati verranno espressi in formato esadecimale. Se questa proprietà è specificata, i dati con valori DWORD o QWORD vengono presentati in formato esadecimale. La proprietà non è valida per altri tipi. Il valore predefinito è $false.
ValueData	Dati per il valore del Registro di sistema.
ValueType	Indica il tipo di valore. I tipi supportati sono : String (REG_SZ), Binary (REG_BINARY), Dword (REG_DWORD a 32 bit), Qword (REG_QWORD a 64 bit), MultiString (REG_MULTI_SZ), ExpandString (REG_EXPAND_SZ).

Proprietà comuni

Proprietà	Descrizione
DependsOn	Indica che prima di configurare la risorsa è necessario eseguire la configurazione di un'altra risorsa. Ad esempio, se il valore di ID del blocco script di configurazione della risorsa che si vuole eseguire per primo è ResourceName e il tipo è ResourceType, la sintassi per usare questa proprietà è DependsOn = "[ResourceType]ResourceName".
Ensure	Indica se la chiave e il valore esistono. Impostare questa proprietà su Present per assicurarsi che esistano. Impostare questa proprietà su Absent per assicurarsi che non esistano. Il valore predefinito è Present.
PsDscRunAsCredential	Imposta le credenziali per l'esecuzione dell'intera risorsa.

Nota

La proprietà comune PsDscRunAsCredential è stata aggiunta in WMF 5.0 per consentire l'esecuzione di qualsiasi risorsa DSC nel contesto di altre credenziali. Per altre informazioni, vedere Usare credenziali con risorse DSC.

Esempi

Esempio 1: Verificare il valore e i dati specificati per la chiave del Registro di sistema specificata

Questo esempio verifica se il valore del Registro di sistema "TestValue" relativo a una chiave denominata "ExampleKey1" è presente nell'hive HKEY\_LOCAL\_MACHINE e ha i dati "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"
    }
}

Esempio 2: Verificare che esista la chiave del Registro di sistema specificata

Questo esempio garantisce che una chiave denominata "ExampleKey2" sia presente nell'hive HKEY_LOCAL_MACHINE .

Configuration RegistryTest
{
    Import-DscResource -ModuleName 'PSDesiredStateConfiguration'

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

Nota

La modifica di un'impostazione del Registro di sistema nell'hive HKEY_CURRENT_USER richiede l'esecuzione della configurazione con le credenziali dell'utente anziché come il sistema. È possibile usare la proprietà PsDscRunAsCredential per specificare le credenziali utente per la configurazione. Per un esempio, vedere Esecuzione di DSC con le credenziali dell'utente.