Share via


レジストリ

構文

レジストリ キーまたは値を管理します。

構文

Registry [String] #ResourceName
{
    Key = [string]
    ValueName = [string]
    [DependsOn = [string[]]]
    [Ensure = [string]{ Absent | Present }]
    [Force = [bool]]
    [Hex = [bool]]
    [PsDscRunAsCredential = [PSCredential]]
    [ValueData = [string[]]]
    [ValueType = [string]{ Binary | DWord | ExpandString | MultiString | QWord | String }]
}

説明

この Registry リソースを使用すると、レジストリ キーを追加および削除したり、レジストリ キーの値を追加、更新、削除したりできます。

要件

[なし] :

パラメーター

キーのプロパティ

キー

レジストリ キーへのパスを文字列として指定します。 このパスには、レジストリ ハイブやドライブ (HKEY_LOCAL_MACHINEHKLM:または .

Type: System.String
Behavior: Key

ValueName

レジストリ値の名前を文字列として指定します。 レジストリ キーを追加または削除するには、 ValueType プロパティまたは ValueData プロパティを指定せずに、このプロパティを空の文字列として指定します。 レジストリ キーの既定値を更新または削除するには、 ValueType プロパティまたは ValueData プロパティを使用して、このプロパティを空の文字列として指定します。

Type: System.String

省略可能なプロパティ

Ensure

レジストリ キーまたは値が存在するかどうかを指定します。 レジストリ キーまたは値を追加または更新するには、このプロパティを Present. レジストリ キーまたは値を削除するには、このプロパティを に設定します Absent

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

Force

レジストリ キーの値が既に存在する場合は上書きするか、サブキーを持つレジストリ キーを削除するかを指定します。 既定値は $false です。

Type: System.Boolean
Default Value: false

Hex

指定したレジストリ キー データを 16 進数形式で指定するかどうかを指定します。 このプロパティは 、ValueTypeDWord 場合にのみ指定します QWordValueType が指定されていないDWord場合、リソースQwordはこのプロパティを無視します。 既定値は $false です。

Type: System.Boolean
Default Value: false

ValueData

レジストリ キーの値を文字列として指定するか、 ValueType の場合は MultiString文字列の配列を指定します。 ValueType が指定されておらずMultiString、このプロパティの値が複数の文字列である場合、リソースは無効な引数例外をスローします。

Type: System.String[]
Default Value: None

ValueType

指定したレジストリ キー値のデータの型を指定します。

Type: System.String
Accepted Values:
  - Binary
  - DWord
  - ExpandString
  - MultiString
  - QWord
  - String
Default Value: String