Реестр

Статья
05/05/2023

Краткий обзор

Управление разделом или значением реестра.

Синтаксис

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_MACHINE.HKLM:

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

Укажите, предоставляются ли указанные данные раздела реестра в шестнадцатеричном формате. Укажите это свойство только в том случае, если значение ValueType или DWordQWord. Если значение ValueType не 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

Поделиться через