Partager via

Verbes approuvés pour les commandes PowerShell

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 nom 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 inscrites dans PowerShell.

Remarque

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 dans la langue anglaise. Par exemple, le terme New est un nom de verbe PowerShell valide, car il implique une action même s’il n’est pas un verbe dans la langue anglaise.

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

Recommandations d’affectation de noms de verbes

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

  • Utiliser 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 utiliser des paramètres pour affiner davantage l’action de l’applet de commande.
  • N’utilisez pas de synonyme d’un verbe approuvé. Par exemple, utilisez toujours Remove, n’utilisez jamais Delete ou Eliminate.
  • Utilisez uniquement la forme de chaque verbe répertorié dans cette rubrique. Par exemple, utilisez Get, mais n’utilisez Getting pas ou Gets.
  • N’utilisez pas les verbes ou alias réservés suivants. Le langage PowerShell et quelques applets de commande 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 à l’aide de l’applet de commande Get-Verb.

Verbes similaires pour différentes actions

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

New et Add

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

New et Set

Utilisez le verbe New pour créer une ressource. Utilisez le Set verbe pour modifier une ressource existante, si elle n’existe pas, par exemple l’applet Set-Variable de commande.

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 et 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 accéder à la ressource ultérieurement. Utilisez le verbe Read pour ouvrir une ressource et extraire des informations contenues dans.

Invoke et Start

Utilisez le verbe Invoke pour effectuer des opérations synchrones, telles que l’exécution d’une commande et son attente de fin. Utilisez le verbe Start pour commencer des opérations asynchrones, telles que le démarrage d’un processus autonome.

Ping et 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 répertorie 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. Ajouter, Attacher, Concaténer, Insérer
Clear (cl) Supprime toutes les ressources d’un conteneur, mais ne supprime pas le conteneur. Par exemple, l’applet Clear-Content de commande supprime le contenu d’un fichier, mais ne supprime pas le fichier. Rincer, Effacer, Relâcher, Démarquer, Désactiver, Annuler
Close (cs) Modifie l’état d’une ressource pour qu’elle soit inaccessible, indisponible ou inutilisable. Ce verbe est associé à Open.
Copy (cp) Copie une ressource vers un autre nom ou vers 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. Dupliquer, cloner, répliquer, synchroniser
Enter (et) Spécifie une action qui permet à l’utilisateur de se déplacer dans une ressource. Par exemple, l’applet de commande Enter-PSSession place l’utilisateur dans une session interactive. Ce verbe est associé à Exit. pousser, dans
Exit (ex) Définit l’environnement ou le contexte actuel sur le contexte le plus récent utilisé. Par exemple, l’applet de commande Exit-PSSession place l’utilisateur dans la session utilisée pour démarrer la session interactive. Ce verbe est associé à Enter. Sortez, sortez
Find (fd) Recherche un objet dans un conteneur inconnu, implicite, facultatif ou spécifié. Rechercher
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. lire, ouvrir, chat, taper, réir, obtenir, vider, acquérir, examiner, trouver, rechercher
Hide (h) Rend une ressource indétectable. Par exemple, une applet de commande dont le nom inclut le verbe Masquer peut masquer un service d’un utilisateur. Ce verbe est associé à Show. Bloquer
Join (j) Combine des ressources en une seule ressource. Par exemple, l’applet de commande Join-Path combine un chemin d’accès avec l’un de ses chemins enfants pour créer un chemin unique. Ce verbe est associé à Split. Combiner, Unit, Connect, Associate
Lock (lk) Sécurise une ressource. Ce verbe est associé à Unlock. Restreindre, sécuriser
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. Transfert, nom, migration
New (n) Crée une ressource. (Le verbe Set peut également être utilisé lors de la création d’une ressource qui inclut des données, telles que l’applet de commande Set-Variable.) Créer, générer, générer, créer, allouer
Open (op) Modifie l’état d’une ressource pour 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 remplace l’emplacement actuel par l’emplacement récemment envoyé sur la pile.
Push (pu) Ajoute un élément en haut d’une pile. Par exemple, l’applet de commande Push-Location envoie (push) 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. Effacer, Couper, Supprimer, Ignorer, Effacer
Rename (rn) Modifie le nom d’une ressource. Par exemple, l’applet de commande Rename-Item, utilisée pour accéder aux données stockées, modifie le nom d’un élément dans le magasin de données. Changez
Reset (rs) Définit une ressource à son état d’origine.
Resize (rz) Modifie la taille d’une ressource.
Search (sr) Crée une référence à une ressource dans un conteneur. Rechercher, Localiser
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. Rechercher, Localiser
Set (s) Remplace les données d’une ressource existante ou crée une ressource qui contient des données. Par exemple, l’applet de commande Set-Date modifie 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. Écrire, réinitialiser, affecter, configurer, mettre à jour
Show (sh) Rend une ressource visible par l’utilisateur. Ce verbe est associé à Hide. Afficher, produire
Skip (sk) Contourne une ou plusieurs ressources ou points dans une séquence. Contourner, sauter
Split (sl) Sépare les parties d’une ressource. Par exemple, l’applet de commande Split-Path retourne différentes parties d’un chemin d’accès. Ce verbe est associé à Join. Séparer
Step (st) Passe au point ou à la ressource suivant dans une séquence.
Switch (sw) Spécifie une action qui alterne entre deux ressources, par exemple pour changer entre deux emplacements, responsabilités ou états.
Undo (un) Définit une ressource à son état précédent.
Unlock (uk) Libère une ressource verrouillée. Ce verbe est associé à Lock. Mise en production, non sécurisée
Watch (wc) Inspecte ou surveille continuellement une ressource pour 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 répertorie 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. Rejoindre, Telnet, Connexion
Disconnect (dc) Interrompt le lien entre une source et une destination. Ce verbe est associé à Connect. Arrêt, déconnexion
Read (rd) Acquiert des informations à partir d’une source. Ce verbe est associé à Write. Acquérir, inviter, obtenir
Receive (rc) Accepte les informations envoyées à partir d’une source. Ce verbe est associé à Send. Lecture, Accepter, Aperçu
Send (sd) Fournit des informations à une destination. Ce verbe est associé à Receive. Mettre, diffuser, envoyer, télécopier
Write (wr) Ajoute des informations à une cible. Ce verbe est associé à Read. Mettre, imprimer

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 répertorie la plupart des verbes définis.

