環境変数を削除する

説明

この例では、リソースを Environment 使用して、パス以外の環境変数が存在しないことを確認する方法を示します。

[確認] を [名前] にTestEnvironmentVariableAbsent設定し、[パス] を設定すると$false、リソースは、存在する場合に呼び出されたTestEnvironmentVariable環境変数を削除します。

Target を両方Processの配列に設定すると、リソースはプロセスターゲットとMachineマシンターゲットの両方から環境変数を削除します。

Invoke-DscResource

このスクリプトは、コマンドレットでInvoke-DscResourceリソースをEnvironment使用して、プロセスとマシンのターゲットから確実にTestEnvironmentVariable削除される方法を示しています。

<#
.SYNOPSIS
.DESCRIPTION
    Removes the environment variable `TestEnvironmentVariable` from both the
    machine and the process.
#>

[CmdletBinding()]
param()

begin {
    $SharedParameters = @{
        Name       = 'Environment'
        ModuleName = 'PSDscResource'
        Properties = @{
            Name   = 'TestEnvironmentVariable'
            Ensure = 'Absent'
            Path   = $false
            Target = @(
                'Process'
                'Machine'
            )
        }
    }

    $NonGetProperties = @(
        'Path'
        '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
    }
}

構成を使用する

このスニペットは、プロセスとマシンのターゲットから確実に削除されるようにTestEnvironmentVariableリソース ブロックを定義ConfigurationEnvironmentする方法を示しています。

<#
.SYNOPSIS
.DESCRIPTION
    Removes the environment variable `TestEnvironmentVariable` from both the
    machine and the process.
#>

configuration Sample_Environment_Remove {
    Import-DscResource -ModuleName 'PSDscResources'

    Node localhost {
        Environment ExampleEnvironment {
            Name   = 'TestEnvironmentVariable'
            Ensure = 'Absent'
            Path   = $false
            Target = @(
                'Process'
                'Machine'
            )
        }
    }
}