Set-Alias

Erstellt oder ändert einen Alias (alternativer Name) für ein Cmdlet oder anderes Befehlselement in der aktuellen Windows PowerShell-Sitzung.

Syntax

Set-Alias [-Name] <string> [-Value] <string> [-Beschreibung <string>] [-Force] [-Option {<None> | <ReadOnly> | <Constant> | <Private> | <AllScope>}] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

Beschreibung

Das Cmdlet "Set-Alias" erstellt oder ändert einen Alias (alternativer Name) für ein Cmdlet oder ein Befehlselement, z. B. eine Funktion, ein Skript, eine Datei oder ausführbare Datei. Mit Set-Alias können Sie auch einem neuen Befehl einen aktuellen Alias neu zuweisen oder Eigenschaften eines Alias, z. B. seine Beschreibung, ändern. Die Änderungen an einem Alias gehen verloren, wenn Sie die Sitzung beenden oder Windows PowerShell schließen, es sei denn, Sie fügen dem Windows PowerShell-Profil den Alias hinzu.

Parameter

-Beschreibung <string>

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.

Erforderlich?	false
Position?	named
Standardwert
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Force

Ermöglicht es dem Cmdlet, einen schreibgeschützten Alias festzulegen. Verwenden Sie den Option-Parameter, um einen schreibgeschützten Alias zu erstellen. Der Force-Parameter kann keinen konstanten Alias festlegen.

Erforderlich?	false
Position?	named
Standardwert
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Name <string>

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

