Set-Alias

  • Referens
Modul:
Microsoft.PowerShell.Utility

Skapar eller ändrar ett alias för en cmdlet eller ett annat kommando i den aktuella PowerShell-sessionen.

Syntax

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

Description

Cmdleten Set-Alias skapar eller ändrar ett alias för en cmdlet eller ett kommando, till exempel en funktion, ett skript, en fil eller en annan körbar fil. Ett alias är ett alternativt namn som refererar till en cmdlet eller ett kommando. Är till exempel sal aliaset för cmdleten Set-Alias . Mer information finns i about_Aliases.

En cmdlet kan ha flera alias, men ett alias kan bara associeras med en cmdlet. Du kan använda Set-Alias för att omtilldela ett befintligt alias till en annan cmdlet eller ändra ett alias egenskaper, till exempel beskrivningen.

Ett alias som skapas eller ändras av Set-Alias är inte permanent och är endast tillgängligt under den aktuella PowerShell-sessionen. När PowerShell-sessionen stängs tas aliaset bort.

Exempel

Exempel 1: Skapa ett alias för en cmdlet

Det här kommandot skapar ett alias till en cmdlet i den aktuella PowerShell-sessionen.

PS> Set-Alias -Name list -Value Get-ChildItem

PS> Get-Alias -Name list

CommandType     Name
-----------     ----
Alias           list -> Get-ChildItem

Cmdleten Set-Alias skapar ett alias i den aktuella PowerShell-sessionen. Parametern Namn anger aliasets namn, list. Parametern Value anger den cmdlet som aliaset kör.

Om du vill köra aliaset skriver du list på PowerShell-kommandoraden.

Exempel 2: Tilldela om ett befintligt alias till en annan cmdlet

Det här kommandot omtilldelar ett befintligt alias för att köra en annan 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

Cmdleten Get-Alias använder parametern Namn för att visa aliaset list . Aliaset list är associerat med cmdleten Get-ChildItem . När aliaset list körs visas objekten i den aktuella katalogen.

Cmdleten Set-Alias använder parametern Namn för att ange aliaset list . Parametern Value associerar aliaset med cmdleten Get-Location .

Cmdleten Get-Alias använder parametern Namn för att visa aliaset list . Aliaset list är associerat med cmdleten Get-Location . När aliaset list körs visas den aktuella katalogens plats.

Exempel 3: Skapa och ändra ett skrivskyddat alias

Det här kommandot skapar ett skrivskyddat alias. Det skrivskyddade alternativet förhindrar oavsiktliga ändringar av ett alias. Om du vill ändra eller ta bort ett skrivskyddat alias använder du force-parametern.

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

Cmdleten Set-Alias skapar ett alias i den aktuella PowerShell-sessionen. Parametern Namn anger aliasets namn, loc. Parametern Value anger den Get-Location cmdlet som aliaset kör. Parametern Alternativ anger ReadOnly-värdet . Parametern PassThru representerar aliasobjektet och skickar objektet nedåt i pipelinen till cmdleten Format-List . Format-List använder parametern Egenskap med en asterisk (*) så att varje egenskap visas. Exempelutdata visar en partiell lista över dessa egenskaper.

Aliaset loc ändras med tillägg av två parametrar. Beskrivningen lägger till text för att förklara aliasets syfte. Force-parametern behövs eftersom aliaset loc är skrivskyddat. Om force-parametern inte används misslyckas ändringen.

Exempel 4: Skapa ett alias till en körbar fil

Det här exemplet skapar ett alias till en körbar fil på den lokala datorn.

PS> Set-Alias -Name np -Value C:\Windows\notepad.exe

PS> Get-Alias -Name np

CommandType     Name
-----------     ----
Alias           np -> notepad.exe

Cmdleten Set-Alias skapar ett alias i den aktuella PowerShell-sessionen. Parametern Namn anger aliasets namn, np. Parametern Value anger sökvägen och programnamnet C:\Windows\notepad.exe. Cmdleten Get-Alias använder parametern Namn för att visa att aliaset np är associerat med notepad.exe.

Om du vill köra aliaset skriver du np på PowerShell-kommandoraden för att öppna notepad.exe.

Exempel 5: Skapa ett alias för ett kommando med parametrar

Det här exemplet visar hur du tilldelar ett alias till ett kommando med parametrar.

Du kan skapa ett alias för en cmdlet, till exempel Set-Location. Du kan inte skapa ett alias för ett kommando med parametrar och värden, till exempel Set-Location -Path C:\Windows\System32. Skapa ett alias för ett kommando genom att skapa en funktion som innehåller kommandot och sedan skapa ett alias för funktionen. Mer information finns i about_Functions.

