Verbes approuvés pour les commandes PowerShell

  • Article

PowerShell utilise une paire verbe-nom pour les noms des applets de commande et pour leurs classes .NET dérivées. La partie verbe du nom identifie l’action effectuée par l’applet de commande. La partie substantif du nom identifie l’entité sur laquelle l’action est effectuée. Par exemple, l’applet de commande Get-Command récupère toutes les commandes qui sont inscrites dans PowerShell.

Notes

PowerShell utilise le terme verbe pour décrire un mot qui implique une action, même si ce mot n’est pas un verbe standard en anglais. Par exemple, le terme New est un nom de verbe PowerShell valide, car il implique une action, même s’il ne s’agit pas d’un verbe en langue anglaise.

Chaque verbe approuvé a un préfixe d’alias correspondant défini. Nous utilisons ce préfixe d’alias dans des alias pour les commandes qui utilisent ce verbe. Par exemple, le préfixe d’alias pour Import est ip et, en conséquence, l’alias pour Import-Module est ipmo. Il s’agit d’une recommandation, mais pas d’une règle ; il n’est pas nécessaire de la respecter en particulier pour les alias de commande imitant des commandes bien connues d’autres environnements.

Recommandations relatives au nommage des verbes

Les recommandations suivantes vous aideront à choisir un verbe approprié pour votre applet de commande, afin de garantir la cohérence entre les applets de commande que vous créez, celles fournies par PowerShell et celles conçues par d’autres personnes.

  • Utilisez l’un des noms de verbes prédéfinis fournis par PowerShell.
  • Utilisez le verbe pour décrire l’étendue générale de l’action, et des paramètres pour affiner l’action de l’applet de commande.
  • N’utilisez pas un synonyme d’un verbe approuvé. Par exemple, utilisez toujours Remove ; n’utilisez jamais Delete ou Eliminate.
  • Utilisez uniquement la forme de chaque verbe qui est listée dans cette rubrique. Par exemple, utilisez Get, mais n’utilisez pas Getting ou Gets.
  • N’utilisez pas les verbes ou alias réservés suivants. Le langage PowerShell et quelques cmdlets rares utilisent ces verbes dans des circonstances exceptionnelles.
    • ForEach (foreach)
    • Ping (pi)
    • Sort (sr)
    • Tee (te)
    • Where (wh)

Vous pouvez obtenir une liste complète des verbes avec l’applet de commande Get-Verb.

Verbes similaires pour des actions différentes

Les verbes similaires suivants représentent des actions différentes.

Nouveaux et ajouter

Utilisez le verbe New pour créer une ressource. Utilisez pour ajouter des Add éléments à un conteneur ou à une ressource existants. Par exemple, Add-Content ajoute la sortie à un fichier existant.

New vs. Set

Utilisez le verbe New pour créer une ressource. Utilisez le verbe Set pour modifier une ressource existante, éventuellement la créer si elle n’existe pas, comme dans Set-Variable.

Utilisez le verbe Find pour rechercher un objet. Utilisez le verbe Search pour créer une référence à une ressource dans un conteneur.

Get vs. Read

Utilisez le verbe Get pour obtenir des informations sur une ressource (par exemple un fichier) ou pour obtenir un objet avec lequel vous pouvez ultérieurement accéder à la ressource. Utilisez le Read verbe pour ouvrir une ressource et extraire des informations contenues dans.

Invoke vs. Start

Utilisez le verbe Invoke pour effectuer des opérations synchrones, comme exécuter une commande et attendre qu’elle se termine. Utilisez le verbe pour démarrer des opérations asynchrones, telles que le Start démarrage d’un processus autonome.

Ping vs. Test

Utilisez le verbe Test.

Verbes courants

PowerShell utilise la classe d’énumération System.Management.Automation.VerbsCommon pour définir des actions génériques qui peuvent s’appliquer à presque n’importe quelle applet de commande. Le tableau suivant liste la plupart des verbes définis.

