Set-Alias

Crée ou modifie un alias (autre nom) pour une applet de commande ou un autre élément de commande dans la session Windows PowerShell actuelle.

Syntaxe

Set-Alias [-Name] <string> [-Value] <string> [-Description <string>] [-Force] [-Option {<None> | <ReadOnly> | <Constant> | <Private> | <AllScope>}] [-PassThru] [-Scope <string>] [-Confirmer] [-WhatIf] [<CommonParameters>]

Description

L'applet de commande Set-Alias crée ou modifie un alias (autre nom) pour une applet de commande ou pour un élément de commande, tel qu'une fonction, un script, un fichier ou un autre fichier exécutable. Vous pouvez également utiliser Set-Alias pour réaffecter un alias actuel à une nouvelle commande, ou pour modifier n'importe laquelle des propriétés d'un alias, par exemple sa description. À moins d'ajouter l'alias au profil Windows PowerShell, les modifications apportées à un alias sont perdues lorsque vous quittez la session ou fermez Windows PowerShell.

Paramètres

-Description <string>

Spécifie une description de l'alias. Vous pouvez taper toute chaîne. Si la description inclut des espaces, mettez-les entre guillemets.

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 un alias en lecture seule. Utilisez le paramètre Option pour créer un alias en lecture seule. Le paramètre Force ne peut pas définir un alias constant.

Obligatoire ?	false
Position ?	named
Valeur par défaut
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Name <string>

Spécifie le nouvel alias. Vous pouvez utiliser tous les caractères alphanumériques dans un alias, mais le premier caractère ne peut pas être un nombre.

Obligatoire ?	true
Position ?	1
Valeur par défaut
Accepter l'entrée de pipeline ?	true (ByPropertyName)
Accepter les caractères génériques ?	false

-Option <ScopedItemOptions>

Définit la valeur de la propriété Options de l'alias.

Les valeurs valides sont :

-- None : ne définit pas d'options. (par défaut)

-- ReadOnly : les propriétés de l'alias ne peuvent pas être modifiées, sauf en utilisant le paramètre Force. Vous pouvez utiliser Remove-Item pour supprimer l'alias.

-- Constant : l'alias ne peut pas être supprimé et ses propriétés ne peuvent pas être modifiées. La valeur Constant est disponible uniquement lorsque vous créez un alias. Vous ne pouvez pas remplacer l'option d'un alias existant par Constant.

-- Private : l'alias est disponible uniquement dans la portée spécifiée par le paramètre Scope. Il est invisible dans toutes les autres portées.

-- AllScope : l'alias est copié vers toutes les nouvelles portées qui sont créées.

Pour consulter la propriété Options des alias, tapez « get-alias | Format-Table -property Name, Definition, Options -autosize ».

Obligatoire ?	false
Position ?	named
Valeur par défaut
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-PassThru

Retourne un objet représentant l'alias. 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

-Scope <string>

