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 可讓您新增和移除登錄機碼,以及新增、更新和移除登錄機碼值。

規格需求

無。

參數

金鑰屬性

Key

將登錄機碼的路徑指定為字串。 此路徑必須包含登錄區或磁片磁碟機,例如 HKEY_LOCAL_MACHINEHKLM:

Type: System.String
Behavior: Key

ValueName

將登錄值的名稱指定為字串。 若要新增或移除登錄機碼,請將此屬性指定為空字串,而不需指定 ValueTypeValueData 屬性。 若要更新或移除登錄機碼的預設值,請使用 ValueTypeValueData 屬性,將此屬性指定為空字串。

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

指定指定的登錄機碼資料是否以十六進位格式提供。 只有在 ValueTypeDWordQWord 時,才指定這個屬性。 如果 ValueType 不是 DWordQword ,則資源會忽略這個屬性。 預設值是 $false

Type: System.Boolean
Default Value: false

ValueData

將登錄機碼值指定為字串,如果 ValueTypeMultiString ,則為字串陣列。 如果 ValueType 不是 MultiString ,而且此屬性的值是多個字串,則資源會擲回不正確引數例外狀況。

Type: System.String[]
Default Value: None

ValueType

指定指定登錄機碼值資料的型別。

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

範例