Set-Alias

Moduł:

Microsoft.PowerShell.Utility

Tworzy lub zmienia alias polecenia cmdlet lub innego polecenia w bieżącej sesji programu PowerShell.

Składnia

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

Opis

Polecenie cmdlet Set-Alias tworzy lub zmienia alias polecenia cmdlet lub polecenia, takiego jak funkcja, skrypt, plik lub inny plik wykonywalny. Alias to alternatywna nazwa, która odwołuje się do polecenia cmdlet lub polecenia. Na przykład sal jest aliasem polecenia cmdlet Set-Alias. Aby uzyskać więcej informacji, zobacz about_Aliases.

Polecenie cmdlet może mieć wiele aliasów, ale alias może być skojarzony tylko z jednym poleceniem cmdlet. Możesz użyć Set-Alias, aby ponownie przypisać istniejący alias do innego polecenia cmdlet lub zmienić właściwości aliasu, takie jak opis.

Alias utworzony lub zmieniony przez Set-Alias nie jest trwały i jest dostępny tylko podczas bieżącej sesji programu PowerShell. Po zamknięciu sesji programu PowerShell alias zostanie usunięty.

Przykłady

Przykład 1. Tworzenie aliasu dla polecenia cmdlet

To polecenie tworzy alias polecenia cmdlet w bieżącej sesji programu PowerShell.

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

PS> Get-Alias -Name list

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

Polecenie cmdlet Set-Alias tworzy alias w bieżącej sesji programu PowerShell. Parametr Name określa nazwę aliasu, list. Parametr Value określa polecenie cmdlet uruchamiane przez alias.

Aby uruchomić alias, wpisz list w wierszu polecenia programu PowerShell.

Przykład 2. Ponowne przypisywanie istniejącego aliasu do innego polecenia cmdlet

To polecenie ponownie przypisuje istniejący alias, aby uruchomić inne polecenie cmdlet.

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

Polecenie cmdlet Get-Alias używa parametru nazwa do wyświetlania aliasu list. Alias list jest skojarzony z poleceniem cmdlet Get-ChildItem. Po uruchomieniu aliasu list zostaną wyświetlone elementy w bieżącym katalogu.

Polecenie cmdlet Set-Alias używa parametru Name w celu określenia aliasu list. Parametr Value kojarzy alias z poleceniem cmdlet Get-Location.

Polecenie cmdlet Get-Alias używa parametru nazwa do wyświetlania aliasu list. Alias list jest skojarzony z poleceniem cmdlet Get-Location. Po uruchomieniu aliasu list zostanie wyświetlona lokalizacja bieżącego katalogu.

Przykład 3. Tworzenie i zmienianie aliasu tylko do odczytu

To polecenie tworzy alias tylko do odczytu. Opcja tylko do odczytu uniemożliwia niezamierzone zmiany aliasu. Aby zmienić lub usunąć alias tylko do odczytu, użyj parametru 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

Polecenie cmdlet Set-Alias tworzy alias w bieżącej sesji programu PowerShell. Parametr Name określa nazwę aliasu, loc. Parametr Value określa polecenie cmdlet Get-Location uruchamiane przez alias. Parametr Option określa wartość ReadOnly. Parametr PassThru reprezentuje obiekt aliasu i wysyła obiekt w dół potoku do polecenia cmdlet Format-List. Format-List używa parametru property z gwiazdką (*), aby każda właściwość jest wyświetlana. Przykładowe dane wyjściowe zawierają częściową listę tych właściwości.

Alias loc jest zmieniany przy użyciu dodawania dwóch parametrów. Opis dodaje tekst w celu wyjaśnienia przeznaczenia aliasu. Wymagany jest parametr Force, ponieważ alias loc jest tylko do odczytu. Jeśli parametr Force nie jest używany, zmiana zakończy się niepowodzeniem.

Przykład 4. Tworzenie aliasu w pliku wykonywalnym

