Registro
Sinopsis
Administrar una clave o un valor del Registro.
Sintaxis
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 }]
}
Descripción
El Registry
recurso permite agregar y quitar claves del Registro y agregar, actualizar y quitar valores de clave del Registro.
Requisitos
Ninguno.
Parámetros
Propiedades de la clave
Key
Especifique la ruta de acceso a la clave del Registro como una cadena. Esta ruta de acceso debe incluir el subárbol del Registro o la unidad, como HKEY_LOCAL_MACHINE
o HKLM:
.
Type: System.String
Behavior: Key
ValueName
Especifique el nombre del valor del Registro como una cadena. Para agregar o quitar una clave del Registro, especifique esta propiedad como una cadena vacía sin especificar la propiedad ValueType o ValueData . Para actualizar o quitar el valor predeterminado de una clave del Registro, especifique esta propiedad como una cadena vacía con la propiedad ValueType o ValueData .
Type: System.String
Propiedades opcionales
Ensure
Especifique si debe existir la clave o el valor del Registro. Para agregar o actualizar una clave o un valor del Registro, establezca esta propiedad en Present
. Para quitar una clave o un valor del Registro, establezca esta propiedad en Absent
.
Type: System.String
Accepted Values:
- Absent
- Present
Default Value: Present
Force
Especifique si se va a sobrescribir el valor de la clave del Registro si ya tiene un valor o para eliminar una clave del Registro que tiene subclaves. El valor predeterminado es $false
.
Type: System.Boolean
Default Value: false
Hex
Especifique si los datos de clave del Registro especificados se proporcionan en un formato hexadecimal. Especifique esta propiedad solo cuando ValueType sea DWord
o QWord
. Si ValueType no DWord
es o Qword
, el recurso omite esta propiedad. El valor predeterminado es $false
.
Type: System.Boolean
Default Value: false
ValueData
Especifique el valor de clave del Registro como una cadena o, si ValueType es MultiString
, una matriz de cadenas. Si ValueType no MultiString
es y el valor de esta propiedad es cadenas mulitple, el recurso produce una excepción de argumento no válida.
Type: System.String[]
Default Value: None
ValueType
Especifique el tipo para los datos de la clave del Registro especificados.
Type: System.String
Accepted Values:
- Binary
- DWord
- ExpandString
- MultiString
- QWord
- String
Default Value: String