パス環境変数を作成または更新する

説明

この例では、リソースを使用して、特定の Environment 値を持つパス環境変数が存在することを確認する方法を示します。

[確認] を [名前] にTestEnvironmentVariablePresent設定し、[値] を設定するとTestValue、リソースは、存在しない場合は値TestValueと共に呼び出されたTestEnvironmentVariable環境変数を追加します。

Path が存在し$true、含TestValueまれていない場合TestEnvironmentVariableは、リソースが現在のTestValue値に追加されます。

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

Invoke-DscResource

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

[CmdletBinding()]
param()

begin {
    $SharedParameters = @{
        Name       = 'Environment'
        ModuleName = 'PSDscResource'
        Properties = @{
            Name   = 'TestPathEnvironmentVariable'
            Value  = 'TestValue'
            Ensure = 'Present'
            Path   = $true
            Target = @(
                'Process'
                'Machine'
            )
        }
    }

    $NonGetProperties = @(
        'Value'
        '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リソース ブロックを定義Environmentし、含めるTestValueマシン ターゲットを定義Configurationする方法を示しています。

Configuration CreatePathVariable  {
    Import-DscResource -ModuleName 'PSDscResources'

    Node localhost {
        Environment ExampleEnvironment {
            Name   = 'TestPathEnvironmentVariable'
            Value  = 'TestValue'
            Ensure = 'Present'
            Path   = $true
            Target = @(
                'Process'
                'Machine'
            )
        }
    }
}