Odebrání proměnné prostředí

Description

Tento příklad ukazuje, jak můžete prostředek použít Environment k zajištění, že proměnná prostředí bez cesty neexistuje.

Pokud je nastavená možnost ,Název nastavena na TestEnvironmentVariableAbsenta Cesta nastavena na $false, prostředek odebere proměnnou prostředí volanou TestEnvironmentVariable v případě, že existuje.

Když je cíl nastavený na pole s oběma Process a Machine, prostředek odebere proměnnou prostředí z procesu i cílů počítače.

S Invoke-DscResource

Tento skript ukazuje, jak můžete použít Environment prostředek s rutinou Invoke-DscResource , abyste zajistili, TestEnvironmentVariable že se odebere z procesu a cílů počítačů.

<#
.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
    }
}

S konfigurací

Tento fragment kódu ukazuje, jak můžete definovat Configuration blok Environment prostředků, abyste zajistili TestEnvironmentVariable , že se z procesu a cílů počítačů odebere.

<#
.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'
            )
        }
    }
}