Verbe (alias) Action Synonymes à éviter
Add (a) Ajoute une ressource à un conteneur, ou attache un élément à un autre élément. Par exemple, l’applet de commande Add-Content ajoute du contenu à un fichier. Ce verbe est associé à Remove. Append, Attach, Concatenate, Insert
Clear (cl) Supprime toutes les ressources d’un conteneur, mais ne supprime pas le conteneur. Par exemple, l’applet de commande Clear-Content supprime le contenu d’un fichier, mais ne supprime pas le fichier. Flush, Erase, Release, Unmark, Unset, Nullify
Close (cs) Change l’état d’une ressource afin de la rendre inaccessible, indisponible ou inutilisable. Ce verbe est associé à Open.
Copy (cp) Copie une ressource vers un autre nom ou un autre conteneur. Par exemple, l’applet de commande Copy-Item copie un élément (tel qu’un fichier) d’un emplacement dans le magasin de données vers un autre emplacement. Duplicate, Clone, Replicate, Sync
Enter (et) Spécifie une action qui permet à l’utilisateur de se déplacer vers une ressource. Par exemple, l’applet de commande Enter-PSSession place l’utilisateur dans une session interactive. Ce verbe est associé à Exit. Push, Into
Exit (ex) Définit le dernier contexte utilisé comme environnement ou contexte actuel. Par exemple, l’applet de commande Exit-PSSession place l’utilisateur dans la session qui a été utilisée pour démarrer la session interactive. Ce verbe est associé à Enter. Pop, Out
Find (fd) Recherche un objet dans un conteneur inconnu, implicite, facultatif ou spécifié. Search
Format (f) Organise les objets dans un formulaire ou une disposition spécifiés
Get (g) Spécifie une action qui récupère une ressource. Ce verbe est associé à Set. Read, Open, Cat, Type, Dir, Obtain, Dump, Acquire, Examine, Find, Search
Hide (h) Rend une ressource indétectable. Par exemple, une applet de commande dont le nom comprend le verbe Hide peut masquer un service aux yeux d’un utilisateur. Ce verbe est associé à Show. Block
Join (j) Combine des ressources en une seule ressource. Par exemple, l’applet de commande Join-Path combine un chemin avec l’un de ses chemins enfants afin de créer un chemin unique. Ce verbe est associé à Split. Combine, Unite, Connect, Associate
Lock (lk) Sécurise une ressource. Ce verbe est associé à Unlock. Restrict, Secure
Move (m) Déplace une ressource d’un emplacement à un autre. Par exemple, l’applet de commande Move-Item déplace un élément d’un emplacement dans le magasin de données vers un autre emplacement. Transfer, Name, Migrate
New (n) Crée une ressource. (Le verbe Set peut également être utilisé lors de la création d’une ressource qui comprend des données, comme dans l’applet de commande Set-Variable.) Create, Generate, Build, Make, Allocate
Open (op) Change l’état d’une ressource afin de la rendre accessible, disponible ou utilisable. Ce verbe est associé à Close.
Optimize (om) Augmente l’efficacité d’une ressource.
Pop (pop) Supprime un élément du haut d’une pile. Par exemple, l’applet de commande Pop-Location définit comme emplacement actuel le dernier emplacement placé sur la pile.
Push (pu) Ajoute un élément en haut d’une pile. Par exemple, l’applet de commande Push-Location place l’emplacement actuel sur la pile.
Redo (re) Réinitialise une ressource à l’état qui a été annulé.
Remove (r) Supprime une ressource d’un conteneur. Par exemple, l’applet de commande Remove-Variable supprime une variable et sa valeur. Ce verbe est associé à Add. Clear, Cut, Dispose, Discard, Erase
Rename (rn) Change le nom d’une ressource. Par exemple, l’applet de commande Rename-Item, qui sert à accéder à des données stockées, change le nom d’un élément dans le magasin de données. Change
Reset (rs) Restaure une ressource à son état d’origine.
Resize(rz) Change la taille d’une ressource.
Search (sr) Crée une référence à une ressource dans un conteneur. Find, Locate
Select (sc) Localise une ressource dans un conteneur. Par exemple, l’applet de commande Select-String recherche du texte dans des chaînes et des fichiers. Find, Locate
Set (s) Remplace des données sur une ressource existante, ou crée une ressource qui contient des données. Par exemple, l’applet de commande Set-Date change l’heure système sur l’ordinateur local. (Le verbe New peut également être utilisé pour créer une ressource.) Ce verbe est associé à Get. Write, Reset, Assign, Configure
Show (sh) Rend une ressource visible par l’utilisateur. Ce verbe est associé à Hide. Display, Produce
Skip (sk) Ignore une ou plusieurs ressources ou points dans une séquence. Bypass, Jump
Split (sl) Sépare les parties d’une ressource. Par exemple, l’applet de commande Split-Path retourne différentes parties d’un chemin. Ce verbe est associé à Join. Separate
Step (st) Passe au point ou à la ressource suivant(e) dans une séquence.
Switch (sw) Spécifie une action qui alterne entre deux ressources, telles que le changement entre deux emplacements, responsabilités ou états.
Undo (un) Définit une ressource à son état précédent.
Unlock (uk) Libère une ressource qui a été verrouillée. Ce verbe est associé à Lock. Release, Unrestrict, Unsecure
Watch (wc) Inspecte ou supervise en permanence une ressource afin de détecter les modifications.

