Set-Alias

  • Odwołanie
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 Set-Alias cmdlet 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 to alias polecenia Set-Alias cmdlet. 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 polecenia , aby ponownie przypisać istniejący alias do innego polecenia cmdlet lub zmienić właściwości aliasu, takie jak opis.

Alias utworzony lub zmieniony Set-Alias przez program 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 Set-Alias cmdlet tworzy alias w bieżącej sesji programu PowerShell. Parametr Name określa nazwę aliasu, list. Parametr Value określa polecenie cmdlet, które jest uruchamiane przez alias.

Aby uruchomić alias, wpisz list polecenie 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 Get-Alias cmdlet używa parametru Name do wyświetlania aliasu list . Alias list jest skojarzony z poleceniem Get-ChildItem cmdlet . Po uruchomieniu aliasu list wyświetlane są elementy w bieżącym katalogu.

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

Polecenie Get-Alias cmdlet używa parametru Name do wyświetlania aliasu list . Alias list jest skojarzony z poleceniem Get-Location cmdlet . 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 Set-Alias cmdlet tworzy alias w bieżącej sesji programu PowerShell. Parametr Name określa nazwę aliasu, loc. Parametr Value określa Get-Location polecenie cmdlet, które jest uruchamiane przez alias. Parametr Opcja określa wartość ReadOnly . Parametr PassThru reprezentuje obiekt aliasu i wysyła obiekt w dół potoku Format-List do polecenia cmdlet. 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 do wyjaśnienia przeznaczenia aliasu. Parametr Force jest wymagany, ponieważ loc alias 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 Set-Alias cmdlet tworzy alias w bieżącej sesji programu PowerShell. Parametr Name określa nazwę aliasu, np. Parametr Value określa ścieżkę i nazwę C:\Windows\notepad.exeaplikacji . Polecenie Get-Alias cmdlet używa parametru Name , aby pokazać, że np alias jest skojarzony z elementem notepad.exe.

Aby uruchomić alias, wpisz np polecenie w wierszu polecenia programu PowerShell, aby otworzyć polecenie 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 Set-Location polecenia cmdlet z parametrem Path , aby określić katalog C:\Windows\System32.

Polecenie Set-Alias cmdlet 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 polecenie 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 Opcja .

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 alias nie można zmienić bez użycia parametru Force i jest dostępny tylko w bieżącym zakresie.

Parametry

-Confirm

Monituje o potwierdzenie przed uruchomieniem polecenia cmdlet.

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

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

-Force

Użyj parametru Force, aby zmienić lub usunąć alias, który ma parametr Option ustawiony na ReadOnly.

Parametr Force nie może zmienić ani usunąć aliasu z parametrem Opcja ustawionym na Stałą.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-Option

Ustawia wartość właściwości Option aliasu. Wartości, takie jak ReadOnly i Constant chroniące 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 zmienić ani usunąć.
  • None - Ustawia brak opcji i jest wartością domyślną.
  • Private — Alias jest dostępny tylko w bieżącym zakresie.
  • ReadOnly - Nie można 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 tablicę 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.

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

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.

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

-Scope

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

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

  • 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

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

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

-WhatIf

Pokazuje, co się stanie po uruchomieniu polecenia cmdlet. Polecenie cmdlet nie jest uruchamiane.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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 programu Set-Alias:

  • Wszystkie platformy:
    • sal

Program PowerShell zawiera wbudowane aliasy, które są dostępne w każdej sesji programu PowerShell. Polecenie Get-Alias cmdlet 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 Remove-Alias polecenia cmdlet . Remove-Item program jest akceptowany w celu zapewnienia zgodności z poprzednimi wersjami, takich jak skrypty utworzone 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 polecenia Export-Alias. Aby dodać zapisany alias do nowej sesji programu PowerShell, użyj polecenia Import-Alias.