New-ItemProperty

  • Référence
Module:
Microsoft.PowerShell.Management

Crée une propriété pour un élément et définit sa valeur.

Syntax

New-ItemProperty
   [-Path] <String[]>
   [-Name] <String>
   [-PropertyType <String>]
   [-Value <Object>]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
New-ItemProperty
   -LiteralPath <String[]>
   [-Name] <String>
   [-PropertyType <String>]
   [-Value <Object>]
   [-Force]
   [-Filter <String>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Credential <PSCredential>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

L’applet New-ItemProperty de commande 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 Add-Member de commande.
  • Pour ajouter une propriété à tous les objets d’un type particulier, modifiez le fichier Types.ps1xml.

Exemples

Exemple 1 : Ajouter une entrée de Registre

Cette commande ajoute une nouvelle entrée de Registre, NoOfEmployeesà la MyCompany clé du HKLM:\Software hive.

La première commande utilise le paramètre Path pour spécifier le chemin d’accès de la clé de MyCompany Registre. Il utilise le paramètre Name pour spécifier un nom pour l’entrée et le paramètre Value pour spécifier sa valeur.

La deuxième commande utilise l’applet Get-ItemProperty de commande pour afficher la nouvelle entrée de Registre.

New-ItemProperty -Path "HKLM:\Software\MyCompany" -Name "NoOfEmployees" -Value 822
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

Exemple 2 : Ajouter une entrée de Registre à une clé

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 qui représente la clé à New-ItemProperty.

La première partie de la commande utilise l’applet Get-Item de commande pour obtenir la clé de MyCompany Registre. L’opérateur de pipeline envoie les résultats de la commande à New-ItemProperty, qui ajoute la nouvelle entrée de Registre (NoOfLocations) et sa valeur (3), à la MyCompany clé.

Get-Item -Path "HKLM:\Software\MyCompany" | New-ItemProperty -Name NoOfLocations -Value 3

Cette commande fonctionne, car la fonctionnalité de liaison de paramètres de PowerShell associe le chemin d’accès de l’objet RegistryKey qui Get-Item retourne avec le paramètre LiteralPath de New-ItemProperty. Pour plus d’informations, consultez about_Pipelines.

Exemple 3 : Créer une valeur MultiString dans le Registre à l’aide d’une chaîne ici

Cet exemple crée une MultiString valeur à l’aide d’une chaîne ici.

$newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'HereString' -PropertyType MultiString -Value @"
This is text which contains newlines
It can also contain "quoted" strings
"@
$newValue.multistring

This is text which contains newlines
It can also contain "quoted" strings

Exemple 4 : Créer une valeur MultiString dans le Registre à l’aide d’un tableau

L’exemple montre comment utiliser un tableau de valeurs pour créer la MultiString valeur.

$newValue = New-ItemProperty -Path "HKLM:\SOFTWARE\ContosoCompany\" -Name 'MultiString' -PropertyType MultiString -Value ('a','b','c')
$newValue.multistring[0]

a

Paramètres

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

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 qu’un objet généré par l’applet Get-Credential de commande. Si vous tapez un nom d’utilisateur, vous êtes invité à entrer un mot de passe.

Remarque

Ce paramètre n’est pas pris en charge par les fournisseurs installés avec PowerShell. Pour emprunter l’identité d’un autre utilisateur ou élever vos informations d’identification lors de l’exécution de cette applet de commande, utilisez Invoke-Command.

Type:PSCredential
Position:Named
Default value:Current user
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Exclude

Spécifie, en tant que tableau de chaînes, un élément ou des éléments que cette applet de commande exclut dans l’opération. 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. Le paramètre Exclude est effectif uniquement lorsque la commande inclut le contenu d’un élément, par C:\Windows\*exemple, où le caractère générique carte spécifie le contenu du C:\Windows répertoire.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Filter

Spécifie un filtre pour qualifier le paramètre Path . Le fournisseur FileSystem est le seul fournisseur PowerShell installé qui prend en charge l’utilisation de filtres. Vous trouverez la syntaxe du langage de filtre FileSystem dans about_Wild carte s. Les filtres sont plus efficaces que d’autres paramètres, car le fournisseur les applique lorsque l’applet de commande obtient les objets plutôt que de filtrer les objets après leur récupération.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Force

Force l’applet de commande à créer une propriété sur un objet qui ne peut pas être accessible autrement par l’utilisateur. L'implémentation est différente d'un fournisseur à l'autre. Pour plus d’informations, consultez about_Providers.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Include

Spécifie, sous la forme d’un tableau de chaînes, un élément ou des éléments inclus dans l’opération. 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. Le paramètre Include est effectif uniquement lorsque la commande inclut le contenu d’un élément, par C:\Windows\*exemple, où le caractère générique carte spécifie le contenu du C:\Windows répertoire.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-LiteralPath

Spécifie un chemin d’accès à un ou plusieurs emplacements. La valeur de LiteralPath est utilisée exactement comme elle est typée. Aucun caractère n’est interprété en tant que caractère générique. Si le chemin inclut des caractères d’échappement, placez-le entre guillemets simples ('). Les guillemets simples indiquent à PowerShell de ne pas interpréter de caractères comme séquences d’échappement.

Pour plus d’informations, consultez about_Quoting_Rules.

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

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.

Type:String
Aliases:PSProperty
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

Spécifie le chemin d’accès de l’élément. Les caractères génériques sont autorisés. Ce paramètre identifie l’élément auquel cette applet de commande ajoute la nouvelle propriété.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

-PropertyType

Spécifie le type de propriété ajouté par cette applet de commande. Les valeurs valides pour ce paramètre sont :

  • String: spécifie une chaîne terminée par null. Utilisé pour les valeurs REG_SZ .
  • ExpandString: spécifie une chaîne terminée par null qui contient des références non expirées aux variables d’environnement qui sont développées lorsque la valeur est récupérée. Utilisé pour les valeurs REG_EXPAND_SZ .
  • Binary: spécifie les données binaires sous n’importe quel formulaire. Utilisé pour les valeurs REG_BINARY .
  • DWord: spécifie un nombre binaire 32 bits. Utilisé pour REG_DWORD valeurs.
  • MultiString: spécifie un tableau de chaînes terminées par null terminées par deux caractères Null. Utilisé pour les valeurs REG_MULTI_SZ .
  • Qword: spécifie un nombre binaire 64 bits. Utilisé pour les valeurs REG_QWORD .
  • Unknown: indique un type de données de Registre non pris en charge, tel que des valeurs REG_RESOURCE_LIST .
Type:String
Aliases:Type
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Value

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.

Type:Object
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entrées

None

Vous ne pouvez pas diriger les objets vers cette applet de commande.

Sorties

PSCustomObject

Cette applet de commande retourne un objet personnalisé représentant la nouvelle propriété.

Notes

New-ItemProperty est conçu pour fonctionner avec 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.