Sumber Daya Registri DSC

Berlaku Untuk: Windows PowerShell 4.0, Windows PowerShell 5.x

Sumber daya Registri di Windows PowerShell Desired State Configuration (DSC) menyediakan mekanisme untuk mengelola kunci dan nilai registri pada simpul target.

Catatan

Dokumentasi sumber daya DSC ini mencakup versi yang disertakan dengan PowerShell sebelum versi 7.2. Modul PSDscResources berisi Sumber Daya DSC baru dan yang diperbarui yang secara resmi didukung oleh Microsoft. Modul PSDscResources tersedia dari Galeri PowerShell.

Untuk informasi selengkapnya dan dokumentasi yang diperbarui, lihat dokumentasi referensi PSDscResources.

Sintaks

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

Properti

Properti	Deskripsi
Kunci	Menunjukkan jalur kunci registri yang ingin Anda pastikan statusnya. Jalur ini harus mencakup sarang.
ValueName	Menunjukkan nama nilai registri. Untuk menambahkan atau menghapus kunci registri, tentukan properti ini sebagai string kosong tanpa menentukan ValueType atau ValueData. Untuk mengubah atau menghapus nilai default kunci registri, tentukan properti ini sebagai string kosong sekaligus menentukan ValueType atau ValueData.
Force	Jika kunci registri yang ditentukan ada, Paksa menimpanya dengan nilai baru. Jika menghapus kunci registri dengan subkuntang, ini harus $true.
Hex	Menunjukkan apakah data akan diekspresikan dalam format heksadesimal. Jika ditentukan, data nilai DWORD/QWORD disajikan dalam format heksadesimal. Tidak valid untuk jenis lain. Nilai defaultnya adalah $false.
ValueData	Data untuk nilai registri.
ValueType	Menunjukkan jenis nilai. Jenis yang didukung adalah: String (REG_SZ), Biner (REG_BINARY), Dword (REG_DWORD 32-bit), Qword (REG_QWORD 64-bit), MultiString (REG_MULTI_SZ), ExpandString (REG_EXPAND_SZ).

Properti umum

Properti	Deskripsi
DependsOn	Menunjukkan bahwa konfigurasi sumber daya lain harus berjalan sebelum sumber daya ini dikonfigurasi. Misalnya, jika ID blok skrip konfigurasi sumber daya yang ingin Anda jalankan terlebih dahulu adalah ResourceName dan jenisnya adalah ResourceType, sintaks untuk menggunakan properti ini adalah DependsOn = "[ResourceType]ResourceName".
Pastikan	Menunjukkan apakah kunci dan nilai ada. Untuk memastikan bahwa mereka melakukannya, atur properti ini ke Sajikan. Untuk memastikan bahwa properti tersebut tidak ada, atur properti ke Absent. Nilai defaultnya adalah Ada.
PsDscRunAsCredential	Mengatur kredensial untuk menjalankan seluruh sumber daya sebagai.

Catatan

Properti umum PsDscRunAsCredential ditambahkan dalam WMF 5.0 untuk memungkinkan menjalankan sumber daya DSC apa pun dalam konteks info masuk lainnya. Untuk informasi selengkapnya, lihat Menggunakan Kredensial dengan Sumber Daya DSC.

Contoh

Contoh 1: Pastikan Nilai dan Data yang ditentukan di bawah kunci registri yang ditentukan

Contoh ini memastikan bahwa nilai registri "TestValue" di bawah kunci bernama "ExampleKey1" ada di HKEY\_LOCAL\_MACHINE hive dan memiliki 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"
    }
}

Contoh 2: Pastikan kunci registri yang ditentukan ada

Contoh ini memastikan bahwa kunci bernama "ExampleKey2" ada di sarang 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   = ""
    }
}

Catatan

Mengubah pengaturan registri di HKEY_CURRENT_USER hive mengharuskan konfigurasi berjalan dengan kredensial pengguna, bukan sebagai sistem. Anda dapat menggunakan properti PsDscRunAsCredential untuk menentukan kredensial pengguna untuk konfigurasi. Misalnya, lihat Menjalankan DSC dengan info masuk pengguna.