Set-Alias

  • Reference
Modul:
Microsoft.PowerShell.Utility

Vytvoří nebo změní alias pro rutinu nebo jiný příkaz v aktuální relaci PowerShellu.

Syntax

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

Description

Rutina Set-Alias vytvoří nebo změní alias pro rutinu nebo příkaz, například funkci, skript, soubor nebo jiný spustitelný soubor. Alias je alternativní název, který odkazuje na rutinu nebo příkaz. Je to například sal alias pro rutinu Set-Alias . Další informace najdete v tématu about_Aliases.

Rutina může mít více aliasů, ale alias může být přidružený pouze k jedné rutině. Můžete použít Set-Alias k opětovnému přiřazení existujícího aliasu k jiné rutině nebo ke změně vlastností aliasu, jako je popis.

Alias vytvořený nebo změněný pomocí Set-Alias není trvalý a je k dispozici pouze během aktuální relace PowerShellu. Po zavření relace PowerShellu se alias odebere.

Příklady

Příklad 1: Vytvoření aliasu pro rutinu

Tento příkaz vytvoří alias pro rutinu v aktuální relaci PowerShellu.

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

PS> Get-Alias -Name list

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

Rutina Set-Alias vytvoří alias v aktuální relaci PowerShellu. Parametr Name určuje název listaliasu . Parametr Value určuje rutinu, která alias běží.

Pokud chcete alias spustit, zadejte list na příkazovém řádku PowerShellu.

Příklad 2: Změna přiřazení existujícího aliasu k jiné rutině

Tento příkaz znovu přiřazuje existující alias, aby se spustila jiná rutina.

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

Rutina Get-Alias používá k zobrazení aliasu list parametr Name. Alias list je přidružený k rutině Get-ChildItem . Při spuštění aliasu list se zobrazí položky v aktuálním adresáři.

Rutina Set-Alias používá k zadání aliasu list parametr Name. Parametr Value přidruží alias k rutině Get-Location .

Rutina Get-Alias používá k zobrazení aliasu list parametr Name. Alias list je přidružený k rutině Get-Location . Po spuštění aliasu list se zobrazí umístění aktuálního adresáře.

Příklad 3: Vytvoření a změna aliasu jen pro čtení

Tento příkaz vytvoří alias jen pro čtení. Možnost jen pro čtení zabraňuje nezamýšleným změnám aliasu. Pokud chcete změnit nebo odstranit alias jen pro čtení, použijte parametr Force .

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

Rutina Set-Alias vytvoří alias v aktuální relaci PowerShellu. Parametr Name určuje název localiasu . Parametr Value určuje rutinu Get-Location , která alias běží. Parametr Option určuje hodnotu ReadOnly . Parametr PassThru představuje objekt aliasu a odešle objekt dolů kanálu do rutiny Format-List . Format-Listpoužívá parametr Property s hvězdičkou (*), aby se zobrazila každá vlastnost. Příklad výstupu ukazuje částečný seznam těchto vlastností.

Alias loc se změní přidáním dvou parametrů. Popis přidá text, který vysvětluje účel aliasu. Parametr Force je potřeba, protože loc alias je jen pro čtení. Pokud se parametr Force nepoužívá, změna se nezdaří.

Příklad 4: Vytvoření aliasu pro spustitelný soubor

Tento příklad vytvoří alias spustitelného souboru v místním počítači.

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

PS> Get-Alias -Name np

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

Rutina Set-Alias vytvoří alias v aktuální relaci PowerShellu. Parametr Name určuje název npaliasu . Parametr Value určuje cestu a název C:\Windows\notepad.exeaplikace . Rutina Get-Alias používá parametr Name k zobrazení, že np alias je přidružen notepad.exe.

Pokud chcete alias spustit, zadejte np na příkazovém řádku PowerShellu, který se má otevřít notepad.exe.

Příklad 5: Vytvoření aliasu pro příkaz s parametry

Tento příklad ukazuje, jak přiřadit alias příkazu s parametry.

Můžete vytvořit alias pro rutinu, například Set-Location. Pro příkaz s parametry a hodnotami nemůžete vytvořit alias, například Set-Location -Path C:\Windows\System32. Pokud chcete vytvořit alias pro příkaz, vytvořte funkci, která tento příkaz obsahuje, a pak vytvořte alias funkce. Další informace najdete v tématu about_Functions.

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

Set-Alias -Name Go -Value CD32

Vytvoří se pojmenovaná CD32 funkce. Funkce používá rutinu Set-Location s parametrem Path k určení adresáře. C:\Windows\System32

