Set-Alias

Cria ou altera um alias (nome alternativo) para um cmdlet ou outro elemento de comando na sessão atual do Windows PowerShell.

Sintaxe

Set-Alias [-Name] <string> [-Value] <string> [-Descrição <string>] [-Force] [-Option {<None> | <ReadOnly> | <Constant> | <Private> | <AllScope>}] [-PassThru] [-Scope <string>] [-Confirm] [-WhatIf] [<CommonParameters>]

Descrição

O cmdlet Set-Alias cria ou altera um alias (nome alternativo) para um cmdlet ou um elemento de comando, como função, script, arquivo ou outro executável. Você também pode usar Set-Alias para reatribuir um alias atual a um novo comando ou para alterar qualquer uma das propriedades de um alias, como sua descrição. A não ser que você adicione o alias ao perfil do Windows PowerShell, as alterações a um alias serão perdidas quando você sair da sessão ou fechar o Windows PowerShell.

Parâmetros

-Descrição <string>

Especifica uma descrição do alias. Você pode digitar qualquer cadeia de caracteres. Se a descrição incluir espaços, coloque-a entre aspas.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Force

Permite que o cmdlet defina um alias somente leitura. Use o parâmetro Option para criar um alias somente leitura. O parâmetro Force não pode definir um alias frequente.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Name <string>

Especifica o novo alias. Você pode usar caracteres alfanuméricos em um alias, mas o primeiro caractere não pode ser um número.

Necessário?	true
Posição?	1
Valor padrão
Aceitar entrada do pipeline?	true (ByPropertyName)
Aceitar caracteres curinga?	false

-Option <ScopedItemOptions>

Define o valor da propriedade Options do alias.

Os valores válidos são:

-- None: não define nenhuma opção. (padrão)

-- ReadOnly: as propriedades do alias não podem ser alteradas, exceto ao usar o parâmetro Force. É possível usar Remove-Item para excluir o alias.

-- Constant: o alias não pode ser excluído e suas propriedades não podem ser alteradas. Constant está disponível apenas quando você está criando um alias. Não é possível alterar a opção de um alias existente para Constant.

-- Private: o alias está disponível apenas no escopo especificado pelo parâmetro Scope. Ele não está visível em todos os outros escopos.

-- AllScope: o alias é copiado em qualquer novo escopo criado.

Para visualizar a propriedade Options dos aliases, digite "Get-Alias | Format-Table -property Name, Definition, Options -autosize".

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-PassThru

Retorna um objeto que representa o alias. Por padrão, este cmdlet não gera nenhuma saída.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Scope <string>

Especifica o escopo no qual este alias é válido. Os valores válidos são "Global", "Local" ou "Script" ou um número relativo ao atual escopo (0 ao número de escopos, onde 0 é o escopo atual e 1 é seu pai). "Local" é o padrão. Para obter mais informações, consulte about_Scopes.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-Value <string>

Especifica o nome do cmdlet ou elemento do comando que está passando por alias.

Necessário?	true
Posição?	2
Valor padrão
Aceitar entrada do pipeline?	true (ByPropertyName)
Aceitar caracteres curinga?	false

-Confirm

Solicita confirmação antes da execução do comando.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

-WhatIf

Descreve o que aconteceria se você executasse o comando, sem executá-lo de fato.

Necessário?	false
Posição?	named
Valor padrão
Aceitar entrada do pipeline?	false
Aceitar caracteres curinga?	false

<CommonParameters>

Esse cmdlet oferece suporte aos parâmetros comuns: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer e -OutVariable. Para obter mais informações, consulte about_Commonparameters.

Entradas e saídas

O tipo de entrada é o tipo dos objetos que você pode canalizar para o cmdlet. O tipo de retorno é o tipo dos objetos que o cmdlet retorna.

Entradas	Nenhum Você não pode canalizar a entrada para este cmdlet.
Saídas	Nenhum ou System.Management.Automation.AliasInfo Quando você usa o parâmetro PassThru, Set-Alias gera um objeto System.Management.Automation.AliasInfo que representa o alias. Caso contrário, esse cmdlet não gera nenhuma saída.

Observações

Um alias é um nome alternativo ou apelido para um cmdlet ou elemento de comando. Para executar o cmdlet, você pode usar seu nome completo ou qualquer alias válido. Para obter mais informações, consulte about_Aliases.

