Set-Item
Remplace la valeur d'un élément par la valeur spécifiée dans la commande.
Syntaxe
Set-Item [-LiteralPath] <string[]> [[-Value] <Object>] [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
Set-Item [-Path] <string[]> [[-Value] <Object>] [-Credential <PSCredential>] [-Exclude <string[]>] [-Filter <string>] [-Force] [-Include <string[]>] [-PassThru] [-Confirm] [-WhatIf] [-UseTransaction] [<CommonParameters>]
Description
L'applet de commande Set-Item remplace la valeur d'un élément, telle qu'une variable ou une clé de Registre, par la valeur spécifiée dans la commande.
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. 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 |
-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 définir des éléments qui ne peuvent pas être modifiés autrement, tels que des alias ou des variables en lecture seule. L'applet de commande ne peut pas modifier des alias ou variables constants. L'implémentation est différente d'un fournisseur à l'autre. Pour plus d'informations, consultez about_Providers. Même en utilisant le paramètre Force, l'applet de commande ne peut pas remplacer les restrictions de sécurité.
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[]>
Modifie uniquement les éléments spécifiés. 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 le chemin d'accès à l'emplacement des nouveaux éléments. Contrairement à Path, 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 |
-PassThru
Passe un objet représentant l'élément au pipeline. Par défaut, cette applet de commande ne génère aucune sortie.
Obligatoire ? |
false |
Position ? |
named |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
false |
Accepter les caractères génériques ? |
false |
-Path <string[]>
Spécifie le chemin d'accès à l'emplacement des nouveaux éléments. Les caractères génériques sont autorisés.
Obligatoire ? |
true |
Position ? |
1 |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
true (ByPropertyName) |
Accepter les caractères génériques ? |
false |
-Value <Object>
Spécifie une nouvelle valeur pour l'élément.
Obligatoire ? |
false |
Position ? |
2 |
Valeur par défaut |
|
Accepter l'entrée de pipeline ? |
true (ByValue, 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 |
System.Object Vous pouvez diriger un objet représentant la nouvelle valeur de l'élément vers Set-Item. |
Sorties |
Aucun ou un objet représentant l'élément nouveau ou modifié. Lorsque vous utilisez le paramètre PassThru, Set-Item génère un objet qui représente l'élément. Sinon, cette applet de commande ne génère aucune sortie. |
Remarques
Vous pouvez également faire référence à Set-Item par son alias intégré, « si ». Pour plus d'informations, consultez about_Aliases.
L'applet de commande Set-Item n'est pas prise en charge par le fournisseur FileSystem de Windows PowerShell. Pour modifier les valeurs d'éléments du système de fichiers, utilisez Set-Content.
Dans les lecteurs de Registre, HKLM: et HKCU:, Set-Item modifie les données dans la valeur (par défaut) d'une clé de Registre. Pour créer et modifier le nom des clés de Registre, utilisez New-Item et Rename-Item. Pour modifier les noms et les données dans les valeurs de Registre, utilisez New-ItemProperty, Set-ItemProperty et Rename-ItemProperty.
L'applet de commande Set-Item 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>set-item -path alias:np -value c:\windows\notepad.exe
Description
-----------
Cette commande crée un alias « np » pour le Bloc-notes (Notepad).
Exemple 2
C:\PS>set-item -path env:UserRole -value Administrator
Description
-----------
Cette commande utilise l'applet de commande Set-Item pour modifier la valeur de la variable d'environnement « UserRole » en « Administrator ».
Exemple 3
C:\PS>set-item -path function:prompt -value {'PS '+ $(Get-Date -format t) + " " + $(Get-Location) + '> '}
Description
-----------
La commande suivante utilise l'applet de commande Set-Item pour modifier la fonction « prompt » afin qu'elle affiche l'heure avant le chemin d'accès.
Exemple 4
C:\PS>set-item -path function:prompt -options "AllScope,ReadOnly"
Description
-----------
Cette commande définit les options AllScope et ReadOnly pour la fonction « prompt ». Elle utilise le paramètre dynamique Options de l'applet de commande Set-Item. Le paramètre Options n'est disponible dans Set-Item que lorsque vous l'utilisez avec le fournisseur Alias ou Function.
Voir aussi
Concepts
about_Providers
Get-Item
New-Item
Remove-Item
Clear-Item
Invoke-Item
Rename-Item
Move-Item
Copy-Item