Partager via


New-Alias

Crée un alias.

Syntaxe

Default (Par défaut)

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

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 commande Get-ChildItem. Il crée une description de « Alias gci rapide » 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]…}

La commande Get-Alias redirigée vers Format-List affiche 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 .. pour appeler la fonction Set-ParentDirectory. É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 .. remplace l’emplacement actuel par le répertoire parent.

Paramètres

-Confirm

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

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:cf

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Force

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

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Option

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

  • None: l’alias n’a aucune contrainte (valeur par défaut)
  • ReadOnly: l’alias peut être supprimé, mais ne peut pas être modifié, sauf à l’aide 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 complétion par tabulation pour les valeurs.

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

Propriétés du paramètre

Type:ScopedItemOptions
Valeur par défaut:[System.Management.Automation.ScopedItemOptions]::None
Valeurs acceptées:None, ReadOnly, Constant, Private, AllScope, Unspecified
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Value

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

Propriétés du paramètre

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:1
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

Propriétés du paramètre

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False
Alias:Wi

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

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 renvoie un objet AliasInfo représentant le nouvel alias.

Notes

PowerShell inclut les alias suivants pour New-Alias:

  • Toutes les plateformes :

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