レジストリ キーの値を削除する

説明

この例では、リソースを Registry 使用してレジストリ キー値が存在しないことを確認する方法を示します。

[確認] を [ValueName] にAbsent設定し、[キー] をMyValue設定するとHKLM:\SYSTEM\CurrentControlSet\Control\Session Manager\Environment、リソースはキーのMyValue下にあるレジストリ キーの値をEnvironment削除します (存在する場合)。

Invoke-DscResource

このスクリプトは、コマンドレットでInvoke-DscResourceリソースをRegistry使用して、レジストリ キーにEnvironment値が呼び出MyValueされないようにする方法を示しています。

[CmdletBinding()]
param()

begin {
    $SharedParameters = @{
        Name       = 'Registry'
        ModuleName = 'PSDscResource'
        Properties = @{
            Key       = 'HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager\Environment'
            Ensure    = 'Absent'
            ValueName = 'MyValue'
        }
    }

    $NonGetProperties = @(
        'Ensure'
    )
}

process {
    $TestResult = Invoke-DscResource -Method Test @SharedParameters

    if ($TestResult.InDesiredState) {
        $QueryParameters = $SharedParameters.Clone()

        foreach ($Property in $NonGetProperties) {
            $QueryParameters.Properties.Remove($Property)
        }

        Invoke-DscResource -Method Get @QueryParameters
    } else {
        Invoke-DscResource -Method Set @SharedParameters
    }
}

構成を使用する

このスニペットは、レジストリ キーに値が呼び出MyValueされないように、Environmentリソース ブロックを使用Registryして定義Configurationする方法を示しています。

Configuration RemoveValue {
    Import-DscResource -ModuleName 'PSDscResources'

    Node localhost {
        Registry ExampleRegistry {
            Key       = 'HKLM:\SYSTEM\CurrentControlSet\Control\Session Manager\Environment'
            Ensure    = 'Absent'
            ValueName = 'MyValue'
        }
    }
}