Set-Alias
Vytvoří nebo změní alias pro rutinu nebo jiný příkaz v aktuální relaci PowerShellu.
Syntax
Default (Výchozí)
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. Například sal je alias pro rutinu Set-Alias. Další informace viz about_Aliases.
Rutina může mít více aliasů, ale alias může být přidružený pouze k jedné rutině. Pomocí Set-Alias můžete změnit přiřazení existujícího aliasu k jiné rutině nebo změnit vlastnosti aliasu, například popis.
Alias vytvořený nebo změněný Set-Alias není trvalý a je dostupný jenom 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 aliasu list. 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 parametr list. 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á parametr Name k určení aliasu list. Parametr Value přidruží alias k rutině Get-Location.
Rutina Get-Alias používá k zobrazení aliasu parametr list. 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 aliasu loc. Parametr Value určuje Get-Location rutinu, kterou alias spouští. Parametr Option určuje hodnotu ReadOnly. Parametr PassThru představuje objekt aliasu a odešle objekt dolů kanálu do rutiny Format-List.
Format-List používá parametr vlastnosti 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 alias loc 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 aliasu np. Parametr Hodnota určuje cestu a název aplikace C:\Windows\notepad.exe. Rutina Get-Alias používá parametr Name k zobrazení, že np alias je přidružený k notepad.exe.
Pokud chcete alias spustit, zadejte np na příkazovém řádku PowerShellu a otevřete 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. Nemůžete vytvořit alias pro příkaz s parametry a hodnotami, 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 funkce s názvem CD32. 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 aliasu Go. Parametr Value určuje název funkce CD32.
Pokud chcete alias spustit, zadejte Go na příkazovém řádku PowerShellu. Funkce CD32 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 už by měl existovat. Po spuštění příkazu se alias nedá změnit bez použití parametru Force a je dostupný jenom v aktuálním oboru.
Parametry
-Confirm
Před spuštěním cmdletu vás vyzve k potvrzení.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | viz |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Description
Určuje popis aliasu. Můžete zadat libovolný řetězec. Pokud popis obsahuje mezery, uzavřete ho do jednoduchých uvozovek.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Force
Pomocí parametru Force změňte nebo odstraňte alias s parametrem Option nastaveným na ReadOnly.
Parametr Force nemůže změnit nebo odstranit alias s parametrem Option nastaveným na konstantní.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | 0 |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-Option
Nastaví hodnotu vlastnosti Option aliasu. Hodnoty, jako jsou ReadOnly a Constant chrání alias před nezamýšlenými změnami. Pokud chcete 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– Nejde změnit ani odstranit, pokud se nepoužívá parametr vynucení. Unspecified
Tyto hodnoty jsou definovány jako výčtové hodnoty na bázi příznaků. 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. Cmdlet kombinuje hodnoty pomocí binární operace OR. Předání hodnot jako pole je nejjednodušší možností a také umožňuje využít automatické doplňování pomocí klávesy Tab pro hodnoty.
Vlastnosti parametru
| Typ: | ScopedItemOptions |
| Default value: | None |
| Přípustné hodnoty: | AllScope, Constant, None, Private, ReadOnly, Unspecified |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-PassThru
Vrátí objekt, který představuje alias. K zobrazení objektu použijte rutinu formátu, například Format-List. Ve výchozím nastavení Set-Alias negeneruje žádný výstup.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Scope
Určuje obor, ve které je tento alias platný. Výchozí hodnota je Místní. Další informace najdete v části about_Scopes.
Přijatelné hodnoty jsou následující:
GlobalLocalPrivateNumbered scopesScript
Vlastnosti parametru
| Typ: | String |
| Default value: | Local |
| Přípustné hodnoty: | Global, Local, Private, Numbered scopes, Script |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
-Value
Určuje název rutiny nebo příkazu, který alias spustí. Parametr Hodnota je vlastnost definice aliasu.
Vlastnosti parametru
| Typ: | String |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | 1 |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-WhatIf
Ukazuje, co se stane, když se příkaz spustí. Cmdlet se nespustil.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | Wi |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.
Vstupy
None
Do tohoto cmdletu nemůžete předávat 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
Windows PowerShell obsahuje následující aliasy pro Set-Alias:
sal
PowerShell obsahuje integrované aliasy, které jsou k dispozici v každé relaci PowerShellu. Rutina Get-Alias zobrazí aliasy dostupné v relaci PowerShellu.
Pokud chcete vytvořit nový alias, použijte Set-Alias nebo New-Alias. K odebrání aliasu použijte rutinu Remove-Item. 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. K uložení aliasu do souboru použijte Export-Alias. Pokud chcete přidat uložený alias do nové relace PowerShellu, použijte Import-Alias.
