Freigeben über

Set-Alias

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Erstellt oder ändert einen Alias für ein Cmdlet oder einen anderen Befehl in der aktuellen PowerShell-Sitzung.

Syntax

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

Beschreibung

Das Set-Alias Cmdlet erstellt oder ändert einen Alias für ein Cmdlet oder einen Befehl, z. B. eine Funktion, ein Skript, eine Datei oder eine andere ausführbare Datei. Ein Alias ist ein alternativer Name, der sich auf ein Cmdlet oder einen Befehl bezieht. Beispielsweise sal ist der Alias für das Set-Alias Cmdlet. Weitere Informationen finden Sie unter about_Aliases.

Ein Cmdlet kann mehrere Aliase aufweisen, aber ein Alias kann nur einem Cmdlet zugeordnet werden. Sie können verwenden Set-Alias , um einen vorhandenen Alias einem anderen Cmdlet neu zuzuweisen oder die Eigenschaften eines Alias zu ändern, z. B. die Beschreibung.

Ein Alias, der von Set-Alias erstellt oder geändert wird, ist nicht dauerhaft und nur während der aktuellen PowerShell-Sitzung verfügbar. Wenn die PowerShell-Sitzung geschlossen wird, wird der Alias entfernt.

Beispiele

Beispiel 1: Create eines Alias für ein Cmdlet

Dieser Befehl erstellt einen Alias für ein Cmdlet in der aktuellen PowerShell-Sitzung.

PS> Set-Alias -Name list -Value Get-ChildItem

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-ChildItem

Das Set-Alias Cmdlet erstellt einen Alias in der aktuellen PowerShell-Sitzung. Der Parameter Name gibt den Namen des Alias an. list Der Parameter Value gibt das Cmdlet an, das vom Alias ausgeführt wird.

Um den Alias auszuführen, geben Sie in der PowerShell-Befehlszeile ein list .

Beispiel 2: Erneutes Zuweisen eines vorhandenen Alias zu einem anderen Cmdlet

Mit diesem Befehl wird ein vorhandener Alias neu zugewiesen, um ein anderes Cmdlet auszuführen.

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-ChildItem

PS> Set-Alias -Name list -Value Get-Location

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-Location

Das Get-Alias Cmdlet verwendet den Parameter Name , um den list Alias anzuzeigen. Der list Alias ist dem Get-ChildItem Cmdlet zugeordnet. Wenn der list Alias ausgeführt wird, werden die Elemente im aktuellen Verzeichnis angezeigt.

Das Set-Alias Cmdlet verwendet den Parameter Name , um den list Alias anzugeben. Der Value-Parameter ordnet den Alias dem Get-Location Cmdlet zu.

Das Get-Alias Cmdlet verwendet den Parameter Name , um den list Alias anzuzeigen. Der list Alias ist dem Get-Location Cmdlet zugeordnet. Wenn der list Alias ausgeführt wird, wird der Speicherort des aktuellen Verzeichnisses angezeigt.

Beispiel 3: Create und Ändern eines schreibgeschützten Alias

Dieser Befehl erstellt einen schreibgeschützten Alias. Die schreibgeschützte Option verhindert unbeabsichtigte Änderungen an einem Alias. Verwenden Sie den Force-Parameter , um einen schreibgeschützten Alias zu ändern oder zu löschen.

PS> Set-Alias -Name loc -Value Get-Location -Option ReadOnly -PassThru | Format-List -Property *

DisplayName         : loc -> Get-Location
Definition          : Get-Location
Options             : ReadOnly
Description         :
Name                : loc
CommandType         : Alias

PS> Set-Alias -Name loc -Value Get-Location -Option ReadOnly -Description 'Displays the current directory' -Force -PassThru | Format-List -Property *

DisplayName         : loc -> Get-Location
Definition          : Get-Location
Options             : ReadOnly
Description         : Displays the current directory
Name                : loc
CommandType         : Alias

Das Set-Alias Cmdlet erstellt einen Alias in der aktuellen PowerShell-Sitzung. Der Parameter Name gibt den Namen des Alias an. loc Der Parameter Value gibt das Get-Location Cmdlet an, das vom Alias ausgeführt wird. Der Parameter Option gibt den Wert ReadOnly an. Der PassThru-Parameter stellt das Aliasobjekt dar und sendet das Objekt in der Pipeline an das Format-List Cmdlet. Format-List verwendet den Property-Parameter mit einem Sternchen (*), damit alle Eigenschaften angezeigt werden. Die Beispielausgabe zeigt eine partielle Liste dieser Eigenschaften.

Der loc Alias wird durch hinzufügen von zwei Parametern geändert. Description fügt Text hinzu, um den Zweck des Alias zu erläutern. Der Force-Parameter ist erforderlich, da der loc Alias schreibgeschützt ist. Wenn der Force-Parameter nicht verwendet wird, schlägt die Änderung fehl.

Beispiel 4: Create eines Alias zu einer ausführbaren Datei

In diesem Beispiel wird ein Alias für eine ausführbare Datei auf dem lokalen Computer erstellt.

PS> Set-Alias -Name np -Value C:\Windows\notepad.exe

PS> Get-Alias -Name np

CommandType     Name
-----------     ----
Alias           np -> notepad.exe

Das Set-Alias Cmdlet erstellt einen Alias in der aktuellen PowerShell-Sitzung. Der Parameter Name gibt den Namen des Alias an. np Der Parameter Value gibt den Pfad und den Anwendungsnamen C:\Windows\notepad.exean. Das Get-Alias Cmdlet verwendet den Parameter Name , um anzuzeigen, dass der np Alias notepad.exezugeordnet ist.

