Sdílet prostřednictvím

New-Alias

Modul:
Microsoft.PowerShell.Utility Module

Vytvoří nový alias.

Syntax

Default (Výchozí) 

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

Description

Rutina New-Alias vytvoří v aktuální relaci PowerShellu nový alias. Aliasy vytvořené pomocí New-Alias se po ukončení relace nebo zavření PowerShellu neuloží. K uložení informací o aliasu do souboru můžete použít rutinu Export-Alias. 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 představující Get-ChildItem rutinu.

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 aliasu Quick 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ý na Format-List zobrazí 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 .. k volání funkce Set-ParentDirectory. 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 cmdletu vás vyzve k potvrzení.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False
Aliasy:viz

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Description

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

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Force

Označuje, že rutina funguje jako Set-Alias, pokud alias již existuje.

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Name

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

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:0
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-Option

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

  • None: Alias nemá žádná omezení (výchozí hodnota)
  • ReadOnly: Alias lze odstranit, ale nejde ho 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 rozsahu.
  • AllScope: Alias se kopíruje do jakýchkoli nově vytvořených oborů.
  • Unspecified: Možnost není zadána.

Tyto hodnoty jsou definovány jako výčtové hodnoty na bázi příznaků. 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 využít automatické doplňování pomocí klávesy Tab pro hodnoty.

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

Vlastnosti parametru

Typ:ScopedItemOptions
Default value:[System.Management.Automation.ScopedItemOptions]::None
Přípustné hodnoty:None, ReadOnly, Constant, Private, AllScope, Unspecified
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-PassThru

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

Vlastnosti parametru

Typ:SwitchParameter
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Scope

Určuje rozsah nového aliasu. Přijatelné hodnoty pro tento parametr jsou:

  • 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ý obor).

Local je výchozí. Další informace najdete v části about_Scopes.

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

-Value

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

Vlastnosti parametru

Typ:String
Default value:None
Podporuje zástupné znaky:False
DontShow:False

Sady parametrů

(All)
Position:1
Povinné:True
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:True
Hodnota ze zbývajících argumentů:False

-WhatIf

Ukazuje, co se stane, když se příkaz spustí. Příkazový modul nebyl spuštěn.

Vlastnosti parametru

Typ:SwitchParameter
Default value:False
Podporuje zástupné znaky:False
DontShow:False
Aliasy:Wi

Sady parametrů

(All)
Position:Named
Povinné:False
Hodnota z kanálu:False
Hodnota z kanálu podle názvu vlastnosti:False
Hodnota ze zbývajících argumentů:False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Do tohoto cmdletu nemůžete předávat 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

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

  • nal

  • Pokud chcete 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-Item.