W tym przykładzie tworzony jest alias pliku wykonywalnego na komputerze lokalnym.

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

PS> Get-Alias -Name np

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

Polecenie cmdlet Set-Alias tworzy alias w bieżącej sesji programu PowerShell. Parametr Name określa nazwę aliasu, np. Parametr Value określa ścieżkę i nazwę aplikacji C:\Windows\notepad.exe. Polecenie cmdlet Get-Alias używa parametru Name, aby pokazać, że alias np jest skojarzony z notepad.exe.

Aby uruchomić alias, wpisz np w wierszu polecenia programu PowerShell, aby otworzyć notepad.exe.

Przykład 5. Tworzenie aliasu dla polecenia z parametrami

W tym przykładzie pokazano, jak przypisać alias do polecenia z parametrami.

Możesz utworzyć alias dla polecenia cmdlet, takiego jak Set-Location. Nie można utworzyć aliasu dla polecenia z parametrami i wartościami, takimi jak Set-Location -Path C:\Windows\System32. Aby utworzyć alias dla polecenia, utwórz funkcję zawierającą polecenie, a następnie utwórz alias dla funkcji. Aby uzyskać więcej informacji, zobacz about_Functions.

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

Set-Alias -Name Go -Value CD32

Zostanie utworzona funkcja o nazwie CD32. Funkcja używa polecenia cmdlet Set-Location z parametrem Path w celu określenia katalogu C:\Windows\System32.

Polecenie cmdlet Set-Alias tworzy alias funkcji w bieżącej sesji programu PowerShell. Parametr Name określa nazwę aliasu, Go. Parametr Value określa nazwę funkcji CD32.

Aby uruchomić alias, wpisz Go w wierszu polecenia programu PowerShell. Funkcja CD32 jest uruchamiana i zmienia się w katalogu C:\Windows\System32.

Przykład 6. Aktualizowanie opcji dla istniejącego aliasu

W tym przykładzie pokazano, jak przypisać wiele opcji przy użyciu parametru opcji.

Kontynuując z poprzedniego przykładu, ustaw alias Go jako ReadOnly i Private.

Set-Alias -Name Go -Option ReadOnly, Private

Alias Go powinien już istnieć. Po uruchomieniu polecenia nie można zmienić aliasu bez użycia parametru Force i jest dostępny tylko w bieżącym zakresie.

Parametry

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

Typ:	SwitchParameter
Aliasy:	cf
Position:	Named
Domyślna wartość:	False
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Description

Określa opis aliasu. Możesz wpisać dowolny ciąg. Jeśli opis zawiera spacje, należy go ująć w pojedynczy cudzysłów.

Typ:	String
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Force

Użyj parametru Force, aby zmienić lub usunąć alias z parametrem Option ustawioną na ReadOnly.

Parametr Force nie może zmienić ani usunąć aliasu z parametrem opcji ustawionym na wartość stała.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	False
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Name

Określa nazwę nowego aliasu. Nazwa aliasu może zawierać znaki alfanumeryczne i łączniki. Nazwy aliasów nie mogą być numeryczne, takie jak 123.

Typ:	String
Position:	0
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-Option

Ustawia wartość właściwości Option aliasu. Wartości, takie jak ReadOnly i Constant chronić alias przed niezamierzonym zmianami. Aby wyświetlić właściwość Option wszystkich aliasów w sesji, wpisz Get-Alias | Format-Table -Property Name, Options -Autosize.

Dopuszczalne wartości tego parametru są następujące:

• AllScope — alias jest kopiowany do wszystkich nowych utworzonych zakresów.
• Constant — nie można go zmienić ani usunąć.
• None — nie ustawia opcji i jest wartością domyślną.
• Private — alias jest dostępny tylko w bieżącym zakresie.
• ReadOnly — nie można go zmienić ani usunąć, chyba że jest używany parametr Force.
• Unspecified

