Set-Alias

Module:

Microsoft.PowerShell.Utility

Crée ou modifie un alias pour une applet de commande ou une autre commande dans la session PowerShell actuelle.

Syntax

Set-Alias
   [-Name] <string>
   [-Value] <string>
   [-Description <string>]
   [-Option <ScopedItemOptions>]
   [-PassThru]
   [-Scope <string>]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

L’applet Set-Alias de commande crée ou modifie un alias pour une applet de commande ou une commande, telle qu’une fonction, un script, un fichier ou un autre fichier exécutable. Un alias est un autre nom qui fait référence à une applet de commande ou à une commande. Par exemple, sal est l’alias de l’applet de Set-Alias commande. Pour plus d’informations, consultez about_Aliases.

Une applet de commande peut avoir plusieurs alias, mais un alias ne peut être associé qu’à une seule applet de commande. Vous pouvez utiliser Set-Alias pour réaffecter un alias existant à une autre applet de commande ou modifier les propriétés d’un alias, telles que la description.

Un alias créé ou modifié par Set-Alias n’est pas permanent et n’est disponible que pendant la session PowerShell actuelle. Lorsque la session PowerShell est fermée, l’alias est supprimé.

Exemples

Exemple 1 : Create un alias pour une applet de commande

Cette commande crée un alias pour une applet de commande dans la session PowerShell actuelle.

PS> Set-Alias -Name list -Value Get-ChildItem

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-ChildItem

L’applet Set-Alias de commande crée un alias dans la session PowerShell actuelle. Le paramètre Name spécifie le nom de l’alias, list. Le paramètre Value spécifie l’applet de commande que l’alias exécute.

Pour exécuter l’alias, tapez list sur la ligne de commande PowerShell.

Exemple 2 : Réaffecter un alias existant à une autre applet de commande

Cette commande réaffecte un alias existant pour exécuter une autre applet de commande.

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-ChildItem

PS> Set-Alias -Name list -Value Get-Location

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-Location

L’applet Get-Alias de commande utilise le paramètre Name pour afficher l’alias list . L’alias list est associé à l’applet de Get-ChildItem commande. Lorsque l’alias list est exécuté, les éléments du répertoire actif s’affichent.

L’applet Set-Alias de commande utilise le paramètre Name pour spécifier l’alias list . Le paramètre Value associe l’alias à l’applet de Get-Location commande.

L’applet Get-Alias de commande utilise le paramètre Name pour afficher l’alias list . L’alias list est associé à l’applet de Get-Location commande. Lorsque l’alias list est exécuté, l’emplacement du répertoire actif s’affiche.

Exemple 3 : Create et modifier un alias en lecture seule

Cette commande crée un alias en lecture seule. L’option en lecture seule empêche les modifications involontaires d’un alias. Pour modifier ou supprimer un alias en lecture seule, utilisez le paramètre Force .

PS> Set-Alias -Name loc -Value Get-Location -Option ReadOnly -PassThru | Format-List -Property *

DisplayName         : loc -> Get-Location
Definition          : Get-Location
Options             : ReadOnly
Description         :
Name                : loc
CommandType         : Alias

PS> Set-Alias -Name loc -Value Get-Location -Option ReadOnly -Description 'Displays the current directory' -Force -PassThru | Format-List -Property *

DisplayName         : loc -> Get-Location
Definition          : Get-Location
Options             : ReadOnly
Description         : Displays the current directory
Name                : loc
CommandType         : Alias

L’applet Set-Alias de commande crée un alias dans la session PowerShell actuelle. Le paramètre Name spécifie le nom de l’alias, loc. Le paramètre Value spécifie l’applet de Get-Location commande que l’alias exécute. Le paramètre Option spécifie la valeur ReadOnly . Le paramètre PassThru représente l’objet alias et envoie l’objet vers le bas du pipeline à l’applet de Format-List commande. Format-List utilise le paramètre Property avec un astérisque (*) afin que toutes les propriétés soient affichées. L’exemple de sortie montre une liste partielle de ces propriétés.

L’alias loc est modifié avec l’ajout de deux paramètres. La description ajoute du texte pour expliquer l’objectif de l’alias. Le paramètre Force est nécessaire, car l’alias loc est en lecture seule. Si le paramètre Force n’est pas utilisé, la modification échoue.

Exemple 4 : Create un alias dans un fichier exécutable

Cet exemple crée un alias pour un fichier exécutable sur l’ordinateur local.

PS> Set-Alias -Name np -Value C:\Windows\notepad.exe

PS> Get-Alias -Name np

CommandType     Name
-----------     ----
Alias           np -> notepad.exe

L’applet Set-Alias de commande crée un alias dans la session PowerShell actuelle. Le paramètre Name spécifie le nom de l’alias, np. Le paramètre Value spécifie le chemin d’accès et le nom de l’applicationC:\Windows\notepad.exe. L’applet Get-Alias de commande utilise le paramètre Name pour indiquer que l’alias np est associé à notepad.exe.

Pour exécuter l’alias, tapez np sur la ligne de commande PowerShell pour ouvrir notepad.exe.