Verbes de communication

PowerShell utilise la classe System.Management.Automation.VerbsCommunications pour définir des actions qui s’appliquent aux communications. Le tableau suivant liste la plupart des verbes définis.

Verbe (alias) Action Synonymes à éviter
Connect (cc) Crée un lien entre une source et une destination. Ce verbe est associé à Disconnect. Join, Telnet
Disconnect (dc) Rompt le lien entre une source et une destination. Ce verbe est associé à Connect. Break, Logoff
Read (rd) Acquiert des informations à partir d’une source. Ce verbe est associé à Write. Acquire, Prompt, Get
Receive (rc) Accepte les informations envoyées à partir d’une source. Ce verbe est associé à Send. Read, Accept, Peek
Send (sd) Envoie des informations à une destination. Ce verbe est associé à Receive. Put, Broadcast, Mail, Fax
Write (wr) Ajoute des informations à une cible. Ce verbe est associé à Read. Put, Print

Verbes de données

PowerShell utilise la classe System.Management.Automation.VerbsData pour définir des actions qui s’appliquent à la gestion des données. Le tableau suivant liste la plupart des verbes définis.

Nom du verbe (alias) Action Synonymes à éviter
Backup (ba) Stocke des données en les répliquant. Save, Burn, Replicate, Sync
Checkpoint (ch) Crée un instantané de l’état actuel des données ou de sa configuration. Diff
Compare (cr) Évalue les données d’une ressource par rapport aux données d’une autre ressource. Diff
Compress (cm) Compacte les données d’une ressource. Associé à Expand. Compact
Convert (cv) Change les données d’une représentation en une autre lorsque l’applet de commande prend en charge la conversion bidirectionnelle ou la conversion entre plusieurs types de données. Change, Resize, Resample
ConvertFrom (cf) Convertit un type principal d’entrée (le substantif de l’applet de commande indique l’entrée) en un ou plusieurs types de sortie pris en charge. Export, Output, Out
ConvertTo (ct) Convertit à partir d’un ou plusieurs types d’entrée en un type de sortie principal (le substantif de l’applet de commande indique le type de sortie). Import, Input, In
Dismount (dm) Détache une entité nommée d’un emplacement. Ce verbe est associé à Mount. Unmount, Unlink
Edit (ed) Modifie des données existantes en ajoutant ou en supprimant du contenu. Change, Update, Modify
Expand (en) Restaure l’état d’origine des données d’une ressource qui a été compressée. Ce verbe est associé à Compress. Explode, Uncompress
Export (ep) Encapsule l’entrée principale dans un magasin de données persistant, tel qu’un fichier, ou dans un format d’échange. Ce verbe est associé à Import. Extract, Backup
Groupe (GP) Organise ou associe une ou plusieurs ressources
Import (ip) Crée une ressource à partir de données stockées dans un magasin de données persistant (tel qu’un fichier) ou dans un format d’échange. Par exemple, l’applet de commande Import-CSV importe des données à partir d’un fichier de valeurs séparées par des virgules (CSV) vers des objets qui peuvent être utilisés par d’autres applets de commande. Ce verbe est associé à Export. BulkLoad, Load
Initialize (in) Prépare une ressource en vue de l’utiliser, et lui affecte un état par défaut. Erase, Init, Renew, Rebuild, Reinitialize, Setup
Limit (l) Applique des contraintes à une ressource. Quota
Merge (mg) Crée une ressource unique à partir de plusieurs ressources. Combine, Join
Mount (mt) Attache une entité nommée à un emplacement. Ce verbe est associé à Dismount. Connect
Out (o) Envoie des données à partir de l’environnement. Par exemple, l’applet de commande Out-Printer envoie des données à une imprimante.
Publish (pb) Met une ressource à la disposition d’autres utilisateurs. Ce verbe est associé à Unpublish. Deploy, Release, Install
Restore (rr) Affecte à une ressource un état prédéfini, tel qu’un état défini par Checkpoint. Par exemple, l’applet de commande Restore-Computer démarre une restauration du système sur l’ordinateur local. Repair, Return, Undo, Fix
Save (sv) Préserve des données afin d’éviter toute perte.
Sync (sy) Garantit que deux ressources ou plus sont dans le même état. Replicate, Coerce, Match
Unpublish (ub) Rend une ressource inaccessible à d’autres personnes. Ce verbe est associé à Publish. Uninstall, Revert, Hide
Update (ud) Met à jour une ressource afin de maintenir son état, son exactitude ou sa conformité. Par exemple, l’applet de commande Update-FormatData met à jour et ajoute des fichiers de mise en forme à la console PowerShell actuelle. Refresh, Renew, Recalculate, Re-index

