Set-Alias

  • Referentie
Module:
Microsoft.PowerShell.Utility

Hiermee maakt of wijzigt u een alias voor een cmdlet of een andere opdracht in de huidige PowerShell-sessie.

Syntax

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

Description

De Set-Alias cmdlet maakt of wijzigt een alias voor een cmdlet of een opdracht, zoals een functie, script, bestand of ander uitvoerbaar bestand. Een alias is een alternatieve naam die verwijst naar een cmdlet of opdracht. Is bijvoorbeeld sal de alias voor de Set-Alias cmdlet. Zie about_Aliases voor meer informatie.

Een cmdlet kan meerdere aliassen hebben, maar een alias kan slechts worden gekoppeld aan één cmdlet. U kunt Set-Alias een bestaande alias opnieuw toewijzen aan een andere cmdlet of de eigenschappen van een alias wijzigen, zoals de beschrijving.

Een alias die wordt gemaakt of gewijzigd door Set-Alias , is niet permanent en is alleen beschikbaar tijdens de huidige PowerShell-sessie. Wanneer de PowerShell-sessie is gesloten, wordt de alias verwijderd.

Voorbeelden

Voorbeeld 1: Een alias maken voor een cmdlet

Met deze opdracht maakt u een alias voor een cmdlet in de huidige PowerShell-sessie.

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

PS> Get-Alias -Name list

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

De Set-Alias cmdlet maakt een alias in de huidige PowerShell-sessie. Met de parameter Name geeft u de naam van de alias op. list De parameter Waarde geeft de cmdlet op die door de alias wordt uitgevoerd.

Als u de alias wilt uitvoeren, typt list u op de PowerShell-opdrachtregel.

Voorbeeld 2: Een bestaande alias opnieuw toewijzen aan een andere cmdlet

Met deze opdracht wordt een bestaande alias opnieuw toegewezen om een andere cmdlet uit te voeren.

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

De Get-Alias cmdlet gebruikt de parameter Name om de list alias weer te geven. De list alias is gekoppeld aan de Get-ChildItem cmdlet. Wanneer de list alias wordt uitgevoerd, worden de items in de huidige map weergegeven.

De Set-Alias cmdlet gebruikt de parameter Name om de list alias op te geven. De waardeparameter koppelt de alias aan de Get-Location cmdlet.

De Get-Alias cmdlet gebruikt de parameter Name om de list alias weer te geven. De list alias is gekoppeld aan de Get-Location cmdlet. Wanneer de list alias wordt uitgevoerd, wordt de locatie van de huidige map weergegeven.

Voorbeeld 3: Een alleen-lezenalias maken en wijzigen

Met deze opdracht maakt u een alleen-lezen alias. De optie Alleen-lezen voorkomt onbedoelde wijzigingen in een alias. Als u een alleen-lezenalias wilt wijzigen of verwijderen, gebruikt u de parameter Force .

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

De Set-Alias cmdlet maakt een alias in de huidige PowerShell-sessie. Met de parameter Name geeft u de naam van de alias op. loc De parameter Waarde geeft de Get-Location cmdlet op die door de alias wordt uitgevoerd. De parameter Option geeft de readOnly-waarde op. De parameter PassThru vertegenwoordigt het aliasobject en verzendt het object omlaag in de pijplijn naar de Format-List cmdlet. Format-List gebruikt de parameter Eigenschap met een sterretje (*) zodat elke eigenschap wordt weergegeven. In de voorbeelduitvoer ziet u een gedeeltelijke lijst met deze eigenschappen.

De loc alias wordt gewijzigd met de toevoeging van twee parameters. Beschrijving voegt tekst toe om het doel van de alias uit te leggen. De parameter Force is nodig omdat de loc alias alleen-lezen is. Als de parameter Force niet wordt gebruikt, mislukt de wijziging.

Voorbeeld 4: Een alias maken naar een uitvoerbaar bestand

In dit voorbeeld wordt een alias gemaakt naar een uitvoerbaar bestand op de lokale computer.

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

PS> Get-Alias -Name np

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

De Set-Alias cmdlet maakt een alias in de huidige PowerShell-sessie. Met de parameter Name geeft u de naam van de alias op. np De waardeparameter geeft het pad en de toepassingsnaam C:\Windows\notepad.exeop. De Get-Alias cmdlet gebruikt de parameter Name om aan te geven dat de np alias is gekoppeld aan notepad.exe.

Als u de alias wilt uitvoeren, typt np u op de PowerShell-opdrachtregel om te openen notepad.exe.

Voorbeeld 5: Een alias maken voor een opdracht met parameters

In dit voorbeeld ziet u hoe u een alias toewijst aan een opdracht met parameters.

U kunt een alias maken voor een cmdlet, zoals Set-Location. U kunt geen alias maken voor een opdracht met parameters en waarden, zoals Set-Location -Path C:\Windows\System32. Als u een alias voor een opdracht wilt maken, maakt u een functie die de opdracht bevat en maakt u vervolgens een alias voor de functie. Zie about_Functions voor meer informatie.

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

Set-Alias -Name Go -Value CD32

Er wordt een functie met de naam CD32 gemaakt. De functie gebruikt de Set-Location cmdlet met de parameter Path om de map op te geven. C:\Windows\System32