Rutina Set-Alias vytvoří alias funkce v aktuální relaci PowerShellu. Parametr Name určuje název Goaliasu . Parametr Value určuje název funkce . CD32

Pokud chcete alias spustit, zadejte Go na příkazovém řádku PowerShellu. Funkce CD32 se spustí a změní adresář C:\Windows\System32.

Příklad 6: Možnosti aktualizace existujícího aliasu

Tento příklad ukazuje, jak přiřadit více možností pomocí parametru Option .

Pokračování v předchozím příkladu nastavte alias Go jako ReadOnly a Private.

Set-Alias -Name Go -Option ReadOnly, Private

Alias Go by už měl existovat. Po spuštění příkazu se alias nedá změnit bez použití parametru Force a je k dispozici pouze v aktuálním oboru.

Parametry

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

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

-Description

Určuje popis aliasu. Můžete zadat libovolný řetězec. Pokud popis obsahuje mezery, uzavřete ho do jednoduchých uvozovek.

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

-Force

Pomocí parametru Force můžete změnit nebo odstranit alias, který má parametr Option nastavený na ReadOnly.

Parametr Force nemůže změnit nebo odstranit alias s parametrem Option nastaveným na konstantu.

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

-Name

Určuje název nového aliasu. Název aliasu může obsahovat alfanumerické znaky a pomlčky. Názvy aliasů nemůžou být číselné, například 123.

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

-Option

Nastaví hodnotu vlastnosti Option aliasu. Hodnoty jako ReadOnly a Constant ochrana aliasu před nezamýšlenými změnami Chcete-li zobrazit vlastnost Option všech aliasů v relaci, zadejte Get-Alias | Format-Table -Property Name, Options -Autosize.

Přijatelné hodnoty pro tento parametr jsou následující:

  • AllScope – Alias se zkopíruje do všech nově vytvořených oborů.
  • Constant - Nejde změnit ani odstranit.
  • None – Nastaví žádné možnosti a je výchozí.
  • Private – Alias je k dispozici pouze v aktuálním oboru.
  • ReadOnly – Nelze změnit ani odstranit, pokud se nepoužívá parametr Force .
  • Unspecified

Tyto hodnoty jsou definovány jako výčet založený na příznaku. Pomocí tohoto parametru můžete zkombinovat více hodnot a nastavit více příznaků. Hodnoty lze předat parametru Option jako pole hodnot nebo jako řetězec oddělený čárkami těchto hodnot. Rutina kombinuje hodnoty pomocí operace binárního operátoru OR. Předání hodnot jako pole je nejjednodušší možností a také umožňuje použít pro hodnoty dokončování tabulátoru.

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

Vrátí objekt, který představuje alias. K zobrazení objektu použijte rutinu Format-List formátu. Ve výchozím nastavení Set-Alias nevygeneruje žádný výstup.

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

-Scope

Určuje obor, ve které je tento alias platný. Výchozí hodnota je Místní. Další informace najdete v tématu about_Scopes.

Přijatelné hodnoty jsou následující:

  • 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

Určuje název rutiny nebo příkazu, který alias spustí. Parametr Value je vlastnost Definition aliasu.

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

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina se nespustí.

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

Vstupy

None

Do této rutiny nemůžete roušit objekty.

Výstupy

None

Ve výchozím nastavení tato rutina nevrací žádný výstup.

AliasInfo

Pokud použijete parametr PassThru , vrátí tato rutina objekt AliasInfo představující alias.

Poznámky

PowerShell obsahuje následující aliasy pro Set-Alias:

  • Všechny platformy:
    • sal

PowerShell obsahuje integrované aliasy, které jsou k dispozici v každé relaci PowerShellu. Rutina Get-Alias zobrazí aliasy dostupné v relaci PowerShellu.

K vytvoření aliasu použijte rutiny Set-Alias nebo New-Alias. V PowerShellu 6 použijte rutinu k odstranění aliasu Remove-Alias . Remove-Item je přijata kvůli zpětné kompatibilitě, například pro skripty vytvořené s předchozími verzemi PowerShellu. Použijte příkaz, například Remove-Item -Path Alias:aliasname.

Pokud chcete vytvořit alias, který je k dispozici v každé relaci PowerShellu, přidejte ho do profilu PowerShellu. Další informace najdete v tématu about_Profiles.

Alias je možné uložit a znovu použít v jiné relaci PowerShellu provedením exportu a importu. Chcete-li uložit alias do souboru, použijte Export-Alias. Pokud chcete přidat uložený alias do nové relace PowerShellu, použijte Import-Alias.