Zasób rejestru DSC

Dotyczy: Windows PowerShell 4.0, Windows PowerShell 5.x

Zasób rejestru w Windows PowerShell Desired State Configuration (DSC) udostępnia mechanizm zarządzania kluczami i wartościami rejestru w węźle docelowym.

Uwaga

Ta dokumentacja tego zasobu DSC obejmuje wersję dołączoną do programu PowerShell w wersji 7.2. Moduł PSDscResources zawiera nowe i zaktualizowane zasoby DSC, które są oficjalnie obsługiwane przez firmę Microsoft. Moduł PSDscResources jest dostępny w Galeria programu PowerShell.

Aby uzyskać więcej informacji i zaktualizować dokumentację, zobacz dokumentację referencyjną usługi PSDscResources.

Składnia

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

Właściwości

Właściwość	Opis
Klucz	Wskazuje ścieżkę klucza rejestru, dla którego chcesz zapewnić określony stan. Ta ścieżka musi zawierać gałąź.
Valuename	Wskazuje nazwę wartości rejestru. Aby dodać lub usunąć klucz rejestru, określ tę właściwość jako pusty ciąg bez określania wartości ValueType lub ValueData. Aby zmodyfikować lub usunąć wartość domyślną klucza rejestru, określ tę właściwość jako pusty ciąg, określając również wartość ValueType lub ValueData.
Force	Jeśli określony klucz rejestru jest obecny, wymuś zastąpienie go nową wartością. Jeśli usuniesz klucz rejestru z podkluczami, musi to być $true.
Hex	Wskazuje, czy dane zostaną wyrażone w formacie szesnastkowym. Jeśli zostanie określony, dane wartości DWORD/QWORD są prezentowane w formacie szesnastkowym. Nieprawidłowe dla innych typów. Wartość domyślna to $false.
ValueData	Dane dla wartości rejestru.
ValueType	Wskazuje typ wartości. Obsługiwane typy to: String (REG_SZ), Binary (REG_BINARY), Dword (32-bitowy REG_DWORD), Qword (64-bitowy REG_QWORD), MultiString (REG_MULTI_SZ), ExpandString (REG_EXPAND_SZ).

Wspólne właściwości

Właściwość	Opis
Dependson	Wskazuje, że konfiguracja innego zasobu musi zostać uruchomiona przed skonfigurowaniem tego zasobu. Jeśli na przykład identyfikator bloku skryptu konfiguracji zasobu, który chcesz uruchomić jako pierwszy, to ResourceName, a jego typ to ResourceType, składnia użycia tej właściwości to DependsOn = "[ResourceType]ResourceName".
Zapewnić	Wskazuje, czy klucz i wartość istnieją. Aby upewnić się, że to zrobią, ustaw tę właściwość na Wartość Obecna. Aby upewnić się, że nie istnieją, ustaw właściwość na Nieobecny. Wartość domyślna to Obecny.
PsDscRunAsCredential	Ustawia poświadczenie na potrzeby uruchamiania całego zasobu jako.

Uwaga

Właściwość pospolita PsDscRunAsCredential została dodana w programie WMF 5.0, aby umożliwić uruchamianie dowolnego zasobu DSC w kontekście innych poświadczeń. Aby uzyskać więcej informacji, zobacz Use Credentials with DSC Resources (Używanie poświadczeń z zasobami DSC).

Przykłady

Przykład 1. Upewnij się, że określono wartość i dane w określonym kluczu rejestru

W tym przykładzie wartość rejestru "TestValue" pod kluczem o nazwie "ExampleKey1" znajduje się w HKEY\_LOCAL\_MACHINE gałęzi i ma dane "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"
    }
}

Przykład 2. Upewnij się, że określony klucz rejestru istnieje

Ten przykład gwarantuje, że klucz o nazwie "ExampleKey2" znajduje się w gałęzi 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   = ""
    }
}

Uwaga

Zmiana ustawienia rejestru w HKEY_CURRENT_USER gałęzi wymaga uruchomienia konfiguracji przy użyciu poświadczeń użytkownika, a nie jako systemu. Możesz użyć właściwości PsDscRunAsCredential , aby określić poświadczenia użytkownika dla konfiguracji. Aby zapoznać się z przykładem, zobacz Running DSC with user credentials (Uruchamianie kontrolera DSC z poświadczeniami użytkownika).