Share via

環境

  • [アーティクル]

構文

マシンまたはプロセスの環境変数を管理します。

構文

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

説明

リソース Environment を使用すると、環境変数とターゲット内の環境変数を Machine 作成、更新、および Process 削除できます。 パス型の環境変数を管理し、環境変数に特定の値を含めたり、環境変数から削除したりできます。

要件

[なし] :

キーのプロパティ

名前

環境変数の名前を指定します。

Type: System.String

省略可能なプロパティ

Ensure

環境変数を存在させるかどうかを指定します。 環境変数が存在する場合は、このプロパティ Absent を指定して削除します。 環境変数が存在しない場合は環境変数を作成し、設定されている場合は Value プロパティを適用するには、このPresentプロパティを指定します。 既定値は Present です。

Type: System.String
Accepted Values:
  - Absent
  - Present
Default Value: Present

パス

環境変数をパス変数として扱うかどうかを指定します。 これにより、環境変数の Ensure 動作が変更されます。

  • Path が $true、Ensure is 、Value がPresent環境変数の現在の値に含まれていない場合、リソースは環境変数の現在の値に値を追加します。
  • Path が $true、Ensure が 、Value がAbsent環境変数の現在の値に含まれている場合、リソースは環境変数の現在の値から Value を削除します。
  • Path が Ensure の$false場合、リソースはPresent環境変数を Value に設定します。
  • Path が Ensure の$false場合、リソースはAbsent環境変数を削除します。

既定値は $false です。

Type: System.Boolean
Default Value: false

移行先

環境変数を構成するターゲットを 1 つ以上指定します。 有効な値は、次のとおりです。

  • Process
  • Machine

既定では、環境変数はターゲットとMachineターゲットのProcess両方で構成されます。

Type: System.String[]
Accepted Values:
  - Process
  - Machine
Default Value: [Process, Machine]

値

環境変数の値を文字列として指定します。 Value が空の文字列 ('') であるかどうかを指定すると、環境変数の Ensure 動作が変更されます。

  • Value が空の文字列で、Ensure is Present、環境変数が存在する場合、リソースは環境変数を更新しません。
  • Value が空の文字列で、Ensure is Present、環境変数が存在しない場合、リソースは無効な操作例外をスローします。
  • Value が空の文字列で、Ensure is Absent、環境変数が存在する場合、リソースは環境変数を削除します。

既定値は空の文字列です。

Type: System.String
Default Value: ''

例