Freigeben über

New-Alias

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Erstellt einen neuen Alias.

Syntax

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

Beschreibung

Das Cmdlet New-Alias erstellt einen neuen Alias in der aktuellen PowerShell-Sitzung. Aliase, die mithilfe von New-Alias erstellt wurden, werden nicht gespeichert, nachdem Sie die Sitzung beendet oder PowerShell geschlossen haben. Sie können das Cmdlet Export-Alias verwenden, um Ihre Aliasinformationen in einer Datei zu speichern. Sie können später Import-Alias verwenden, um diese gespeicherten Aliasinformationen abzurufen.

Beispiele

Beispiel 1: Erstellen eines Alias für ein Cmdlet

New-Alias -Name "List" Get-ChildItem

Mit diesem Befehl wird ein Alias namens "Liste" erstellt, der das cmdlet Get-ChildItem darstellt.

Beispiel 2: Erstellen eines schreibgeschützten Alias für ein Cmdlet

Mit diesem Befehl wird ein Alias namens C erstellt, der das cmdlet Get-ChildItem darstellt. Es erstellt eine Beschreibung von "quick gci alias" für den Alias und macht ihn schreibgeschützt.

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]…}

Der befehl Get-Alias, der an Format-List weitergeleitet wird, zeigt alle Informationen zum neuen Alias an.

Beispiel 3: Erstellen eines Alias für einen Befehl mit Parametern

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

Der erste Befehl erstellt die Funktion Set-ParentDirectory, die Set-Location verwendet, um den Arbeitsspeicherort auf das übergeordnete Verzeichnis festzulegen. Der zweite Befehl verwendet New-Alias, um einen Alias von .. zum Aufrufen der Set-ParentDirectory-Funktion zu erstellen. Da für den Parameter Value ein Cmdlet, eine Funktion oder ein ausführbarer Wert erforderlich ist, müssen Sie eine benutzerdefinierte Funktion erstellen, um einen Alias zu erstellen, der Parameter verwendet. Das Ausführen des Alias .. ändert den aktuellen Speicherort in das übergeordnete Verzeichnis.

Parameter

-Confirm

Fordert Sie vor dem Ausführen des Cmdlets zur Bestätigung auf.

Typ:SwitchParameter
Aliase:cf
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Description

Gibt eine Beschreibung des Alias an. Sie können eine beliebige Zeichenfolge eingeben. Wenn die Beschreibung Leerzeichen enthält, schließen Sie sie in Anführungszeichen ein.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Force

Gibt an, dass das Cmdlet wie Set-Alias fungiert, wenn der benannte Alias bereits vorhanden ist.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Name

Gibt den neuen Alias an. Sie können beliebige alphanumerische Zeichen in einem Alias verwenden, aber das erste Zeichen darf keine Zahl sein.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-Option

Gibt den Wert der Options -Eigenschaft des Alias an. Gültige Werte sind:

  • None: Der Alias hat keine Einschränkungen (Standardwert)
  • ReadOnly: Der Alias kann gelöscht werden, kann jedoch nicht geändert werden, außer mithilfe des Parameters Force
  • Constant: Der Alias kann nicht gelöscht oder geändert werden.
  • Private: Der Alias ist nur im aktuellen Bereich verfügbar.
  • AllScope: Der Alias wird in alle neuen Bereiche kopiert, die erstellt werden
  • Unspecified: Die Option ist nicht angegeben.

Diese Werte werden als flagbasierte Enumeration definiert. Sie können mehrere Werte kombinieren, um mehrere Flags mithilfe dieses Parameters festzulegen. Die Werte können als Array von Werten oder als kommagetrennte Zeichenfolge dieser Werte an den Option Parameter übergeben werden. Das Cmdlet kombiniert die Werte mithilfe eines Binary-OR-Vorgangs. Das Übergeben von Werten als Array ist die einfachste Option und ermöglicht ihnen auch die Verwendung des Tabstopps für die Werte.

Geben Sie Get-Alias | Format-Table -Property Name, Options -AutoSizeein, um die eigenschaft Options aller Aliase in der Sitzung anzuzeigen.

Typ:ScopedItemOptions
Zulässige Werte:None, ReadOnly, Constant, Private, AllScope, Unspecified
Position:Named
Standardwert:[System.Management.Automation.ScopedItemOptions]::None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PassThru

Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig generiert dieses Cmdlet keine Ausgabe.

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Scope

Gibt den Bereich des neuen Alias an. Die zulässigen Werte für diesen Parameter sind:

  • Global
  • Local
  • Script
  • Eine Zahl relativ zum aktuellen Bereich (0 bis zur Anzahl der Bereiche, wobei 0 der aktuelle Bereich ist und 1 das übergeordnete Element ist).

Local ist die Standardeinstellung. Weitere Informationen finden Sie unter about_Scopes.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Value

Gibt den Namen des Cmdlets oder Befehlselements an, das aliast wird.

Typ:String
Position:1
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Typ:SwitchParameter
Aliase:wi
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

None

Sie können keine Objekte an dieses Cmdlet weiterleiten.

Ausgaben

None

Standardmäßig gibt dieses Cmdlet keine Ausgabe zurück.

AliasInfo

Wenn Sie den PassThru--Parameter verwenden, gibt dieses Cmdlet ein AliasInfo- Objekt zurück, das den neuen Alias darstellt.

Hinweise

Windows PowerShell enthält die folgenden Aliase für New-Alias:

  • nal

  • Verwenden Sie zum Erstellen eines neuen Alias Set-Alias oder New-Alias. Verwenden Sie Set-Alias, um einen Alias zu ändern. Verwenden Sie Remove-Item, um einen Alias zu löschen.