Noms de paramètres courants

Article
09/27/2021

Les paramètres décrits dans cette rubrique sont appelés paramètres communs. ils sont ajoutés aux applets de commande par le runtime Windows PowerShell et ne peuvent pas être déclarés par l’applet de commande.

Notes

Ces paramètres sont également ajoutés aux applets de commande du fournisseur et aux fonctions qui sont décorées avec l' CmdletBinding attribut.

Paramètres communs généraux

Les paramètres suivants sont ajoutés à toutes les applets de commande et sont accessibles chaque fois que l’applet de commande est exécutée. Ces paramètres sont définis par la classe System. Management. Automation. Internal. paramètres_courants .

Confirmer (alias : CF)

Type de données : Paramètre_booléen

Ce paramètre spécifie si l’applet de commande affiche une invite demandant si l’utilisateur est sûr qu’il souhaite continuer.

Débogage (alias : DB)

Type de données : Paramètre_booléen

Ce paramètre spécifie si les messages de débogage au niveau du programmeur peuvent être affichés sur la ligne de commande. Ces messages sont destinés à résoudre les problèmes liés au fonctionnement de l’applet de commande et sont générés par les appels à la méthode System. Management. Automation. cmdlet. WriteDebug . Il n’est pas nécessaire de localiser les messages de débogage.

ErrorAction (alias : EA)

Type de données : énumération

Ce paramètre spécifie l’action qui doit être exécutée lorsqu’une erreur se produit. Les valeurs possibles pour ce paramètre sont définies par l’énumération System. Management. Automation. PréférenceAction .

ErrorVariable (alias : ev)

Type de données : Chaîne

Ce paramètre spécifie la variable dans laquelle placer les objets lorsqu’une erreur se produit. Pour ajouter à cette variable, utilisez +varname plutôt que d’effacer et de définir la variable.

Buffer (alias : OB)

Type de données : Int32

Ce paramètre définit le nombre d’objets à stocker dans la mémoire tampon de sortie avant que tous les objets ne soient passés dans le pipeline. Par défaut, les objets sont passés immédiatement en dessous du pipeline.

Dévariable (alias : OV)

Type de données : Chaîne

Ce paramètre spécifie la variable dans laquelle placer tous les objets de sortie générés par l’applet de commande. Pour ajouter à cette variable, utilisez +varname plutôt que d’effacer et de définir la variable.

PipelineVariable (alias : PV)

Type de données : Chaîne

Ce paramètre stocke la valeur de l’élément de pipeline actuel en tant que variable pour toute commande nommée à mesure qu’il traverse le pipeline.

Verbose (alias : VB)

Type de données : Paramètre_booléen

Ce paramètre spécifie si l’applet de commande écrit des messages explicatifs qui peuvent être affichés sur la ligne de commande. Ces messages sont destinés à fournir de l’aide supplémentaire à l’utilisateur et sont générés par les appels à la méthode System. Management. Automation. applet de commande. WriteVerbose .

WarningAction (alias : WA)

Type de données : énumération

Ce paramètre spécifie l’action qui doit être effectuée lorsque l’applet de commande écrit un message d’avertissement. Les valeurs possibles pour ce paramètre sont définies par l’énumération System. Management. Automation. PréférenceAction .

WarningVariable (alias : WV)

Type de données : Chaîne

Ce paramètre spécifie la variable dans laquelle les messages d’avertissement peuvent être enregistrés. Pour ajouter à cette variable, utilisez +varname plutôt que d’effacer et de définir la variable.

Paramètres Risk-Mitigation

Les paramètres suivants sont ajoutés aux applets de commande qui demandent une confirmation avant d’exécuter leur action. Pour plus d’informations sur les demandes de confirmation, consultez demande de confirmation. Ces paramètres sont définis par la classe System. Management. Automation. Internal. Shouldprocessparameters .

WhatIf (alias : Wi)

Type de données : Paramètre_booléen

Ce paramètre spécifie si l’applet de commande écrit un message qui décrit les effets de l’exécution de l’applet de commande sans effectuer d’action.

Paramètres de transaction

Le paramètre suivant est ajouté aux applets de commande qui prennent en charge les transactions. Ces paramètres sont définis par la classe System. Management. Automation. Internal. Transactionparameters . La prise en charge des transactions a été introduite dans PowerShell 3,0 et supprimée dans PowerShell 6,0.