Spécifie la portée dans laquelle cet alias est valide. Les valeurs valides sont « Global », « Local » ou « Script », ou un nombre relatif à la portée actuelle (0 jusqu'au nombre de portées, où 0 est la portée actuelle et 1 son parent). « Local » est la valeur par défaut. Pour plus d'informations, consultez about_Scopes.

Obligatoire ?	false
Position ?	named
Valeur par défaut
Accepter l'entrée de pipeline ?	false
Accepter les caractères génériques ?	false

-Value <string>

Spécifie le nom de l'applet de commande ou de l'élément de commande doté d'un alias.

Obligatoire ?	true
Position ?	2
Valeur par défaut
Accepter l'entrée de pipeline ?	true (ByPropertyName)
Accepter les caractères génériques ?	false

-Confirmer

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

<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	Aucun Vous ne pouvez pas diriger d'entrée vers cette applet de commande.
Sorties	Aucun ou System.Management.Automation.AliasInfo Lorsque vous utilisez le paramètre PassThru, Set-Alias génère un objet System.Management.Automation.AliasInfo qui représente l'alias. Sinon, cette applet de commande ne génère aucune sortie.

Remarques

Un alias est un autre nom ou surnom pour une applet de commande ou un élément de commande. Pour exécuter l'applet de commande, utilisez son nom complet ou tout alias valide. Pour plus d'informations, consultez about_Aliases.

Pour créer un alias, utilisez Set-Alias ou New-Alias. Pour supprimer un alias, utilisez Remove-Item.

Une applet de commande peut avoir plusieurs alias, mais un alias peut être associé à une seule applet de commande à la fois. Si vous utilisez set-alias pour associer l'alias à une applet de commande différente, il n'est plus associé à l'applet de commande d'origine.

Vous pouvez créer un alias pour une applet de commande, mais vous ne pouvez pas créer d'alias pour une commande avec des paramètres et des valeurs. Par exemple, vous pouvez créer un alias pour Set-Location, mais vous ne pouvez pas créer un alias pour « Set-Location C:\Windows\System32 ». Pour créer un alias pour une commande, créez une fonction qui inclut la commande, puis créez un alias de la fonction.

Pour enregistrer les alias d'une session et les utiliser dans une session différente, ajoutez la commande set-alias à votre profil Windows PowerShell. Les profils n'existent pas par défaut. Pour créer un profil dans le chemin d'accès stocké dans la variable $profile, tapez « new-item -type file -force $profile ». Pour consulter la valeur de la variable $profile, tapez « $profile ».

Vous pouvez également enregistrer vos alias en utilisant Export-Alias pour copier les alias de la session vers un fichier, puis utiliser Import-Alias pour les ajouter à la liste d'alias d'une nouvelle session.

Vous pouvez également faire référence à Set-Alias par son alias intégré, « sal ». Pour plus d'informations, consultez about_Aliases.

Exemple 1

C:\PS>set-alias -name list -value get-childitem

Description
-----------
Cette commande crée l'alias « list » pour l'applet de commande Get-ChildItem. Après avoir créé l'alias, vous pouvez utiliser « list » à la place de « Get-ChildItem » sur la ligne de commande et dans les scripts.

Exemple 2

C:\PS>set-alias list get-location

Description
-----------
Cette commande associe l'alias « list » à l'applet de commande Get-Location. Si « list » est un alias pour une autre applet de commande, cette commande modifie son association afin qu'il soit maintenant uniquement l'alias pour Get-Location.

Cette commande utilise le même format que la commande dans l'exemple précédent, mais omet les noms de paramètres optionnels, -Name et -Value. Lorsque vous omettez des noms de paramètre, les valeurs de ces paramètres doivent apparaître dans l'ordre spécifié dans la commande. Dans ce cas, la valeur de -Name (« list ») doit être le premier paramètre et la valeur de -Value (« get-location ») doit être le deuxième paramètre.

Exemple 3

C:\PS>set-alias scrub remove-item -option readonly -passthru | format-list

Description
-----------
Cette commande associe l'alias « scrub » à l'applet de commande Remove-Item. Elle utilise l'option « ReadOnly » pour empêcher la suppression de l'alias ou son assignation à une autre applet de commande.

Le paramètre PassThru indique à Windows PowerShell de passer à l'applet de commande Format-List, par le biais du pipeline, un objet représentant le nouvel alias. Si le paramètre PassThru est omis, il n'y a aucune sortie de cette applet de commande à afficher (dans une liste ou autre).

Exemple 4

C:\PS>Set-Alias np c:\windows\notepad.exe

Description
-----------
Cette commande associe l'alias, « np », au fichier exécutable pour le Bloc-notes. Après avoir complété la commande, pour ouvrir le Bloc-notes à partir de la ligne de commande Windows PowerShell, tapez simplement « np ».

Cet exemple montre que vous pouvez créer des alias pour les fichiers exécutables et les éléments autres que les applets de commande.

Pour rendre la commande plus générique, vous pouvez utiliser la variable d'environnement « Windir » (${env:windir}) pour représenter le répertoire C\Windows. La version générique de la commande est « set-alias np ${env:windir}\notepad.exe ».

Exemple 5

C:\PS>function CD32 {set-location c:\windows\system32}

C:\PS>set-alias go cd32

Description
-----------
Ces commandes indiquent comment assigner un alias à une commande avec des paramètres, ou même à un pipeline comprenant de nombreuses commandes.

Vous pouvez créer un alias pour une applet de commande, mais vous ne pouvez pas créer d'alias pour une commande qui consiste en une applet de commande et ses paramètres. Toutefois, si vous placez la commande dans une fonction ou un script, vous pouvez créer une fonction utile ou un nom de script et vous pouvez créer un ou plusieurs alias pour la fonction ou le script.

Dans cet exemple, l'utilisateur souhaite créer un alias pour la commande « set-location c:\windows\system32 », où « set-location » est une applet de commande et « C:\Windows\System32 » est la valeur du paramètre Path. 

Pour ce faire, la première commande crée une fonction appelée « CD32 » qui contient la commande Set-Location.

La seconde commande crée l'alias « go » pour la fonction CD32. Ensuite, l'utilisateur peut taper « CD32 » ou « go » pour exécuter la commande Set-Location.

Voir aussi

Concepts

Get-Alias
New-Alias
Export-Alias
Import-Alias