Set-Alias

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

O cmdlet Set-Alias cria ou altera um alias para um cmdlet ou um comando, como uma função, script, arquivo ou outro executável. Um alias é um nome alternativo que se refere a um cmdlet ou comando. Por exemplo, sal é o alias do cmdlet Set-Alias. Para obter mais informações, consulte about_Aliases.

Um cmdlet pode ter vários aliases, mas um alias só pode ser associado a um cmdlet. Você pode usar Set-Alias para reatribuir um alias existente a outro cmdlet ou alterar as propriedades de um alias, como a descrição.

Um alias criado ou alterado por Set-Alias não é permanente e só está disponível durante a sessão atual do PowerShell. Quando a sessão do PowerShell é fechada, o alias é removido.

Este comando cria um alias para um cmdlet na sessão atual do PowerShell.

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

PS> Get-Alias -Name list

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

O cmdlet Set-Alias cria um alias na sessão atual do PowerShell. O parâmetro Name especifica o nome do alias, list. O parâmetro Value especifica o cmdlet que o alias executa.

Para executar o alias, digite list na linha de comando do PowerShell.

Este comando reatribui um alias existente para executar um cmdlet diferente.

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

O cmdlet Get-Alias usa o parâmetro Name para exibir o alias list. O alias list está associado ao cmdlet Get-ChildItem. Quando o alias list é executado, os itens no diretório atual são exibidos.

O cmdlet Set-Alias usa o parâmetro Name para especificar o alias list. O parâmetro Value associa o alias ao cmdlet Get-Location.

O cmdlet Get-Alias usa o parâmetro Name para exibir o alias list. O alias list está associado ao cmdlet Get-Location. Quando o alias list é executado, o local do diretório atual é exibido.

Este comando cria um alias somente leitura. A opção somente leitura impede alterações não intencionais em um alias. Para alterar ou excluir um alias somente leitura, use o parâmetro Force.

PS> 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

PS> Set-Alias -Name loc -Value Get-Location -Option ReadOnly -Description 'Displays the current directory' -Force -PassThru | Format-List -Property *

DisplayName         : loc -> Get-Location
Definition          : Get-Location
Options             : ReadOnly
Description         : Displays the current directory
Name                : loc
CommandType         : Alias

O cmdlet Set-Alias cria um alias na sessão atual do PowerShell. O parâmetro Name especifica o nome do alias, loc. O parâmetro Value especifica o cmdlet Get-Location que o alias executa. O parâmetro Option especifica o valor ReadOnly. O parâmetro PassThru representa o objeto alias e envia o objeto pelo pipeline para o cmdlet Format-List. Format-List usa o parâmetro Property com um asterisco (*) para que todas as propriedades sejam exibidas. A saída de exemplo mostra uma lista parcial dessas propriedades.

O alias loc é alterado com a adição de dois parâmetros. Descrição adiciona texto para explicar a finalidade do alias. O parâmetro Force é necessário porque o alias loc é somente leitura. Se o parâmetro Force não for usado, a alteração falhará.

Este exemplo cria um alias para um arquivo executável no computador local.

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

PS> Get-Alias -Name np

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

O cmdlet Set-Alias cria um alias na sessão atual do PowerShell. O parâmetro Name especifica o nome do alias, np. O parâmetro Value especifica o caminho e o nome do aplicativoC:\Windows\notepad.exe. O Get-Alias cmdlet usa o parâmetro Name para mostrar que o np alias está associado anotepad.exe.

Para executar o alias, digite np na linha de comando do PowerShell para abri notepad.exe.

Este exemplo mostra como atribuir um alias a um comando com parâmetros.

Você pode criar um alias para um cmdlet, como Set-Location. Não é possível criar um alias para um comando com parâmetros e valores, como Set-Location -Path C:\Windows\System32. Para criar um alias para um comando, crie uma função que inclua o comando e, em seguida, crie um alias para a função. Para obter mais informações, consulte about_Functions.

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

PS> Set-Alias -Name Go -Value CD32

Uma função chamada CD32 é criada. A função usa o Set-Location cmdlet com o parâmetro Path para especificar o diretório, C:\Windows\System32.

O cmdlet Set-Alias cria um alias para a função na sessão atual do PowerShell. O parâmetro Name especifica o nome do alias, Go. O parâmetro Value especifica o nome da função, CD32.

Para executar o alias, digite Go na linha de comando do PowerShell. A CD32 função é executada e muda para o diretório C:\Windows\System32.

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Set-Alias não aceita entrada do pipeline.

Quando você usa o parâmetro PassThru , Set-Alias gera um objeto System.Management.Automation.AliasInfo que representa o alias. Caso contrário, Set-Alias não gera nenhuma saída.

O PowerShell inclui aliases internos que estão disponíveis em cada sessão do PowerShell. O cmdlet Get-Alias exibe os aliases disponíveis em uma sessão do PowerShell.

Para criar um novo alias, use Set-Alias ou New-Alias. Para remover um alias, use o cmdlet Remove-Item. Por exemplo, Remove-Item -Path Alias:aliasname.

Para criar um alias disponível em cada sessão do PowerShell, adicione-o ao seu perfil do PowerShell. Para obter mais informações, consulte about_Profiles.

Um alias pode ser salvo e reutilizado em outra sessão do PowerShell fazendo uma exportação e importação. Para salvar um alias em um arquivo, use Export-Alias. Para adicionar um alias salvo a uma nova sessão do PowerShell, use Import-Alias.