Partager via

New-Alias

  • Référence
Module:
Microsoft.PowerShell.Utility

Crée un alias.

Syntaxe

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

Description

L’applet de commande New-Alias crée un alias dans la session PowerShell actuelle. Les alias créés à l’aide de New-Alias ne sont pas enregistrés après avoir quitté la session ou fermé PowerShell. Vous pouvez utiliser l’applet de commande Export-Alias pour enregistrer vos informations d’alias dans un fichier. Vous pouvez utiliser ultérieurement Import-Alias pour récupérer ces informations d’alias enregistrées.

Exemples

Exemple 1 : Créer un alias pour une applet de commande

PS C:\> New-Alias -Name "List" Get-ChildItem

Cette commande crée un alias nommé List pour représenter l’applet de commande Get-ChildItem.

Exemple 2 : Créer un alias en lecture seule pour une applet de commande

PS C:\> New-Alias -Name "W" -Value Get-WmiObject -Description "quick wmi alias" -Option ReadOnly
PS C:\> Get-Alias -Name "W" | Format-List *

Cette commande crée un alias nommé W pour représenter l’applet de commande Get-WmiObject. Il crée une description, un alias wmi rapide, pour l’alias et le rend en lecture seule. La dernière ligne de la commande utilise Get-Alias pour obtenir le nouvel alias et le canaliser vers Format-List pour afficher toutes les informations à son sujet.

Paramètres

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Description

Spécifie une description de l’alias. Vous pouvez taper n’importe quelle chaîne. Si la description inclut des espaces, placez-la entre guillemets.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Force

Indique que l’applet de commande agit comme Set-Alias si l’alias nommé existe déjà.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Name

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

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Option

Spécifie la valeur de la propriété options de l’alias. Les valeurs valides sont les suivantes :

  • Aucun : l’alias n’a aucune contrainte (valeur par défaut)
  • ReadOnly : l’alias peut être supprimé, mais ne peut pas être modifié à l’aide du paramètre force
  • Constante : l’alias ne peut pas être supprimé ou modifié
  • Privé : l’alias est disponible uniquement dans l’étendue actuelle
  • AllScope : l’alias est copié dans toutes les nouvelles étendues créées
  • Non spécifié : l’option n’est pas spécifiée

Pour afficher la propriété options de tous les alias de la session, tapez Get-Alias | Format-Table -Property Name, Options -AutoSize.

Type:ScopedItemOptions
Valeurs acceptées:None, ReadOnly, Constant, Private, AllScope, Unspecified
Position:Named
Valeur par défaut:[System.Management.Automation.ScopedItemOptions]::None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PassThru

Retourne un objet représentant l’élément avec lequel vous travaillez. Par défaut, cette applet de commande ne génère aucune sortie.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Scope

Spécifie l’étendue du nouvel alias. Les valeurs acceptables pour ce paramètre sont les suivantes :

  • Global
  • Local
  • Script
  • Nombre relatif à l’étendue actuelle (0 au nombre d’étendues, où 0 est l’étendue actuelle et 1 est son parent).

Local est la valeur par défaut. Pour plus d’informations, consultez about_Scopes.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Value

Spécifie le nom de l’applet de commande ou de l’élément de commande en cours d’alias.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

None

Vous ne pouvez pas diriger l’entrée vers cette applet de commande.

Sorties

None or System.Management.Automation.AliasInfo

Lorsque vous utilisez le paramètre Passthru, New-Alias génère un objet System.Management.Automation.AliasInfo représentant le nouvel alias. Sinon, cette applet de commande ne génère aucune sortie.

Notes

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