Erforderlich?	true
Position?	1
Standardwert
Pipelineeingaben akzeptieren?	true (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-Option <ScopedItemOptions>

Legt den Wert der Options-Eigenschaft des Alias fest.

Gültige Werte:

– None: Legt keine Optionen fest. (Standardwert).

– ReadOnly: Die Eigenschaften des Alias können nicht geändert werden, außer bei Verwendung des Force-Parameters. Mit "Remove-Item" können Sie den Alias löschen.

– Constant: Der Alias kann nicht gelöscht und seine Eigenschaften können nicht geändert werden. "Constant" ist nur verfügbar, wenn Sie einen Alias erstellen. Sie können die Option eines vorhandenen Alias nicht in "Constant" ändern.

– Private: Der Alias ist nur in dem vom Scope-Parameter angegebenen Bereich verfügbar. In allen anderen Bereichen ist er nicht sichtbar.

– AllScope: Der Alias wird in alle neuen Bereiche kopiert, die erstellt werden.

Um die Options-Eigenschaft der Aliase anzuzeigen, geben Sie "Get-Alias | Format-Table -property Name, Definition, Options -autosize" ein.

Erforderlich?	false
Position?	named
Standardwert
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-PassThru

Gibt ein Objekt zurück, das den Alias darstellt. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.

Erforderlich?	false
Position?	named
Standardwert
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Scope <string>

Gibt den Gültigkeitsbereich dieses Alias an. Gültige Werte sind "global", "local", "script", oder eine Zahl in Bezug auf den aktuellen Bereich (0 bis zur Anzahl der Bereiche, wobei 0 der aktuelle Bereich und 1 der übergeordnete Bereich ist). Der Standardwert ist "local". Weitere Informationen finden Sie unter "about_Scopes".

Erforderlich?	false
Position?	named
Standardwert
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-Value <string>

Gibt den Namen des Cmdlets oder Befehlselements an, für das ein Alias festgelegt wird.

Erforderlich?	true
Position?	2
Standardwert
Pipelineeingaben akzeptieren?	true (ByPropertyName)
Platzhalterzeichen akzeptieren?	false

-Confirm

Fordert Sie vor der Ausführung des Befehls zur Bestätigung auf.

Erforderlich?	false
Position?	named
Standardwert
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

-WhatIf

Beschreibt die Auswirkungen einer Ausführung des Befehls, ohne den Befehl tatsächlich auszuführen.

Erforderlich?	false
Position?	named
Standardwert
Pipelineeingaben akzeptieren?	false
Platzhalterzeichen akzeptieren?	false

<CommonParameters>

Dieses Cmdlet unterstützt die folgenden allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer und -OutVariable. Weitere Informationen finden Sie unter about_Commonparameters.

Eingaben und Ausgaben

Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können. Der Rückgabetyp ist der Typ der Objekte, die das Cmdlet zurückgibt.

Eingaben	Keiner Eingaben können nicht über die Pipeline an dieses Cmdlet übergeben werden.
Ausgaben	Keiner oder System.Management.Automation.AliasInfo Wenn Sie den PassThru-Parameter verwenden, generiert Set-Alias ein System.Management.Automation.AliasInfo-Objekt, das den Alias darstellt. Andernfalls wird von diesem Cmdlet keine Ausgabe generiert.

Hinweise

Aliase sind alternative Namen oder Kurzbezeichnungen für Cmdlets oder Befehlselemente. Um das Cmdlet auszuführen, können Sie den vollständigen Namen oder einen beliebigen gültigen Alias verwenden. Weitere Informationen finden Sie unter "about_Aliases".

Um einen neuen Alias zu erstellen, verwenden Sie Set-Alias oder New-Alias. Um einen Alias zu löschen, verwenden Sie Remove-Item.

Ein Cmdlet kann über mehrere Aliase verfügen, doch kann einem Cmdlet immer nur ein einziger Alias zugeordnet sein. Wenn Sie einen Alias mit set-alias einem anderen Cmdlet zuordnen, ist er nicht mehr dem ursprünglichen Cmdlet zugeordnet.

Sie können einen Alias für ein Cmdlet erstellen, doch können Sie keinen Alias für einen Befehl mit Parametern und Werten erstellen. Beispielsweise können Sie einen Alias für Set-Location, jedoch keinen Alias für "Set-Location C:\Windows\System32" erstellen. Um einen Alias für einen Befehl zu erstellen, erstellen Sie eine Funktion, die den Befehl enthält, und erstellen Sie anschließend einen Alias für die Funktion.

Um die Aliase aus einer Sitzung zu speichern und in einer anderen Sitzung zu verwenden, fügen Sie dem Windows PowerShell-Profil den Befehl "set-alias" hinzu. Profile sind nicht standardmäßig vorhanden. Um ein Profil in dem Pfad zu erstellen, der in der Variablen "$profile" gespeichert ist, geben Sie "New-Item -type file -force $profile" ein. Um den Wert der Variablen "$profile" anzuzeigen, geben Sie "$profile" ein.

Sie können die Aliase auch speichern, indem Sie mit Export-Alias die Aliase aus der Sitzung in eine Datei kopieren und sie dann mit Import-Alias der Aliasliste für eine neue Sitzung hinzufügen.

Sie können auch über den integrierten Alias "sal" auf Set-Alias verweisen. Weitere Informationen finden Sie unter "about_Aliases".

Beispiel 1

C:\PS>set-alias -name list -value get-childitem

Beschreibung
-----------
Mit diesem Befehl wird der Alias "list" für das Cmdlet "Get-ChildItem" erstellt. Nachdem Sie den Alias erstellt haben, können Sie in der Befehlszeile und in Skripts "list" anstelle von Get-ChildItem verwenden.

Beispiel 2

C:\PS>set-alias list get-location

Beschreibung
-----------
Mit diesem Befehl wird dem Cmdlet "Get-Location" der Alias "list" zugeordnet. Wenn "list" bereits ein Alias für ein anderes Cmdlet ist, wird mit dem Befehl die Zuordnung geändert, sodass "list" jetzt nur der Alias für Get-Location ist.

Dieser Befehl verfügt über dasselbe Format wie der Befehl im vorherigen Beispiel, doch er enthält nicht die optionalen Parameternamen "-Name" und "-Value". Wenn Sie Parameternamen auslassen, müssen die Werte dieser Parameter in der angegebenen Reihenfolge im Befehl angegeben werden. In diesem Fall muss der Wert von "-Name" ("list") der erste Parameter und der Wert von "-Value" ("get-location") der zweite Parameter sein.

Beispiel 3

C:\PS>set-alias scrub remove-item -option readonly -passthru | format-list

Beschreibung
-----------
Mit diesem Befehl wird dem Cmdlet "Remove-Item" der Alias "scrub" zugeordnet. Mit der Option "ReadOnly" wird verhindert, dass der Alias gelöscht oder einem anderen Cmdlet zugewiesen wird.

Der PassThru-Parameter legt fest, dass Windows PowerShell ein Objekt, das den neuen Alias darstellt, über die Pipeline an das Cmdlet "Format-List" übergibt. Wenn der PassThru-Parameter ausgelassen wird, ist keine Ausgabe von diesem Cmdlet zum Anzeigen vorhanden (weder in einer Liste noch in einem anderen Format).

Beispiel 4

C:\PS>Set-Alias np c:\windows\notepad.exe

Beschreibung
-----------
Mit diesem Befehl wird der ausführbaren Datei für Editor der Alias "np" zugeordnet. Nachdem der Befehl ausgeführt wurde, geben Sie einfach "np" ein, um Editor über die Windows PowerShell-Befehlszeile zu öffnen.

Mit diesem Beispiel wird veranschaulicht, dass Sie Aliase für ausführbare Dateien und andere Elemente erstellen können, bei denen es sich nicht um Cmdlets handelt.

Um den Befehl in einen allgemeineren Befehl zu ändern, können Sie mithilfe der Umgebungsvariablen "Windir" ("${env:windir}") das Verzeichnis "C:\Windows" darstellen. Die allgemeine Version des Befehls lautet "set-alias np ${env:windir}\notepad.exe".

Beispiel 5

C:\PS>function CD32 {set-location c:\windows\system32}

C:\PS>set-alias go cd32

Beschreibung
-----------
Mit diesen Befehlen wird gezeigt, wie einem Befehl mit Parametern oder sogar einer Pipeline mit vielen Befehlen ein Alias zugewiesen wird.

Sie können einen Alias für ein Cmdlet erstellen, doch können Sie keinen Alias für einen Befehl erstellen, der aus einem Cmdlet und seinen Parametern besteht. Jedoch können Sie den Befehl in eine Funktion oder ein Skript einfügen. Anschließend können Sie einen sinnvollen Funktions- oder Skriptnamen festlegen und einen oder mehrere Aliase für die Funktion bzw. das Skript erstellen.

In diesem Beispiel möchte der Benutzer einen Alias für den Befehl "set-location c:\windows\system32" erstellen, wobei set-location ein Cmdlet und "C:\Windows\System32" der Wert des Path-Parameters ist. 

Hierzu wird im ersten Befehl die Funktion "CD32" erstellt, die den Befehl "Set-Location" enthält.

Im zweiten Befehl wird der Alias "go" für die Funktion "CD32" erstellt. Um den Befehl "Set-Location" auszuführen, kann der Benutzer dann "CD32" oder "go" eingeben.

Siehe auch

Konzepte

Get-Alias
New-Alias
Export-Alias
Import-Alias