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 New-Alias de commande crée un alias dans la session PowerShell actuelle. Les alias créés par l’utilisation New-Alias ne sont pas enregistrés après avoir quitté la session ou fermé PowerShell. Vous pouvez utiliser l’applet Export-Alias de commande 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

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

Cette commande crée un alias nommé C pour représenter l’applet de Get-ChildItem commande. Il crée une description de l’alias « quick gci » pour l’alias et le rend en lecture seule.

New-Alias -Name "C" -Value Get-ChildItem -Description "quick gci alias" -Option ReadOnly
Get-Alias -Name "C" | Format-List *

HelpUri             : https://go.microsoft.com/fwlink/?LinkID=2096492
ResolvedCommandName : Get-ChildItem
DisplayName         : C -> Get-ChildItem
ReferencedCommand   : Get-ChildItem
ResolvedCommand     : Get-ChildItem
Definition          : Get-ChildItem
Options             : ReadOnly
Description         : quick gci alias
OutputType          : {System.IO.FileInfo, System.IO.DirectoryInfo}
Name                : C
CommandType         : Alias
Source              :
Version             :
Visibility          : Public
ModuleName          :
Module              :
RemotingCapability  : PowerShell
Parameters          : {[Path, System.Management.Automation.ParameterMetadata], [LiteralPath,
                      System.Management.Automation.ParameterMetadata], [Filter,
                      System.Management.Automation.ParameterMetadata], [Include,
                      System.Management.Automation.ParameterMetadata]…}

Commande Get-Alias redirigée pour Format-List afficher toutes les informations sur le nouvel alias.

Exemple 3 : Créer un alias pour une commande avec des paramètres

function Set-ParentDirectory {Set-Location -Path ..}
New-Alias -Name .. -Value Set-ParentDirectory

La première commande crée la fonction Set-ParentDirectory, qui utilise Set-Location pour définir l’emplacement de travail sur le répertoire parent. La deuxième commande utilise New-Alias pour créer un alias de l’appel de .. la Set-ParentDirectory fonction. Étant donné que le paramètre Value nécessite une applet de commande, une fonction ou une valeur exécutable, vous devez créer une fonction personnalisée pour créer un alias qui utilise des paramètres. L’exécution de l’alias .. modifie l’emplacement actuel vers le répertoire parent.

Paramètres

-Confirm

Vous demande une confirmation 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 entrer n'importe quelle chaîne. Si la description inclut des espaces, mettez-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 autorisées sont :

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

Ces valeurs sont définies comme une énumération basée sur des indicateurs. Vous pouvez combiner plusieurs valeurs pour définir plusieurs indicateurs à l’aide de ce paramètre. Les valeurs peuvent être transmises au paramètre Option en tant que tableau de valeurs ou sous forme de chaîne séparées par des virgules de ces valeurs. L’applet de commande combine les valeurs à l’aide d’une opération binary-OR. La transmission de valeurs en tant que tableau est l’option la plus simple et vous permet également d’utiliser la saisie semi-automatique sous forme de tabulation sur les valeurs.

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 que vous utilisez. Par défaut, cette applet de commande ne génère aucun résultat.

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 valides pour ce paramètre sont :

  • Global
  • Local
  • Script
  • Nombre relatif à l’étendue actuelle (0 au nombre d’étendues, où 0 est l’étendue actuelle et 1 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'élément d'applet de commande ou de commande auquel est associé un 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

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
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 les objets vers cette applet de commande.

Sorties

None

Par défaut, cette applet de commande ne retourne aucune sortie.

AliasInfo

Lorsque vous utilisez le paramètre PassThru , cette applet de commande retourne un objet AliasInfo représentant le nouvel alias.

Notes

Windows PowerShell inclut les alias suivants pour New-Alias:

  • nal

  • 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.