Te wartości są definiowane jako wyliczenie oparte na flagach. Możesz połączyć wiele wartości ze sobą, aby ustawić wiele flag przy użyciu tego parametru. Wartości można przekazać do parametru Option jako tablicy wartości lub jako ciąg rozdzielany przecinkami tych wartości. Polecenie cmdlet łączy wartości przy użyciu operacji binary-OR. Przekazywanie wartości jako tablicy jest najprostszą opcją, a także umożliwia użycie uzupełniania tabulatorów na wartościach.

Typ:	ScopedItemOptions
Dopuszczalne wartości:	AllScope, Constant, None, Private, ReadOnly, Unspecified
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-PassThru

Zwraca obiekt reprezentujący alias. Użyj polecenia cmdlet formatu, takiego jak Format-List, aby wyświetlić obiekt. Domyślnie Set-Alias nie generuje żadnych danych wyjściowych.

Typ:	SwitchParameter
Position:	Named
Domyślna wartość:	None
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Scope

Określa zakres, w których ten alias jest prawidłowy. Wartość domyślna to local. Aby uzyskać więcej informacji, zobacz about_Scopes.

Dopuszczalne wartości są następujące:

• Global
• Local
• Private
• Numbered scopes
• Script

Typ:	String
Dopuszczalne wartości:	Global, Local, Private, Numbered scopes, Script
Position:	Named
Domyślna wartość:	Local
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

-Value

Określa nazwę polecenia cmdlet lub polecenia, które jest uruchamiany alias. Parametr Value jest właściwością Definition aliasu.

Typ:	String
Position:	1
Domyślna wartość:	None
Wymagane:	True
Akceptowanie danych wejściowych potoku:	True
Akceptowanie symboli wieloznacznych:	False

-WhatIf

Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Polecenie cmdlet nie jest uruchamiane.

Typ:	SwitchParameter
Aliasy:	wi
Position:	Named
Domyślna wartość:	False
Wymagane:	False
Akceptowanie danych wejściowych potoku:	False
Akceptowanie symboli wieloznacznych:	False

Dane wejściowe

None

Nie można potokować obiektów do tego polecenia cmdlet.

Dane wyjściowe

None

Domyślnie to polecenie cmdlet nie zwraca żadnych danych wyjściowych.

AliasInfo

Jeśli używasz parametru PassThru, to polecenie cmdlet zwraca obiekt AliasInfo reprezentujący alias.

Uwagi

Program PowerShell zawiera następujące aliasy dla Set-Alias:

• Wszystkie platformy:
  • sal

Program PowerShell zawiera wbudowane aliasy, które są dostępne w każdej sesji programu PowerShell. Polecenie cmdlet Get-Alias wyświetla aliasy dostępne w sesji programu PowerShell.

Aby utworzyć alias, użyj poleceń cmdlet Set-Alias lub New-Alias. Aby usunąć alias w programie PowerShell 6, użyj polecenia cmdlet Remove-Alias. Remove-Item jest akceptowana w celu zapewnienia zgodności z poprzednimi wersjami, na przykład w przypadku skryptów utworzonych przy użyciu wcześniejszych wersji programu PowerShell. Użyj polecenia, takiego jak Remove-Item -Path Alias:aliasname.

Aby utworzyć alias dostępny w każdej sesji programu PowerShell, dodaj go do profilu programu PowerShell. Aby uzyskać więcej informacji, zobacz about_Profiles.

Alias można zapisać i ponownie użyć w innej sesji programu PowerShell, wykonując eksportowanie i importowanie. Aby zapisać alias w pliku, użyj Export-Alias. Aby dodać zapisany alias do nowej sesji programu PowerShell, użyj Import-Alias.

Linki powiązane

• about_Aliases
• about_Functions
• about_Profiles
• about_Scopes
• Export-Alias
• Get-Alias
• Import-Alias
• New-Alias
• Remove-Alias
• Remove-Item