Udostępnij za pośrednictwem

New-Alias

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Tworzy nowy alias.

Składnia

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

Opis

Polecenie cmdlet New-Alias tworzy nowy alias w bieżącej sesji programu PowerShell. Aliasy utworzone przy użyciu New-Alias nie są zapisywane po zakończeniu sesji lub zamknięciu programu PowerShell. Aby zapisać informacje o aliasie w pliku, możesz użyć polecenia cmdlet Export-Alias. Później możesz użyć Import-Alias, aby pobrać zapisane informacje o aliasie.

Przykłady

Przykład 1. Tworzenie aliasu dla polecenia cmdlet

New-Alias -Name "List" Get-ChildItem

To polecenie tworzy alias o nazwie List reprezentujący Get-ChildItem polecenia cmdlet.

Przykład 2. Tworzenie aliasu tylko do odczytu dla polecenia cmdlet

To polecenie tworzy alias o nazwie C reprezentujący polecenie cmdlet Get-ChildItem. Tworzy opis "Szybki alias gci" dla aliasu i sprawia, że jest tylko do odczytu.

New-Alias -Name "C" -Value Get-ChildItem -Description "Quick gci alias" -Option ReadOnly
Get-Alias -Name "C" | Format-List *

HelpUri             : https://go.microsoft.com/fwlink/?LinkID=2096492
ResolvedCommandName : Get-ChildItem
DisplayName         : C -> Get-ChildItem
ReferencedCommand   : Get-ChildItem
ResolvedCommand     : Get-ChildItem
Definition          : Get-ChildItem
Options             : ReadOnly
Description         : Quick gci alias
OutputType          : {System.IO.FileInfo, System.IO.DirectoryInfo}
Name                : C
CommandType         : Alias
Source              :
Version             :
Visibility          : Public
ModuleName          :
Module              :
RemotingCapability  : PowerShell
Parameters          : {[Path, System.Management.Automation.ParameterMetadata], [LiteralPath,
                      System.Management.Automation.ParameterMetadata], [Filter,
                      System.Management.Automation.ParameterMetadata], [Include,
                      System.Management.Automation.ParameterMetadata]…}

Polecenie Get-Alias potokowe do Format-List pokazuje wszystkie informacje o nowym aliasie.

Przykład 3. Tworzenie aliasu dla polecenia z parametrami

function Set-ParentDirectory {Set-Location -Path ..}
New-Alias -Name .. -Value Set-ParentDirectory

Pierwsze polecenie tworzy funkcję Set-ParentDirectory, która używa Set-Location, aby ustawić lokalizację roboczą na katalog nadrzędny. Drugie polecenie używa New-Alias do utworzenia aliasu .. w celu wywołania funkcji Set-ParentDirectory. Ponieważ parametr Value wymaga polecenia cmdlet, funkcji lub wartości wykonywalnej, należy utworzyć funkcję niestandardową, aby utworzyć alias używający parametrów. Uruchomienie aliasu .. zmienia bieżącą lokalizację w katalogu nadrzędnym.

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 cudzysłów.

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

-Force

Wskazuje, że polecenie cmdlet działa jak Set-Alias, jeśli alias o nazwie już istnieje.

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

-Name

Określa nowy alias. Można użyć dowolnych znaków alfanumerycznych w aliasie, ale pierwszy znak nie może być liczbą.

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

-Option

Określa wartość właściwości Options aliasu. Prawidłowe wartości to:

  • None: alias nie ma ograniczeń (wartość domyślna)
  • ReadOnly: alias można usunąć, ale nie można go zmienić z wyjątkiem parametru Force
  • Constant: nie można usunąć ani zmienić aliasu
  • Private: alias jest dostępny tylko w bieżącym zakresie
  • AllScope: alias jest kopiowany do wszystkich nowych utworzonych zakresów
  • Unspecified: nie określono opcji

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 połą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.

Aby wyświetlić właściwość opcje wszystkich aliasów w sesji, wpisz Get-Alias | Format-Table -Property Name, Options -AutoSize.

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

-PassThru

Zwraca obiekt reprezentujący element, z którym pracujesz. Domyślnie to polecenie cmdlet 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 nowego aliasu. Dopuszczalne wartości tego parametru to:

  • Global
  • Local
  • Script
  • Liczba względem bieżącego zakresu (od 0 do liczby zakresów, gdzie 0 jest bieżącym zakresem, a 1 jest jego elementem nadrzędnym).

Local jest wartością domyślną. Aby uzyskać więcej informacji, zobacz about_Scopes.

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

-Value

Określa nazwę polecenia cmdlet lub elementu polecenia, który jest aliasowany.

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 nowy alias.

Uwagi

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

  • Wszystkie platformy:

    • nal

  • Aby utworzyć nowy alias, użyj Set-Alias lub New-Alias. Aby zmienić alias, użyj Set-Alias. Aby usunąć alias, użyj Remove-Alias.