Sdílet prostřednictvím

New-Alias

  • Reference
Modul:
Microsoft.PowerShell.Utility

Vytvoří nový alias.

Syntaxe

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

Description

Rutina New-Alias vytvoří nový alias v aktuální relaci PowerShellu. Aliasy vytvořené pomocí použití New-Alias se po ukončení relace nebo zavření PowerShellu neuloží. Pomocí této rutiny Export-Alias můžete uložit informace o aliasu do souboru. Později můžete použít Import-Alias k načtení informací o uloženém aliasu.

Příklady

Příklad 1: Vytvoření aliasu pro rutinu

New-Alias -Name "List" Get-ChildItem

Tento příkaz vytvoří alias s názvem List, který představuje rutinu Get-ChildItem.

Příklad 2: Vytvoření aliasu jen pro čtení pro rutinu

Tento příkaz vytvoří alias s názvem C představující rutinu Get-ChildItem . Vytvoří popis "rychlého aliasu gci" pro tento alias a vytvoří ho jen pro čtení.

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]…}

Příkaz Get-Alias předaný tak, aby Format-List zobrazoval všechny informace o novém aliasu.

Příklad 3: Vytvoření aliasu pro příkaz s parametry

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

První příkaz vytvoří funkci Set-ParentDirectory, která používá Set-Location k nastavení pracovního umístění na nadřazený adresář. Druhý příkaz používá New-Alias k vytvoření aliasu .. volání Set-ParentDirectory funkce. Vzhledem k tomu, že parametr Value vyžaduje hodnotu rutiny, funkce nebo spustitelného souboru, musíte vytvořit vlastní funkci pro vytvoření aliasu, který používá parametry. Spuštění aliasu .. změní aktuální umístění na nadřazený adresář.

Parametry

-Confirm

Před spuštěním rutiny zobrazí výzvu k potvrzení.

Typ:SwitchParameter
Aliasy:cf
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Description

Určuje popis aliasu. Můžete zadat libovolný řetězec. Pokud popis obsahuje mezery, uzavřete ho do uvozovek.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Force

Označuje, že rutina funguje, jako Set-Alias kdyby alias s názvem již existuje.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Name

Určuje nový alias. V aliasu můžete použít libovolné alfanumerické znaky, ale první znak nemůže být číslo.

Typ:String
Position:0
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-Option

Určuje hodnotu vlastnosti Options aliasu. Platné hodnoty jsou:

  • None: Alias nemá žádná omezení (výchozí hodnota)
  • ReadOnly: Alias lze odstranit, ale nelze jej změnit s výjimkou použití parametru Force .
  • Constant: Alias nelze odstranit ani změnit.
  • Private: Alias je k dispozici pouze v aktuálním oboru.
  • AllScope: Alias se zkopíruje do všech nově vytvořených oborů.
  • Unspecified: Možnost není zadána.

Tyto hodnoty jsou definovány jako výčet založený na příznaku. 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. Rutina zkombinuje hodnoty pomocí binární operace OR. Předání hodnot jako pole je nejjednodušší možností a také umožňuje použít pro hodnoty dokončování tabulátoru.

Chcete-li zobrazit vlastnost Možnosti všech aliasů v relaci, zadejte Get-Alias | Format-Table -Property Name, Options -AutoSize.

Typ:ScopedItemOptions
Přípustné hodnoty:None, ReadOnly, Constant, Private, AllScope, Unspecified
Position:Named
Default value:[System.Management.Automation.ScopedItemOptions]::None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-PassThru

Vrátí objekt představující položku, se kterou pracujete. Ve výchozím nastavení tato rutina negeneruje žádný výstup.

Typ:SwitchParameter
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Scope

Určuje rozsah nového aliasu. Tento parametr přijímá tyto hodnoty:

  • Global
  • Local
  • Script
  • Číslo relativní k aktuálnímu oboru (0 až počet oborů, kde 0 je aktuální obor a 1 je jeho nadřazený).

Local je výchozí možnost. Další informace najdete v tématu about_Scopes.

Typ:String
Position:Named
Default value:None
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

-Value

Určuje název rutiny nebo elementu příkazu, který se aliasuje.

Typ:String
Position:1
Default value:None
Vyžadováno:True
Přijmout vstup kanálu:True
Přijmout zástupné znaky:False

-WhatIf

Zobrazuje, co by se stalo při spuštění rutiny. Rutina není spuštěna.

Typ:SwitchParameter
Aliasy:wi
Position:Named
Default value:False
Vyžadováno:False
Přijmout vstup kanálu:False
Přijmout zástupné znaky:False

Vstupy

None

Do této rutiny nemůžete roušit 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í nový alias.

Poznámky

PowerShell obsahuje následující aliasy pro New-Alias:

  • Všechny platformy:

    • nal

  • Chcete-li vytvořit nový alias, použijte Set-Alias nebo New-Alias. Pokud chcete změnit alias, použijte Set-Alias. Pokud chcete odstranit alias, použijte Remove-Alias.