Exemple 5 : Create un alias pour une commande avec des paramètres

Cet exemple montre comment affecter un alias à une commande avec des paramètres.

Vous pouvez créer un alias pour une applet de commande, par exemple Set-Location. Vous ne pouvez pas créer d’alias pour une commande avec des paramètres et des valeurs, tels que Set-Location -Path C:\Windows\System32. Pour créer un alias pour une commande, créez une fonction qui inclut la commande, puis créez un alias pour la fonction. Pour plus d’informations, consultez about_Functions.

PS> Function CD32 {Set-Location -Path C:\Windows\System32}

PS> Set-Alias -Name Go -Value CD32

Une fonction nommée CD32 est créée. La fonction utilise l’applet de Set-Location commande avec le paramètre Path pour spécifier le répertoire C :\Windows\System32.

L’applet Set-Alias de commande crée un alias pour la fonction dans la session PowerShell actuelle. Le paramètre Name spécifie le nom de l’alias, Go. Le paramètre Value spécifie le nom de la fonction, CD32.

Pour exécuter l’alias, tapez Go sur la ligne de commande PowerShell. La CD32 fonction s’exécute et change le répertoire C :\Windows\System32.

Paramètres

-Confirm

Vous demande une confirmation avant d’exécuter l’applet de commande.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Spécifie une description de l'alias. Vous pouvez entrer n'importe quelle chaîne. Si la description comprend des espaces, placez-la entre guillemets simples.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Utilisez le paramètre Force pour modifier ou supprimer un alias dont le paramètre Option est défini sur ReadOnly.

Le paramètre Force ne peut pas modifier ou supprimer un alias avec le paramètre Option défini sur Constante.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

Spécifie le nom d’un nouvel alias. Un nom d’alias peut contenir des caractères alphanumériques et des traits d’union. Les noms d’alias ne peuvent pas être numériques, par exemple 123.

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Option

Définit la valeur de la propriété Option de l’alias. Des valeurs telles que ReadOnly et Constant protègent un alias contre les modifications involontaires. Pour afficher la propriété Option de tous les alias de la session, tapez Get-Alias | Format-Table -Property Name, Options -Autosize.

Les valeurs acceptables pour ce paramètre sont les suivantes :

• AllScope L’alias est copié dans toutes les nouvelles étendues créées.
• Constante Impossible de modifier ou de supprimer.
• Aucun Ne définit aucune option et est la valeur par défaut.
• Privé L’alias est disponible uniquement dans l’étendue actuelle.
• Readonly Impossible de modifier ou de supprimer, sauf si le paramètre Force est utilisé.
• Unspecified

Type:	ScopedItemOptions
Accepted values:	AllScope, Constant, None, Private, ReadOnly, Unspecified
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

Retourne un objet qui représente l'alias. Utilisez une applet de commande de format telle que Format-List pour afficher l’objet. Par défaut, Set-Alias ne génère aucune sortie.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Scope

Spécifie l'étendue dans laquelle cet alias est valide. La valeur par défaut est Local. Pour plus d’informations, consultez about_Scopes.

Les valeurs acceptables sont les suivantes :

• Global
• Local
• Privées
• Étendues numérotées
• Script

Type:	String
Accepted values:	Global, Local, Private, Numbered scopes, Script
Position:	Named
Default value:	Local
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Value

Spécifie le nom de l’applet de commande ou de la commande exécutée par l’alias. Le paramètre Value est la propriété Definition de l’alias.

Type:	String
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-WhatIf

Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entrées

None

Set-Alias n’accepte pas d’entrée du pipeline.

Sorties

None or System.Management.Automation.AliasInfo

Lorsque vous utilisez le paramètre PassThru , Set-Alias génère un objet System.Management.Automation.AliasInfo représentant l’alias. Sinon, Set-Alias ne génère aucune sortie.

Notes

PowerShell inclut des alias intégrés qui sont disponibles dans chaque session PowerShell. L’applet Get-Alias de commande affiche les alias disponibles dans une session PowerShell.

Pour créer un alias, utilisez les applets Set-Alias de commande ou New-Alias. Dans PowerShell 6, pour supprimer un alias, utilisez l’applet de Remove-Alias commande. Remove-Item est accepté pour la compatibilité descendante, comme pour les scripts créés avec des versions antérieures de PowerShell. Utilisez une commande telle que Remove-Item -Path Alias:aliasname.

Pour créer un alias disponible dans chaque session PowerShell, ajoutez-le à votre profil PowerShell. Pour plus d’informations, consultez about_Profiles.

Un alias peut être enregistré et réutilisé dans une autre session PowerShell en effectuant une exportation et une importation. Pour enregistrer un alias dans un fichier, utilisez Export-Alias. Pour ajouter un alias enregistré à une nouvelle session PowerShell, utilisez Import-Alias.

Liens associés

• about_Aliases
• about_Functions
• about_Profiles
• about_Scopes
• Export-Alias
• Get-Alias
• Import-Alias
• New-Alias
• Remove-Alias
• Remove-Item