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 auf ein Cmdlet oder einen Befehl verweist. Beispielsweise sal ist der Alias für das Set-Alias Cmdlet angegeben. Weitere Informationen finden Sie unter about_Aliases.

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

Ein Alias, der erstellt oder geändert wird Set-Alias , 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: Erstellen eines Alias für ein Cmdlet

Mit diesem Befehl wird ein Alias für ein Cmdlet in der aktuellen PowerShell-Sitzung erstellt.

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 Name-Parameter gibt den Namen des Alias an. list Der Parameter Value gibt das Cmdlet an, das vom Alias ausgeführt wird.

Geben Sie zum Ausführen des Alias list die PowerShell-Befehlszeile ein.

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: Erstellen und Ändern eines schreibgeschützten Alias

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

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

$Parameters = @{
    Name        =  'loc'
    Value       =  (Get-Location)
    Option      =  'ReadOnly'
    Description =  'Displays the current directory'
    Force       = $true
    PassThru    = $true
}
Set-Alias @Parameters | 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 Name-Parameter 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 ReadOnly-Wert an. Der PassThru-Parameter stellt das Aliasobjekt dar und sendet das Objekt an das Format-List Cmdlet. Format-List verwendet den Property-Parameter mit einem Sternchen (*), sodass jede Eigenschaft angezeigt wird. Die Beispielausgabe zeigt eine partielle Liste dieser Eigenschaften.

Der loc Alias wird mit dem Hinzufügen von zwei Parametern geändert. Beschreibung 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 Parameter Force nicht verwendet wird, schlägt die Änderung fehl.

Beispiel 4: Erstellen eines Alias für eine ausführbare 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 Name-Parameter 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 zugeordnet notepad.exeist.

Geben Sie zum Ausführen des Alias die PowerShell-Befehlszeile ein, np um den Alias zu öffnen notepad.exe.

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

In diesem Beispiel wird gezeigt, wie Sie einem Befehl mit Parametern einen Alias zuweisen.

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.

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

Set-Alias -Name Go -Value CD32

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

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

Geben Sie zum Ausführen des Alias Go die PowerShell-Befehlszeile ein. Die CD32 Funktion wird ausgeführt und ändert sich in das Verzeichnis C:\Windows\System32.

Beispiel 6: Aktualisieren von Optionen für einen vorhandenen Alias

In diesem Beispiel wird gezeigt, wie Sie mithilfe des Optionsparameters mehrere Optionen zuweisen.

Legen Sie im vorherigen Beispiel den Alias Go als ReadOnly und Private.

Set-Alias -Name Go -Option ReadOnly, Private

Der Alias Go sollte bereits vorhanden sein. Nach dem Ausführen des Befehls kann der Alias nicht geändert werden, ohne den Parameter Force zu verwenden und ist nur im aktuellen Bereich verfügbar.

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 Parameter Force , um einen Alias zu ändern oder zu löschen, der den Parameter Option auf ReadOnly festgelegt hat.

Der Force-Parameter kann einen Alias nicht ändern oder löschen, wobei der Option-Parameter auf "Konstant" 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 können 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, z ReadOnly . B. einen Constant Alias vor unbeabsichtigten Änderungen schützen. Wenn Sie die Option-Eigenschaft aller Aliase in der Sitzung anzeigen möchten, geben Sie folgendes 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.
  • Constant - Kann nicht geändert oder gelöscht werden.
  • None - Legt keine Optionen fest und ist der Standardwert.
  • Private – Der Alias ist nur im aktuellen Bereich verfügbar.
  • ReadOnly - Kann nicht geändert oder gelöscht werden, es sei denn, der Parameter Force wird verwendet.
  • Unspecified

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 Parameter Option übergeben werden. Das Cmdlet kombiniert die Werte mit einem binär-OR-Vorgang. Das Übergeben von Werten als Array ist die einfachste Option und ermöglicht ihnen auch die Verwendung des Tabstopps für die Werte.

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. Generiert standardmäßig Set-Alias 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 "Lokal". Weitere Informationen finden Sie unter about_Scopes.

Die zulässigen Werte sind wie folgt:

  • Global
  • Local
  • Private
  • Numbered scopes
  • Script
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

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

Hinweise

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

  • Alle Plattformen:
    • sal

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

Verwenden Sie zum Erstellen eines Alias die Cmdlets Set-Alias oder New-Alias. Verwenden Sie in PowerShell 6 zum Löschen eines Alias das Remove-Alias Cmdlet. Remove-Item wird für 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:aliasnamez. B. .

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 in einer anderen PowerShell-Sitzung gespeichert und wiederverwendet werden, indem ein Export- und Importvorgang erfolgt. Um einen Alias in einer Datei zu speichern, verwenden Sie Export-Alias. Verwenden Sie die Verwendung Import-Alias, um einer neuen PowerShell-Sitzung einen gespeicherten Alias hinzuzufügen.