Function CD32 {Set-Location -Path C:\Windows\System32}

Set-Alias -Name Go -Value CD32

En funktion med namnet CD32 skapas. Funktionen använder cmdleten Set-Location med parametern Path för att ange katalogen , C:\Windows\System32.

Cmdleten Set-Alias skapar ett alias för funktionen i den aktuella PowerShell-sessionen. Parametern Namn anger aliasets namn, Go. Parametern Value anger funktionens namn, CD32.

Om du vill köra aliaset skriver du Go på PowerShell-kommandoraden. Funktionen CD32 körs och ändras till katalogen C:\Windows\System32.

Exempel 6: Uppdatera alternativ för ett befintligt alias

Det här exemplet visar hur du tilldelar flera alternativ med hjälp av parametern Alternativ .

Om du fortsätter från föregående exempel anger du aliaset Go som ReadOnly och Private.

Set-Alias -Name Go -Option ReadOnly, Private

Aliaset Go bör redan finnas. När du har kört kommandot kan aliaset inte ändras utan att använda force-parametern och är endast tillgängligt i det aktuella omfånget.

Parametrar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

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

-Description

Anger en beskrivning av aliaset. Du kan skriva valfri sträng. Om beskrivningen innehåller blanksteg omger du den med enkla citattecken.

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

-Force

Använd force-parametern för att ändra eller ta bort ett alias som har parametern Alternativ inställd på ReadOnly.

Force-parametern kan inte ändra eller ta bort ett alias med parametern Alternativ inställd på Konstant.

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

-Name

Anger namnet på ett nytt alias. Ett aliasnamn kan innehålla alfanumeriska tecken och bindestreck. Aliasnamn kan inte vara numeriska, till exempel 123.

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

-Option

Anger värdet för egenskapen Option för aliaset. Värden som ReadOnly och Constant skyddar ett alias från oavsiktliga ändringar. Om du vill se egenskapen Alternativ för alla alias i sessionen skriver du Get-Alias | Format-Table -Property Name, Options -Autosize.

Godkända värden för den här parametern är följande:

  • AllScope – Aliaset kopieras till alla nya omfång som skapas.
  • Constant – Det går inte att ändra eller ta bort.
  • None – Anger inga alternativ och är standard.
  • Private – Aliaset är endast tillgängligt i det aktuella omfånget.
  • ReadOnly– Det går inte att ändra eller ta bort om inte force-parametern används.
  • Unspecified

Dessa värden definieras som en flaggbaserad uppräkning. Du kan kombinera flera värden för att ange flera flaggor med hjälp av den här parametern. Värdena kan skickas till parametern Alternativ som en matris med värden eller som en kommaavgränsad sträng av dessa värden. Cmdleten kombinerar värdena med hjälp av en binär-OR-åtgärd. Att skicka värden som en matris är det enklaste alternativet och du kan även använda tab-completion på värdena.

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

Returnerar ett objekt som representerar aliaset. Använd en format-cmdlet, till exempel Format-List för att visa objektet. Som standard Set-Alias genererar inga utdata.

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

-Scope

Anger omfånget som det här aliaset är giltigt i. Standardvärdet är Lokalt. Mer information finns i about_Scopes.

De godtagbara värdena är följande:

  • 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

Anger namnet på cmdleten eller kommandot som aliaset kör. Parametern Value är aliasets definitionsegenskap.

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

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

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

Indata

None

Du kan inte skicka objekt till den här cmdleten.

Utdata

None

Som standard returnerar den här cmdleten inga utdata.

AliasInfo

När du använder parametern PassThru returnerar den här cmdleten ett AliasInfo-objekt som representerar aliaset.

Kommentarer

PowerShell innehåller följande alias för Set-Alias:

  • Alla plattformar:
    • sal

PowerShell innehåller inbyggda alias som är tillgängliga i varje PowerShell-session. Cmdleten Get-Alias visar de alias som är tillgängliga i en PowerShell-session.

Om du vill skapa ett alias använder du cmdletarna Set-Alias eller New-Alias. Använd cmdleten för att ta bort ett alias i Remove-Alias PowerShell 6. Remove-Item accepteras för bakåtkompatibilitet, till exempel för skript som skapats med tidigare versioner av PowerShell. Använd ett kommando som Remove-Item -Path Alias:aliasname.

Om du vill skapa ett alias som är tillgängligt i varje PowerShell-session lägger du till det i din PowerShell-profil. Mer information finns i about_Profiles.

Ett alias kan sparas och återanvändas i en annan PowerShell-session genom att exportera och importera. Om du vill spara ett alias i en fil använder du Export-Alias. Om du vill lägga till ett sparat alias i en ny PowerShell-session använder du Import-Alias.