Verbes de diagnostic

PowerShell utilise la classe System.Management.Automation.VerbsDiagnostic pour définir des actions qui s’appliquent à des diagnostics. Le tableau suivant liste la plupart des verbes définis.

Verbe (alias) Action Synonymes à éviter
Debug (db) Examine une ressource pour diagnostiquer les problèmes opérationnels. Diagnose
Measure (ms) Identifie les ressources qui sont consommées par une opération spécifiée, ou récupère des statistiques sur une ressource. Calculate, Determine, Analyze
Ping (pi) Déconseillé : utilisez le verbe de test à la place.
Repair (rp) Restaure une ressource dans une condition utilisable. Fix, Restore
Resolve (rv) Mappe une représentation abrégée d’une ressource à une représentation plus complète. Expand, Determine
Test (t) Vérifie l’opération ou la cohérence d’une ressource. Diagnose, Analyze, Salvage, Verify
Trace (tr) Effectue le suivi des activités d’une ressource. Track, Follow, Inspect, Dig

Verbes de cycle de vie

PowerShell utilise la classe System.Management.Automation.VerbsLifeCycle pour définir des actions qui s’appliquent au cycle de vie d’une ressource. Le tableau suivant liste la plupart des verbes définis.

Verbe (alias) Action Synonymes à éviter
Approve (ap) Confirme ou accepte l’état d’une ressource ou d’un processus.
Assert (as) Affirme l’état d’une ressource. Certify
Build (bd) Crée un artefact (généralement un fichier binaire ou un document) à partir d’un ensemble de fichiers d’entrée (généralement du code source ou des documents déclaratifs). Ce verbe a été ajouté dans PowerShell 6.
Complete (cp) Conclut une opération.
Confirm (cn) Accuse réception, vérifie ou valide l’état d’une ressource ou d’un processus. Acknowledge, Agree, Certify, Validate, Verify
Deny (dn) Refuse, objecte, bloque ou s’oppose à l’état d’une ressource ou d’un processus. Block, Object, Refuse, Reject
Deploy (dp) Envoie une application, un site web ou une solution à une ou plusieurs cibles distantes de manière à ce qu’un consommateur de cette solution puisse y accéder une fois le déploiement terminé. Ce verbe a été ajouté dans PowerShell 6.
Disable (d) Configure une ressource à un état indisponible ou inactif. Par exemple, l’applet de commande Disable-PSBreakpoint rend un point d’arrêt inactif. Ce verbe est associé à Enable. Halt, Hide
Enable (e) Configure une ressource à un état disponible ou actif. Par exemple, l’applet de commande Enable-PSBreakpoint rend un point d’arrêt actif. Ce verbe est associé à Disable. Start, Begin
Install (is) Place une ressource dans un emplacement et l’initialise éventuellement. Ce verbe est associé à Uninstall. Setup
Invoke (i) Effectue une action, telle que l’exécution d’une commande ou d’une méthode. Run, Start
Register (rg) Crée une entrée pour une ressource dans un référentiel tel qu’une base de données. Ce verbe est associé à Unregister.
Request (rq) Demande une ressource ou des autorisations.
Restart (rt) Arrête une opération, puis la redémarre. Par exemple, l’applet de commande Restart-Service arrête, puis démarre un service. Recycle
Resume (ru) Démarre une opération qui a été suspendue. Par exemple, l’applet de commande Resume-Service démarre un service qui a été suspendu. Ce verbe est associé à Suspend.
Start (sa) Lance une opération. Par exemple, l’applet de commande Start-Service démarre un service. Ce verbe est associé à Stop. Launch, Initiate, Boot
Stop (sp) Interrompt une activité. Ce verbe est associé à Start. End, Kill, Terminate, Cancel
Submit (sb) Présente une ressource pour approbation. Post
Suspend (ss) Suspend une activité. Par exemple, l’applet de commande Suspend-Service suspend un service. Ce verbe est associé à Resume. Pause
Uninstall (us) Supprime une ressource d’un emplacement indiqué. Ce verbe est associé à Install.
Unregister (ur) Supprime l’entrée d’une ressource d’un référentiel. Ce verbe est associé à Register. Remove
Wait (w) Suspend une opération jusqu’à ce qu’un événement spécifié se produise. Par exemple, l’applet de commande Wait-Job suspend les opérations jusqu’à ce qu’un ou plusieurs des travaux en arrière-plan soient terminée. Sleep, Pause

