Share via

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

Przykłady

Przykład 1: Twórca alias polecenia cmdlet

New-Alias -Name "List" Get-ChildItem

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

Przykład 2: Twórca alias tylko do odczytu dla polecenia cmdlet

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

To polecenie tworzy alias o nazwie , C aby reprezentować Get-ChildItem polecenie cmdlet. Tworzy on opis, szybki alias wmi dla aliasu i sprawia, że jest tylko do odczytu. Ostatni wiersz polecenia używa Get-Alias polecenia w celu pobrania nowego aliasu i potoku go do Format-List, aby wyświetlić wszystkie informacje o nim.

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 je ująć w cudzysłów.

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

-Force

Wskazuje, że polecenie cmdlet działa tak, jakby Set-Alias alias o nazwie już istnieje.

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

-Name

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

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

-Option

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

  • None: Alias nie ma ograniczeń (wartość domyślna)
  • ReadOnly: Alias można usunąć, ale nie można go zmienić z wyjątkiem przy użyciu 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 zakresów, które zostały utworzone
  • Unspecified: Nie określono opcji

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

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

Type:ScopedItemOptions
Accepted values:None, ReadOnly, Constant, Private, AllScope, Unspecified
Position:Named
Default value:[System.Management.Automation.ScopedItemOptions]::None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Zwraca obiekt reprezentujący element, z którym pracujesz. Domyślnie to polecenie cmdlet nie generuje żadnego wyniku.

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

-Scope

Określa zakres nowego aliasu. Dopuszczalne wartości dla tego parametru to:

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

Wartość domyślna to Local. Aby uzyskać więcej informacji, zobacz about_Scopes.

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

-Value

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

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 zostało uruchomione.

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 przekazać potoku danych wejściowych do tego polecenia cmdlet.

Dane wyjściowe

None or System.Management.Automation.AliasInfo

Gdy używasz parametru Passthru , New-Alias generuje obiekt System.Management.Automation.AliasInfo reprezentujący nowy alias. W przeciwnym razie to polecenie cmdlet nie generuje żadnych danych wyjściowych.

Uwagi

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