Registre

  • Article

Synopsis

Gérez une clé ou une valeur de Registre.

Syntaxe

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 }]
}

Description

La Registry ressource vous permet d’ajouter et de supprimer des clés de Registre et d’ajouter, mettre à jour et supprimer des valeurs de clé de Registre.

Configuration requise

Aucun.

Paramètres

Propriétés de la clé

Clé

Spécifiez le chemin d’accès à la clé de Registre en tant que chaîne. Ce chemin d’accès doit inclure la ruche ou le lecteur du Registre, tel que HKEY_LOCAL_MACHINE ou HKLM:.

Type: System.String
Behavior: Key

ValueName

Spécifiez le nom de la valeur de Registre en tant que chaîne. Pour ajouter ou supprimer une clé de Registre, spécifiez cette propriété en tant que chaîne vide sans spécifier la propriété ValueType ou ValueData. Pour mettre à jour ou supprimer la valeur par défaut d’une clé de Registre, spécifiez cette propriété en tant que chaîne vide avec la propriété ValueType ou ValueData .

Type: System.String

Propriétés facultatives

Ensure

Spécifiez si la clé ou la valeur du Registre doit exister. Pour ajouter ou mettre à jour une clé ou une valeur de Registre, définissez cette propriété sur Present. Pour supprimer une clé ou une valeur de Registre, définissez cette propriété sur Absent.

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

Force

Spécifiez s’il faut remplacer la valeur de clé de Registre si elle a déjà une valeur ou pour supprimer une clé de Registre qui a des sous-clés. La valeur par défaut est $false.

Type: System.Boolean
Default Value: false

Hex

Spécifiez si les données de clé de Registre spécifiées sont fournies dans un format hexadécimal. Spécifiez cette propriété uniquement lorsque ValueType est DWord ou QWord. Si ValueType n’est pas DWord ou Qword, la ressource ignore cette propriété. La valeur par défaut est $false.

Type: System.Boolean
Default Value: false

ValueData

Spécifiez la valeur de clé de Registre en tant que chaîne ou, si ValueType est MultiString, tableau de chaînes. Si ValueType n’est pas MultiString et que la valeur de cette propriété est des chaînes de mulitple, la ressource lève une exception d’argument non valide.

Type: System.String[]
Default Value: None

ValueType

Spécifiez le type des données de clé de Registre spécifiées.

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

Exemples