Nom du verbe (alias) Action Synonymes à éviter
Backup (ba) Stocke les données en les répliquant. Enregistrer, brûler, répliquer, synchroniser
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. Paires avec Expand. Compact
Convert (cv) Modifie les données d’une représentation à une autre lorsque l’applet de commande prend en charge la conversion bidirectionnelle ou lorsque l’applet de commande prend en charge la conversion entre plusieurs types de données. Modifier, redimensionner, rééchantillonner
ConvertFrom (cf) Convertit un type d’entrée principal (le nom de l’applet de commande indique l’entrée) en un ou plusieurs types de sortie pris en charge. Exportation, sortie, sortie
ConvertTo (ct) Convertit d’un ou plusieurs types d’entrée en type de sortie principal (le nom de l’applet de commande indique le type de sortie). Importation, entrée, in
Dismount (dm) Détache une entité nommée d’un emplacement. Ce verbe est associé à Mount. Démonter, Dissocier
Edit (ed) Modifie les données existantes en ajoutant ou en supprimant du contenu. Modifier, mettre à jour, modifier
Expand (en) Restaure les données d’une ressource qui a été compressée à son état d’origine. Ce verbe est associé à Compress. Explosion, décompression
Export (ep) Encapsule l’entrée primaire dans un magasin de données persistant, tel qu’un fichier ou dans un format d’échange. Ce verbe est associé à Import. Extraire, sauvegarder
Group (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 Import-Csv de commande importe des données 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, Charger
Initialize (in) Prépare une ressource à utiliser et la définit à un état par défaut. Effacer, Init, Renouveler, Reconstruire, Réinitialiser, Configurer
Limit (l) Applique des contraintes à une ressource. Quota
Merge (mg) Crée une ressource unique à partir de plusieurs ressources. Combiner, Joindre
Mount (mt) Attache une entité nommée à un emplacement. Ce verbe est associé à Dismount. Se connecter
Out (o) Envoie des données hors 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 personnes. Ce verbe est associé à Unpublish. Déployer, mettre en production, installer
Restore (rr) Définit 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 système sur l’ordinateur local. Réparation, retour, annulation, correction
Save (sv) Conserve les données pour éviter toute perte.
Sync (sy) Garantit que deux ressources ou plus sont dans le même état. Répliquer, forcer, mettre en correspondance
Unpublish (ub) Rend une ressource indisponible pour d’autres personnes. Ce verbe est associé à Publish. Désinstaller, Rétablir, Masquer
Update (ud) Apporte une ressource up-to-date pour maintenir son état, sa précision, sa conformité 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. Actualiser, renouveler, recalculer, réindexer

Verbes de diagnostic

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

Verbe (alias) Action Synonymes à éviter
Debug (db) Examine une ressource pour diagnostiquer les problèmes opérationnels. Diagnostiquer
Measure (ms) Identifie les ressources consommées par une opération spécifiée ou récupère des statistiques sur une ressource. Calculer, déterminer, analyser
Ping (pi) Déconseillé : utilisez plutôt le verbe Test.
Repair (rp) Restaure une ressource dans une condition utilisable Correctif, restauration
Resolve (rv) Mappe une représentation abrégée d’une ressource à une représentation plus complète. Développer, déterminer
Test (t) Vérifie l’opération ou la cohérence d’une ressource. Diagnostiquer, analyser, sauver, vérifier
Trace (tr) Effectue le suivi des activités d’une ressource. Traquer, suivre, inspecter, creuser

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 répertorie 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. Certifier
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) Reconnaît, vérifie ou valide l’état d’une ressource ou d’un processus. Accusé de réception, accepter, certifier, valider, vérifier
Deny (dn) Refuse, objets, blocs ou oppose l’état d’une ressource ou d’un processus. Bloquer, Objecter, Refuser, Rejeter
Deploy (dp) Envoie une application, un site web ou une solution à une cible distante de telle sorte 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. Arrêter, Masquer
Enable (e) Configure une ressource à un état disponible ou actif. Par exemple, l’applet de commande Enable-PSBreakpoint active un point d’arrêt. Ce verbe est associé à Disable. Démarrer, Commencer
Install (is) Place une ressource dans un emplacement et l’initialise éventuellement. Ce verbe est associé à Uninstall. Installation
Invoke (i) Effectue une action, telle que l’exécution d’une commande ou d’une méthode. Exécuter, démarrer
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 demande des autorisations.
Restart (rt) Arrête une opération, puis la redémarre. Par exemple, l’applet de commande Restart-Service s’arrête, puis démarre un service. Recycler
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. Lancer, lancer, démarrer
Stop (sp) Interrompt une activité. Ce verbe est associé à Start. Terminer, tuer, terminer, annuler
Submit (sb) Présente une ressource pour approbation. Publier
Suspend (ss) Interrompt 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. Supprimer
Wait (w) Suspend une opération jusqu’à ce qu’un événement spécifié se produise. Par exemple, l’applet de commande Wait-Job interrompt les opérations jusqu’à ce qu’une ou plusieurs tâches en arrière-plan soient terminées. Veille, 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 répertorie la plupart des verbes définis.

Verbe (alias) Action Synonymes à éviter
Block (bl) Limite l’accès à une ressource. Ce verbe est associé à Unblock. Empêcher, limiter, refuser
Grant (gr) Autorise l’accès à une ressource. Ce verbe est associé à Revoke. Autoriser, activer
Protect (pt) Protège une ressource contre une attaque ou une perte. Ce verbe est associé à Unprotect. Chiffrer, protéger, sceller
Revoke (rk) Spécifie une action qui n’autorise pas l’accès à une ressource. Ce verbe est associé à Grant. Supprimer, désactiver
Unblock (ul) Supprime les restrictions d’une ressource. Ce verbe est associé à Block. Effacer, autoriser
Unprotect (up) Supprime les protections d’une ressource ajoutée pour l’empêcher d’attaquer ou de perdre. Ce verbe est associé à Protect. Déchiffrer, annuler la suppression

Autres verbes

PowerShell utilise la classe System.Management.Automation.VerbsOther pour définir des noms de verbes canoniques qui ne correspondent pas à une catégorie de nom de verbe spécifique telle que les verbes courants, les communications, les données, le cycle de vie ou les verbes de sécurité.

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

Voir aussi