Crée une propriété pour un élément et définit sa valeur. Par exemple, vous pouvez utiliser New-ItemProperty pour créer et modifier des données et des valeurs de Registre qui sont les propriétés d'une clé de Registre.
Syntaxe
New-ItemProperty [-LiteralPath] <string[]> [-Name] <string> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PropertyType <string>] [-Value <Object>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>] New-ItemProperty [-Path] <string[]> [-Name] <string> [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PropertyType <string>] [-Value <Object>] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
Description
L'applet de commande New-ItemProperty crée une propriété pour un élément spécifié et définit sa valeur. En général, cette applet de commande permet de créer des valeurs de Registre, car les valeurs de Registre sont les propriétés d'un élément de clé de Registre.
Cette applet de commande n'ajoute pas de propriétés à un objet. Pour ajouter une propriété à une instance d'un objet, utilisez l'applet de commande Add-Member. Pour ajouter une propriété à tous les objets d'un type particulier, modifiez le fichier Types.ps1xml.
Paramètres
-Credential <PSCredential>
Spécifie un compte d'utilisateur qui a l'autorisation d'exécuter cette action. La valeur par défaut est l'utilisateur actuel.
Tapez un nom d'utilisateur, tel que « User01 » ou « Domain01\User01 », ou entrez un objet PSCredential, tel que celui généré par l'applet de commande Get-Credential. Si vous tapez un nom d'utilisateur, vous êtes invité à entrer un mot de passe.
Ce paramètre n'est pas pris en charge par les fournisseurs installés avec Windows PowerShell.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-Exclude <string[]>
Omet les éléments spécifiés. Les caractères génériques sont autorisés.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Filter <string>
Spécifie un filtre dans le format ou le langage du fournisseur. La valeur de ce paramètre qualifie le paramètre Path.
La syntaxe du filtre, notamment l'utilisation de caractères génériques, dépend du fournisseur. Les filtres sont plus efficaces que les autres paramètres, car le fournisseur les applique lors de la récupération des objets, plutôt que de laisser le soin à Windows PowerShell de filtrer les objets une fois qu'ils ont été récupérés.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Force
Permet à l'applet de commande de créer une propriété sur un objet qui, sinon, n'est pas accessible par l'utilisateur. L'implémentation est différente d'un fournisseur à l'autre. Pour plus d'informations, consultez about_Providers.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-Include <string[]>
La valeur de ce paramètre qualifie le paramètre Path. Entrez un élément ou un modèle de chemin d'accès, tel que « *.txt ». Les caractères génériques sont autorisés.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-LiteralPath <string[]>
Spécifie un chemin d'accès à la propriété d'élément. La valeur de -LiteralPath est utilisée exactement telle que vous la tapez. Aucun caractère n'est interprété en tant que caractère générique. Si le chemin d'accès inclut des caractères d'échappement, mettez-le entre des guillemets simples. Les guillemets simples indiquent à Windows PowerShell qu'aucun caractère ne doit être interprété en tant que séquence d'échappement.
|
Obligatoire ? |
true |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-Name <string>
Spécifie le nom de la nouvelle propriété. Si la propriété est une entrée de Registre, ce paramètre spécifie le nom de l'entrée.
|
Obligatoire ? |
true |
|
Position ? |
2 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-Path <string[]>
Spécifie le chemin d'accès de l'élément. Ce paramètre identifie l'élément auquel la nouvelle propriété sera ajoutée.
|
Obligatoire ? |
true |
|
Position ? |
1 |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-PropertyType <string>
Spécifie le type de propriété qui sera ajouté.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-Value <Object>
Spécifie la valeur de la propriété. Si la propriété est une entrée de Registre, ce paramètre spécifie la valeur de l'entrée.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
|
Accepter les caractères génériques ? |
false |
-Confirm
Vous invite à confirmer l'exécution de la commande.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-WhatIf
Décrit le résultat que vous obtiendriez en exécutant la commande, sans réellement l'exécuter.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
-UseTransaction
Inclut la commande dans la transaction active. Ce paramètre est valide uniquement lorsqu'une transaction est en cours. Pour plus d'informations, consultez about_Transactions.
|
Obligatoire ? |
false |
|
Position ? |
named |
|
Valeur par défaut |
|
|
Accepter l'entrée de pipeline ? |
false |
|
Accepter les caractères génériques ? |
false |
<CommonParameters>
Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d'informations, consultez about_Commonparameters.
Entrées et sorties
Le type d'entrée est le type des objets que vous pouvez diriger vers l'applet de commande. Le type de retour est le type des objets que l'applet de commande retourne.
|
Entrées |
None Vous ne pouvez pas diriger d'entrée vers New-ItemProperty. |
|
Sorties |
System.Management.Automation.PSCustomObject New-ItemProperty retourne un objet personnalisé qui contient la nouvelle propriété. |
Remarques
L'applet de commande New-ItemProperty est conçue pour utiliser les données exposées par n'importe quel fournisseur. Pour répertorier les fournisseurs disponibles dans votre session, tapez « Get-PSProvider ». Pour plus d'informations, consultez about_Providers.
Exemple 1
C:\PS>new-itemproperty -path HKLM:\Software\MyCompany -name NoOfEmployees -value 822 C:\PS> get-itemproperty hklm:\software\mycompany PSPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software\mycompany PSParentPath : Microsoft.PowerShell.Core\Registry::HKEY_LOCAL_MACHINE\software PSChildName : mycompany PSDrive : HKLM PSProvider : Microsoft.PowerShell.Core\Registry NoOfLocations : 2 NoOfEmployees : 822 Description ----------- Cette commande ajoute une nouvelle entrée de Registre (NoOfEmployees) à la clé MyCompany de la ruche HKLM:\Software. La première commande utilise le paramètre Path pour spécifier le chemin d'accès de la clé de Registre MyCompany. Elle utilise le paramètre Name pour spécifier le nom de l'entrée et le paramètre Value pour spécifier sa valeur. La deuxième commande utilise l'applet de commande Get-ItemProperty pour afficher la nouvelle entrée de Registre.
Exemple 2
C:\PS>get-item -path HKLM:\Software\MyCompany | new-Itemproperty -name NoOfLocations -value 3 Description ----------- Cette commande ajoute une nouvelle entrée de Registre à une clé de Registre. Pour spécifier la clé, elle utilise un opérateur de pipeline (|) pour envoyer un objet représentant la clé à l'applet de commande New-ItemProperty. La première partie de la commande utilise l'applet de commande Get-Item pour obtenir la clé de Registre MyCompany. L'opérateur de pipeline (|) envoie les résultats de la commande à l'applet de commande New-ItemProperty, qui ajoute la nouvelle entrée de Registre (NoOfLocations) et sa valeur (3) à la clé MyCompany. Cette commande fonctionne car la fonctionnalité de liaison des paramètres de Windows PowerShell associe le chemin d'accès de l'objet RegistryKey retourné par Get-Item au paramètre LiteralPath de New-ItemProperty. Pour plus d'informations, consultez about_Pipelines.
Voir aussi