De Set-Alias cmdlet maakt een alias voor de functie in de huidige PowerShell-sessie. Met de parameter Name geeft u de naam van de alias op. Go Met de parameter Waarde geeft u de naam van de functie op. CD32

Als u de alias wilt uitvoeren, typt Go u op de PowerShell-opdrachtregel. De CD32 functie wordt uitgevoerd en verandert in de map C:\Windows\System32.

Voorbeeld 6: Bijwerkopties voor een bestaande alias

In dit voorbeeld ziet u hoe u meerdere opties toewijst met behulp van de parameter Option .

Als u verdergaat met het vorige voorbeeld, stelt u de alias Go in als ReadOnly en Private.

Set-Alias -Name Go -Option ReadOnly, Private

De alias Go moet al bestaan. Nadat u de opdracht hebt uitgevoerd, kan de alias niet worden gewijzigd zonder de parameter Force te gebruiken en is deze alleen beschikbaar in het huidige bereik.

Parameters

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

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

-Description

Hiermee geeft u een beschrijving van de alias. U kunt elke tekenreeks typen. Als de beschrijving spaties bevat, plaatst u deze tussen enkele aanhalingstekens.

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

-Force

Gebruik de parameter Force om een alias te wijzigen of te verwijderen waarvoor de optieparameter is ingesteld op ReadOnly.

De parameter Force kan een alias niet wijzigen of verwijderen met de optieparameter ingesteld op Constant.

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

-Name

Hiermee geeft u de naam van een nieuwe alias. Een aliasnaam kan alfanumerieke tekens en afbreekstreepjes bevatten. Aliasnamen kunnen niet numeriek zijn, zoals 123.

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

-Option

Hiermee stelt u de waarde van de eigenschap Option van de alias in. Waarden zoals ReadOnly en Constant beveiligen van een alias tegen onbedoelde wijzigingen. Als u de eigenschap Option van alle aliassen in de sessie wilt zien, typt Get-Alias | Format-Table -Property Name, Options -Autosizeu .

De acceptabele waarden voor deze parameter zijn als volgt:

  • AllScope - De alias wordt gekopieerd naar nieuwe bereiken die worden gemaakt.
  • Constant - Kan niet worden gewijzigd of verwijderd.
  • None - Stelt geen opties in en is de standaardinstelling.
  • Private - De alias is alleen beschikbaar in het huidige bereik.
  • ReadOnly - Kan niet worden gewijzigd of verwijderd tenzij de parameter Force wordt gebruikt.
  • Unspecified

Deze waarden worden gedefinieerd als een opsomming op basis van vlaggen. U kunt meerdere waarden combineren om meerdere vlaggen in te stellen met behulp van deze parameter. De waarden kunnen worden doorgegeven aan de parameter Option als een matrix met waarden of als een door komma's gescheiden tekenreeks van deze waarden. De cmdlet combineert de waarden met behulp van een binaire OF-bewerking. Het doorgeven van waarden als een matrix is de eenvoudigste optie en u kunt ook tabvoltooiing gebruiken voor de waarden.

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

Retourneert een object dat de alias vertegenwoordigt. Gebruik een indelings-cmdlet, bijvoorbeeld Format-List om het object weer te geven. Set-Alias Standaard wordt er geen uitvoer gegenereerd.

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

-Scope

Hiermee geeft u het bereik waarin deze alias geldig is. De standaardwaarde is Lokaal. Zie about_Scopes voor meer informatie.

De acceptabele waarden zijn als volgt:

  • 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

Hiermee geeft u de naam op van de cmdlet of opdracht die door de alias wordt uitgevoerd. De waardeparameter is de definitie-eigenschap van de alias.

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

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

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

Invoerwaarden

None

U kunt geen objecten doorsluisen naar deze cmdlet.

Uitvoerwaarden

None

Deze cmdlet retourneert standaard geen uitvoer.

AliasInfo

Wanneer u de parameter PassThru gebruikt, retourneert deze cmdlet een AliasInfo-object dat de alias vertegenwoordigt.

Notities

PowerShell bevat de volgende aliassen voor Set-Alias:

  • Alle platforms:
    • sal

PowerShell bevat ingebouwde aliassen die beschikbaar zijn in elke PowerShell-sessie. De Get-Alias cmdlet geeft de aliassen weer die beschikbaar zijn in een PowerShell-sessie.

Als u een alias wilt maken, gebruikt u de cmdlets Set-Alias of New-Alias. Gebruik de Remove-Alias cmdlet in PowerShell 6 om een alias te verwijderen. Remove-Item wordt geaccepteerd voor compatibiliteit met eerdere versies, zoals voor scripts die zijn gemaakt met eerdere versies van PowerShell. Gebruik een opdracht zoals Remove-Item -Path Alias:aliasname.

Als u een alias wilt maken die beschikbaar is in elke PowerShell-sessie, voegt u deze toe aan uw PowerShell-profiel. Zie about_Profiles voor meer informatie.

Een alias kan worden opgeslagen en opnieuw worden gebruikt in een andere PowerShell-sessie door een export en import uit te voeren. Als u een alias wilt opslaan in een bestand, gebruikt u Export-Alias. Als u een opgeslagen alias wilt toevoegen aan een nieuwe PowerShell-sessie, gebruikt u Import-Alias.