Get-Alias

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

Obtém os aliases para a sessão atual.

Syntax

Get-Alias
   [[-Name] <String[]>]
   [-Exclude <String[]>]
   [-Scope <String>]
   [<CommonParameters>]
Get-Alias
   [-Exclude <String[]>]
   [-Scope <String>]
   [-Definition <String[]>]
   [<CommonParameters>]

Description

O Get-Alias cmdlet obtém os aliases na sessão atual. Isso inclui aliases internos, aliases que você definiu ou importou e aliases que você adicionou ao seu perfil do PowerShell.

Por padrão, Get-Alias usa um alias e retorna o nome do comando. Quando você usa o parâmetro Definition, Get-Alias usa um nome de comando e retorna seus aliases.

A partir do Windows PowerShell 3.0, Get-Alias exibe nomes de alias não hifenizados em um <alias> -> <definition> formato para facilitar ainda mais a localização das informações necessárias.

Exemplos

Exemplo 1: Obter todos os aliases na sessão atual

Get-Alias

CommandType     Name
-----------     ----
Alias           % -> ForEach-Object
Alias           ? -> Where-Object
Alias           ac -> Add-Content
Alias           asnp -> Add-PSSnapin
Alias           cat -> Get-Content
Alias           cd -> Set-Location
Alias           chdir -> Set-Location
Alias           clc -> Clear-Content
Alias           clear -> Clear-Host
Alias           clhy -> Clear-History
...

Este comando obtém todos os aliases na sessão atual.

A saída mostra o <alias> -> <definition> formato que foi introduzido no Windows PowerShell 3.0. Esse formato é usado apenas para aliases que não incluem hifens, pois aliases com hifens são geralmente nomes preferidos de cmdlets e funções, em vez de apelidos.

Exemplo 2: Obter aliases por nome

Get-Alias -Name gp*, sp* -Exclude *ps

Esse comando obtém todos os aliases que começam com gp ou sp, exceto os aliases que terminam com ps.

Exemplo 3: Obter aliases para um cmdlet

Get-Alias -Definition Get-ChildItem

Esse comando obtém os aliases para o Get-ChildItem cmdlet.

Por padrão, o Get-Alias cmdlet obtém o nome do item quando você conhece o alias. O parâmetro Definition obtém o alias quando você sabe o nome do item.

Exemplo 4: Obter aliases por propriedade

Get-Alias | Where-Object {$_.Options -Match "ReadOnly"}

Esse comando obtém todos os aliases nos quais o valor da propriedade Options é ReadOnly. Esse comando fornece uma maneira rápida de localizar os aliases internos do PowerShell, porque eles têm a opção ReadOnly .

Options é apenas uma propriedade dos objetos AliasInfo que Get-Alias obtém. Para localizar todas as propriedades e métodos de objetos AliasInfo , digite Get-Alias | get-member.

Exemplo 5: Obter aliases por nome e filtrar por letra inicial

Get-Alias -Definition "*-PSSession" -Exclude e* -Scope Global

Este exemplo obtém aliases para comandos com nomes que terminam em "-PSSession", exceto para aqueles que começam com "e".

O comando usa o parâmetro Scope para aplicar o comando no escopo global. Isso é útil em scripts quando você deseja obter os aliases na sessão.

Parâmetros

-Definition

Obtém os aliases para o item especificado. Digite o nome de um cmdlet, uma função, um script, um arquivo ou arquivo executável.

Esse parâmetro é chamado de Definition, porque ele procura o nome do item na propriedade Definition do objeto alias.

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

-Exclude

Omite os itens especificados. O valor desse parâmetro qualifica os parâmetros Name e Definition . Digite um nome, uma definição ou um padrão, como "s *". Caracteres curinga são permitidos.

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

-Name

Especifica os aliases que esse cmdlet obtém. Caracteres curinga são permitidos. Por padrão, Get-Alias recupera todos os aliases definidos para a sessão atual. O nome do parâmetro Name é opcional. Você também pode canalizar nomes de alias para Get-Alias.

Type:String[]
Position:0
Default value:All aliases
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Scope

Especifica o escopo para o qual esse cmdlet obtém aliases. Os valores aceitáveis para esse parâmetro são:

  • Global
  • Local
  • Script
  • Um número relativo ao escopo atual (0 até o 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.

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

Entradas

String

Você pode canalizar uma cadeia de caracteres contendo um nome de alias para esse cmdlet.

Saídas

AliasInfo

Esse cmdlet retorna um objeto que representa cada alias. Ele retorna o mesmo tipo de objeto para cada alias, mas o PowerShell usa um formato baseado em seta para exibir os nomes de aliases não hifenizados.

Observações

O Windows PowerShell inclui os seguintes aliases para Get-Alias:

  • gal

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

  • O formato de nome de alias com base em seta não é usado para aliases que incluem um hífen. Eles devem ser nomes substitutos preferenciais para cmdlets e funções, em vez de abreviações típicas ou apelidos.