Set-Alias

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Cria ou altera um alias para um cmdlet ou outro comando na sessão atual do PowerShell.

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, veja 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: Criar 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 Name especifica o nome do alias, list. O parâmetro Value 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 Name 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 Value associa o alias ao Get-Location cmdlet .

O Get-Alias cmdlet utiliza o parâmetro Name 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: Criar 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 Name especifica o nome do alias, loc. O parâmetro Value 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 Force é necessário porque o alias loc é só de leitura. Se o parâmetro Force não for utilizado, a alteração falhará.

Exemplo 4: Criar um alias para 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 Name especifica o nome do alias, np. O parâmetro Value especifica o caminho e o nome da aplicaçãoC:\Windows\notepad.exe. O Get-Alias cmdlet utiliza o parâmetro Name para mostrar que o alias np está associado a notepad.exe.

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

Exemplo 5: Criar 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, veja about_Functions.

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

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 Path 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 Name especifica o nome do alias, Go. O parâmetro Value 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.

Exemplo 6: Opções de atualização para um alias existente

Este exemplo mostra como atribuir várias opções com o parâmetro Opção .

Com o exemplo acima, vamos definir o alias Go como ReadOnly e Private.

Set-Alias -Name Go -Option ReadOnly, Private

O alias Go já deve existir. Depois de executar o comando acima, o alias não pode ser alterado sem utilizar o parâmetro Force e só está disponível no âmbito atual.

Parâmetros

-Confirm

Solicita a sua confirmação antes de executar o cmdlet.

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

-Description

Especifica uma descrição do alias. Pode escrever qualquer cadeia. Se a descrição incluir espaços, coloque aspas simples.

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

-Force

Utilize o parâmetro Forçar para alterar ou eliminar um alias que tenha o parâmetro Opção definido como ReadOnly.

O parâmetro Force não pode alterar ou eliminar um alias com o parâmetro Opção definido como Constante.

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

-Name

Especifica o nome de um novo alias. Um nome de alias pode conter carateres alfanuméricos e hífenes. Os nomes de alias não podem ser numéricos, como 123.

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

-Option

Define o valor da propriedade Opção do alias. Valores como ReadOnly e Constant protegem um alias de alterações não intencionais. Para ver a propriedade Opção de todos os aliases na sessão, escreva Get-Alias | Format-Table -Property Name, Options -Autosize.

Os valores aceitáveis para este parâmetro são os seguintes:

  • AllScope - O alias é copiado para quaisquer novos âmbitos criados.
  • Constant - Não é possível alterar ou eliminar.
  • None - Não define opções e é a predefinição.
  • Private - O alias só está disponível no âmbito atual.
  • ReadOnly - Não é possível alterar ou eliminar, a menos que o parâmetro Force seja utilizado.
  • Unspecified

Estes valores são definidos como uma enumeração baseada em sinalizador. Pode combinar múltiplos valores para definir vários sinalizadores com este parâmetro. Os valores podem ser transmitidos para o parâmetro Opção como uma matriz de valores ou como uma cadeia separada por vírgulas desses valores. O cmdlet irá combinar os valores com uma operação binary-OR. Transmitir valores como uma matriz é a opção mais simples e também lhe permite utilizar a conclusão de separadores nos valores.

Type:ScopedItemOptions
Accepted values:AllScope, Constant, None, Private, ReadOnly, Unspecified
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Devolve um objeto que representa o alias. Utilize um cmdlet de formato, como Format-List para apresentar o objeto. Por predefinição, Set-Alias não gera nenhuma saída.

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

-Scope

Especifica o âmbito no qual este alias é válido. O valor predefinido é Local. Para obter mais informações, veja about_Scopes.

Os valores aceitáveis são os seguintes:

  • Global
  • Local
  • Privado
  • Âmbitos numerados
  • Script
Type:String
Accepted values:Global, Local, Private, Numbered scopes, Script
Position:Named
Default value:Local
Accept pipeline input:False
Accept wildcard characters:False

-Value

Especifica o nome do cmdlet ou comando que o alias executa. O parâmetro Value é a propriedade Definition do alias.

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

-WhatIf

Apresenta o que aconteceria mediante a execução do cmdlet. O cmdlet não é executado.

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

Entradas

None

Não pode encaminhar objetos para este cmdlet.

Saídas

None

Por predefinição, este cmdlet não devolve nenhuma saída.

AliasInfo

Quando utiliza o parâmetro PassThru , este cmdlet devolve um objeto AliasInfo que representa o alias.

Notas

O PowerShell inclui os seguintes aliases para Set-Alias:

  • Todas as plataformas:
    • sal

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 alias, utilize os cmdlets Set-Alias ou New-Alias. No PowerShell 6, para eliminar um alias, utilize o Remove-Alias cmdlet . Remove-Item é aceite para retrocompatibilidade, como para scripts criados com versões anteriores do PowerShell. Utilize um comando como 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 fazer 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.