Verbes de sécurité

PowerShell utilise la classe System.Management.Automation.VerbsSecurity pour définir des actions qui s’appliquent à la sécurité. Le tableau suivant liste la plupart des verbes définis.

Verbe (alias) Action Synonymes à éviter
Block (bl) Restreint l’accès à une ressource. Ce verbe est associé à Unblock. Prevent, Limit, Deny
Grant (gr) Autorise l’accès à une ressource. Ce verbe est associé à Revoke. Allow, Enable
Protect (pt) Protège une ressource contre les attaques ou pertes. Ce verbe est associé à Unprotect. Encrypt, Safeguard, Seal
Revoke (rk) Spécifie une action qui n’autorise pas l’accès à une ressource. Ce verbe est associé à Grant. Remove, Disable
Unblock (ul) Supprime les restrictions applicables à une ressource. Ce verbe est associé à Block. Clear, Allow
Unprotect (up) Supprime les protections d’une ressource qui ont été ajoutées afin de la protéger contre les attaques ou pertes. Ce verbe est associé à Protect. Decrypt, Unseal

Autres verbes

PowerShell utilise la classe System.Management.Automation.VerbsOther pour définir des noms de verbes canoniques qui ne correspondent à aucune catégorie de nom de verbe spécifique (comme les noms de verbes courants, de communication, de données, de cycle de vie ou de sécurité).

Verbe (alias) Action Synonymes à éviter
Use (u) Utilise ou inclut une ressource pour effectuer une opération.

Voir aussi