DSC 環境リソース

適用先: Windows PowerShell 4.0、Windows PowerShell 5.x

Windows PowerShell Desired State Configuration (DSC) の Environment リソースは、システム環境変数を管理するためのメカニズムを備えています。

注意

この DSC リソースのこのドキュメントでは、バージョン 7.2 より前の PowerShell に含まれているバージョンについて説明します。 PSDscResources モジュールには、Microsoft によって正式にサポートされている新規および更新された DSC リソースが含まれています。 PSDscResources モジュールは、PowerShell ギャラリーから入手できます。

詳細と更新されたドキュメントについては、 PSDscResources リファレンス ドキュメントを参照してください。

構文

Environment [string] #ResourceName
{
    Name = [string]
    [ Path = [bool] ]
    [ Value = [string] ]
    [ DependsOn = [string[]] ]
    [ Ensure = [string] { Absent | Present }  ]
    [ PsDscRunAsCredential = [PSCredential] ]
}

Properties

プロパティ	説明
名前	特定の状態を保証する環境変数の名前を示します。
Path	構成されている環境変数を定義します。 変数が Path 変数である場合は、このプロパティを $true に設定します。それ以外の場合は、$false に設定します。 既定では、 $falseです。 構成されている変数が Path 変数である場合は、Value プロパティによって提供される値が既存の値に追加されます。
値	環境変数に割り当てる値。

共通プロパティ

プロパティ	説明
DependsOn	このリソースを構成する前に、他のリソースの構成を実行する必要があることを示します。 たとえば、最初に実行するリソース構成スクリプト ブロックの ID が ResourceName で、そのタイプが ResourceType である場合、このプロパティを使用する構文は DependsOn = "[ResourceType]ResourceName" になります。
Ensure	変数が存在するかどうかを示します。 環境変数が存在しない場合に作成する場合、または環境変数が既に存在する場合にその値が Value プロパティによって提供される値と一致することを保証するには、このプロパティを Present に設定します。 環境変数が存在する場合に削除するには、Absent に設定します。
PsDscRunAsCredential	リソース全体を実行するための資格情報を設定します。

注意

PsDscRunAsCredential という共通プロパティは、他の資格情報という文脈の中であらゆる DSC リソースを実行するために WMF 5.0 で追加されました。 詳細については、「DSC リソースに対して資格情報を使用する」を参照してください。

例

次の例では、TestEnvironmentVariable が存在し、その値が TestValue であることを保証します。 この環境変数が存在しない場合は、作成されます。

Environment EnvironmentExample
{
    Ensure = "Present"  # You can also set Ensure to "Absent"
    Name = "TestEnvironmentVariable"
    Value = "TestValue"
}