Set-Alias

Syntax

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

Description

O Set-Alias cmdlet cria ou altera um alias para um cmdlet ou um comando, como uma função, script, ficheiro ou outro executável. Um alias é um nome alternativo que se refere a um cmdlet ou comando. Por exemplo, sal é o alias do Set-Alias cmdlet. 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. Pode utilizar 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.

Exemplos

Exemplo 1: Create um alias para um cmdlet

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 Set-Alias cmdlet cria um alias na sessão atual do PowerShell. O parâmetro Nome especifica o nome do alias, list. O parâmetro Valor especifica o cmdlet que o alias executa.

Para executar o alias, escreva list na linha de comandos do PowerShell.

Exemplo 2: Reatribuir um alias existente a um cmdlet diferente

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 Get-Alias cmdlet utiliza o parâmetro Nome para apresentar o alias list . O list alias está associado ao Get-ChildItem cmdlet. Quando o alias list é executado, os itens no diretório atual são apresentados.

O Set-Alias cmdlet utiliza o parâmetro Nome para especificar o alias list . O parâmetro Valor associa o alias ao Get-Location cmdlet.

O Get-Alias cmdlet utiliza o parâmetro Nome para apresentar o alias list . O list alias está associado ao Get-Location cmdlet. Quando o alias list é executado, a localização do diretório atual é apresentada.

Exemplo 3: Create e alterar um alias só de leitura

Este comando cria um alias só de leitura. A opção só de leitura impede alterações não intencionais a um alias. Para alterar ou eliminar um alias só de leitura, utilize o parâmetro Forçar .

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 Set-Alias cmdlet cria um alias na sessão atual do PowerShell. O parâmetro Nome especifica o nome do alias, loc. O parâmetro Valor especifica o Get-Location cmdlet que o alias executa. O parâmetro Opção especifica o valor ReadOnly . O parâmetro PassThru representa o objeto de alias e envia o objeto pelo pipeline para o Format-List cmdlet. Format-List utiliza o parâmetro Propriedade com um asterisco (*) para que todas as propriedades sejam apresentadas. O resultado de exemplo mostra uma lista parcial dessas propriedades.

O loc alias é alterado com a adição de dois parâmetros. A descrição adiciona texto para explicar a finalidade do alias. O parâmetro Forçar é necessário porque o alias loc é só de leitura. Se o parâmetro Forçar não for utilizado, a alteração falhará.

Exemplo 4: Create um alias a um ficheiro executável

Este exemplo cria um alias para um ficheiro 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 Set-Alias cmdlet cria um alias na sessão atual do PowerShell. O parâmetro Nome especifica o nome do alias, np. O parâmetro Valor especifica o caminho e o nome da aplicaçãoC:\Windows\notepad.exe. O Get-Alias cmdlet utiliza o parâmetro Nome para mostrar que o alias np está associado ao notepad.exe.

Para executar o alias, escreva np na linha de comandos do PowerShell para abrir notepad.exe.

Exemplo 5: Create um alias para um comando com parâmetros

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

Pode criar um alias para um cmdlet, como Set-Location. Não pode 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

É criada uma função com o nome CD32 . A função utiliza o Set-Location cmdlet com o parâmetro Caminho para especificar o diretório C:\Windows\System32.

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

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

Parâmetros

-Confirm

-Description

-Force

-Name

-Option

-PassThru

-Scope

-Value

-WhatIf

Entradas

None

Set-Alias não aceita a entrada do pipeline.

Saídas

None or System.Management.Automation.AliasInfo

Quando utiliza 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.

Notas

O PowerShell inclui aliases incorporados que estão disponíveis em cada sessão do PowerShell. O Get-Alias cmdlet apresenta os aliases disponíveis numa sessão do PowerShell.

Para criar um novo alias, utilize Set-Alias ou New-Alias. Para remover um alias, utilize o Remove-Item cmdlet. 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, veja about_Profiles.

Um alias pode ser guardado e reutilizado noutra sessão do PowerShell ao efetuar uma exportação e importação. Para guardar um alias num ficheiro, utilize Export-Alias. Para adicionar um alias guardado a uma nova sessão do PowerShell, utilize Import-Alias.

Ligações Relacionadas

• about_Aliases
• about_Functions
• about_Profiles
• about_Scopes
• Export-Alias
• Get-Alias
• Import-Alias
• New-Alias
• Remove-Item