Para criar um novo alias, use Set-Alias ou New-Alias. Para excluir um alias, use Remove-Item.

Um cmdlet pode ter vários aliases, mas um alias pode ser associado a somente um cmdlet por vez. Se você usar set-alias para associar o alias a um cmdlet diferente, ele não estará mais associado ao cmdlet original.

Você pode criar um alias para um cmdlet, mas não pode criar um alias para um comando com parâmetros e valores. Por exemplo, você pode criar um alias para Set-Location, mas não pode criar um alias para "Set-Location 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 salvar os aliases de uma sessão e usá-los em outra sessão, adicione o comando set-alias ao seu perfil do Windows PowerShell. Por padrão, os perfis não existem. Para criar um perfil no caminho armazenado na variável $profile, digite "New-Item -type file -force $profile". Para exibir o valor da variável $profile, digite "$profile".

Você também pode salvar seus aliases usando Export-Alias para copiar os aliases da sessão para um arquivo e, depois, usar Import-Alias para adicioná-los à lista de alias de uma nova sessão.

Você também pode fazer referência Set-Alias usando seu alias interno, "sal". Para obter mais informações, consulte about_Aliases.

Exemplo 1

C:\PS>set-alias -name list -value get-childitem

Descrição
-----------
Esse comando cria o alias "list" para o cmdlet Get-ChildItem. Depois de criar o alias, você pode usar "list" no lugar de "Get-ChildItem" na linha de comando e em scripts.

Exemplo 2

C:\PS>set-alias list get-location

Descrição
-----------
Esse comando associa o alias "list" ao cmdlet Get-Location. Se "list" for um alias de outro cmdlet, esse comando irá alterar sua associação de modo que ele passe a ser o alias somente de Get-Location.

Este comando usa o mesmo formato que o comando no exemplo anterior, mas omite os nomes dos parâmetros opcionais, -Name e -Value. Quando você omitir os nomes dos parâmetros, os valores desses parâmetros deverão aparecer na ordem especificada no comando. Nesse caso, o valor de -Name ("list") deve ser o primeiro parâmetro e o valor de -Value ("get-location") deve ser o segundo parâmetro.

Exemplo 3

C:\PS>set-alias scrub remove-item -option readonly -passthru | format-list

Descrição
-----------
Esse comando associa o alias "scrub" ao cmdlet Remove-Item. Ele usa a opção "ReadOnly" para evitar que o alias seja excluído ou atribuído a outro cmdlet.

O parâmetro PassThru direciona o Windows PowerShell para passar um objeto que represente o novo alias através do pipeline para o cmdlet Format-List. Se o parâmetro PassThru fosse omitido, não haveria saída desse cmdlet a ser exibida (em uma lista ou de outra forma).

Exemplo 4

C:\PS>Set-Alias np c:\windows\notepad.exe

Descrição
-----------
Este comando associa o alias "np" ao arquivo executável do Bloco de notas. Após o comando ser concluído, para abrir o Bloco de notas a partir da linha de comando do Windows PowerShell, basta digitar "np".

Esse exemplo demonstra que você pode criar aliases de arquivos executáveis e elementos que não sejam cmdlets.

Para que o comando seja mais genérico, você pode usar a variável de ambiente "Windir" (${env:windir}) para representar o diretório C\Windows. A versão genérica do comando é "set-alias np ${env:windir}\notepad.exe".

Exemplo 5

C:\PS>function CD32 {set-location c:\windows\system32}

C:\PS>set-alias go cd32

Descrição
-----------
Esses comandos mostram como atribuir um alias a um comando com parâmetros ou até mesmo a um pipeline de muitos comandos.

Você pode criar um alias para um cmdlet, mas não pode criar um alias para um comando que consista em um cmdlet e seus parâmetros. No entanto, se você posicionar o comando em uma função ou script, você pode criar uma função útil ou o nome de script e criar um ou mais aliases para essa função ou script.

Neste exemplo, o usuário deseja criar um alias para o comando "set-location c:\windows\system32", onde "set-location" é um cmdlet e "C:\Windows\System32" é o valor do parâmetro Path. 

Para isso, o primeiro comando cria uma função denominada "CD32" que contém o comando Set-Location.

O segundo comando cria o alias "go" para a função CD32. Em seguida, para executar o comando Set-Location, o usuário pode digitar "CD32" ou "go".

Consulte também

Conceitos

Get-Alias
New-Alias
Export-Alias
Import-Alias