Um den Alias auszuführen, geben Sie np in der PowerShell-Befehlszeile ein, um notepad.exezu öffnen.

Beispiel 5: Create eines Alias für einen Befehl mit Parametern

In diesem Beispiel wird gezeigt, wie Einem Befehl mit Parametern ein Alias zugewiesen wird.

Sie können einen Alias für ein Cmdlet erstellen, z Set-Location. B. . Sie können keinen Alias für einen Befehl mit Parametern und Werten erstellen, z Set-Location -Path C:\Windows\System32. B. . Um einen Alias für einen Befehl zu erstellen, erstellen Sie eine Funktion, die den Befehl enthält, und erstellen dann einen Alias für die Funktion. Weitere Informationen finden Sie unter about_Functions.

PS> Function CD32 {Set-Location -Path C:\Windows\System32}

PS> Set-Alias -Name Go -Value CD32

Eine Funktion mit dem Namen CD32 wird erstellt. Die Funktion verwendet das Set-Location Cmdlet mit dem Path-Parameter , um das Verzeichnis C:\Windows\System32 anzugeben.

Das Set-Alias Cmdlet erstellt einen Alias für die Funktion in der aktuellen PowerShell-Sitzung. Der Parameter Name gibt den Namen des Alias an. Go Der Parameter Value gibt den Namen der Funktion an. CD32

Um den Alias auszuführen, geben Sie in der PowerShell-Befehlszeile ein Go . Die CD32 Funktion wird ausgeführt und ändert sich in das Verzeichnis C:\Windows\System32.

Parameter

-Confirm

Hiermit werden Sie vor der Ausführung des Cmdlets zur Bestätigung aufgefordert.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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 einfache Anführungszeichen ein.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Verwenden Sie den Force-Parameter , um einen Alias zu ändern oder zu löschen, für den der Parameter Option auf ReadOnly festgelegt ist.

Der Force-Parameter kann einen Alias nicht ändern oder löschen, bei dem der Option-Parameter auf Constant festgelegt ist.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Gibt den Namen eines neuen Alias an. Ein Aliasname kann alphanumerische Zeichen und Bindestriche enthalten. Aliasnamen dürfen nicht numerisch sein, z. B. 123.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Option

Legt den Wert der Option-Eigenschaft des Alias fest. Werte wie ReadOnly und Constant schützen einen Alias vor unbeabsichtigten Änderungen. Um die Option-Eigenschaft aller Aliase in der Sitzung anzuzeigen, geben Sie ein Get-Alias | Format-Table -Property Name, Options -Autosize.

Die zulässigen Werte für diesen Parameter sind wie folgt:

  • AllScope Der Alias wird in alle neuen Bereiche kopiert, die erstellt werden.
  • Konstante Kann nicht geändert oder gelöscht werden.
  • Nichts Legt keine Optionen fest und ist die Standardeinstellung.
  • Privat Der Alias ist nur im aktuellen Bereich verfügbar.
  • Readonly Kann nur geändert oder gelöscht werden, wenn der Force-Parameter verwendet wird.
  • Nicht angegeben
Type:ScopedItemOptions
Accepted values:AllScope, Constant, None, Private, ReadOnly, Unspecified
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Gibt ein Objekt zurück, das den Alias darstellt. Verwenden Sie ein Format-Cmdlet, z Format-List . B. zum Anzeigen des Objekts. Standardmäßig Set-Alias generiert keine Ausgabe.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

Gibt den Bereich an, in dem dieser Alias gültig ist. Der Standardwert ist Local. Weitere Informationen finden Sie unter about_Scopes.

Die zulässigen Werte sind wie folgt:

  • Global
  • Lokal
  • Privat
  • Nummerierte Bereiche
  • Skript
Type:String
Accepted values:Global, Local, Private, Numbered scopes, Script
Position:Named
Default value:Local
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Value

Gibt den Namen des Cmdlets oder Befehls an, das vom Alias ausgeführt wird. Der Value-Parameter ist die Definition-Eigenschaft des Alias.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

None

Set-Alias akzeptiert keine Eingaben aus der Pipeline.

Ausgaben

None or System.Management.Automation.AliasInfo

Wenn Sie den PassThru-Parameter verwenden, generiert ein System.Management.Automation.AliasInfo-Objekt, Set-Alias das den Alias darstellt. Set-Alias Andernfalls generiert keine Ausgabe.

Hinweise

PowerShell enthält integrierte Aliase, die in jeder PowerShell-Sitzung verfügbar sind. Das Get-Alias Cmdlet zeigt die in einer PowerShell-Sitzung verfügbaren Aliase an.

Verwenden Sie zum Erstellen eines Alias die Cmdlets Set-Alias oder New-Alias. Verwenden Sie Remove-Alias in PowerShell 6 das Cmdlet, um einen Alias zu löschen. Remove-Item wird aus Gründen der Abwärtskompatibilität akzeptiert, z. B. für Skripts, die mit früheren Versionen von PowerShell erstellt wurden. Verwenden Sie einen Befehl wie Remove-Item -Path Alias:aliasname.

Um einen Alias zu erstellen, der in jeder PowerShell-Sitzung verfügbar ist, fügen Sie ihn Ihrem PowerShell-Profil hinzu. Weitere Informationen finden Sie unter about_Profiles.

Ein Alias kann gespeichert und in einer anderen PowerShell-Sitzung wiederverwendet werden, indem ein Export- und Importvorgang erfolgt. Um einen Alias in einer Datei zu speichern, verwenden Sie Export-Alias. Um einer neuen PowerShell-Sitzung einen gespeicherten Alias hinzuzufügen, verwenden Sie Import-Alias.