New-Alias

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

Cria um novo alias.

Syntax

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

Description

O New-Alias cmdlet cria um novo alias na sessão atual do Windows PowerShell. Os aliases criados usando New-Alias não são salvos depois que você sai da sessão ou fecha o Windows PowerShell. Você pode usar o Export-Alias cmdlet para salvar suas informações de alias em um arquivo. Você pode usar Import-Alias posteriormente para recuperar as informações de alias salvas.

Exemplos

Exemplo 1: Criar um alias para um cmdlet

New-Alias -Name "List" Get-ChildItem

Esse comando cria um alias chamado List para representar o cmdlet Get-ChildItem.

Exemplo 2: Criar um alias somente leitura para um cmdlet

New-Alias -Name "C" -Value Get-ChildItem -Description "quick gci alias" -Option ReadOnly
Get-Alias -Name "C" | Format-List *

Esse comando cria um alias nomeado C para representar o Get-ChildItem cmdlet. Ele cria uma descrição, alias wmi rápido, para o alias e o torna somente leitura. A última linha do comando usa Get-Alias para obter o novo alias e o canaliza para Format-List para exibir todas as informações sobre ele.

Parâmetros

-Confirm

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

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

-Description

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

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

-Force

Indica que o cmdlet age como Set-Alias se o alias nomeado já existisse.

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

-Name

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

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

-Option

Especifica o valor da propriedade Options do alias. Os valores válidos são:

  • None: O alias não tem restrições (valor padrão)
  • ReadOnly: O alias pode ser excluído, mas não pode ser alterado, exceto usando o parâmetro Force
  • Constant: O alias não pode ser excluído ou alterado
  • Private: O alias está disponível somente no escopo atual
  • AllScope: O alias é copiado para todos os novos escopos criados
  • Unspecified: A opção não está especificada

Esses valores são definidos como uma enumeração baseada em sinalizador. Você pode combinar vários valores juntos para definir vários sinalizadores usando esse parâmetro. Os valores podem ser passados para o parâmetro Option como uma matriz de valores ou como uma cadeia de caracteres separada por vírgulas desses valores. O cmdlet combinará os valores usando uma operação binary-OR. Passar valores como uma matriz é a opção mais simples e também permite que você use a conclusão de tabulação nos valores.

Para ver a propriedade Options de todos os aliases na sessão, digite Get-Alias | Format-Table -Property Name, Options -AutoSize.

Type:ScopedItemOptions
Accepted values:None, ReadOnly, Constant, Private, AllScope, Unspecified
Position:Named
Default value:[System.Management.Automation.ScopedItemOptions]::None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Retorna um objeto que representa o item com que você está trabalhando. Por padrão, este cmdlet não gera saída.

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

-Scope

Especifica o escopo do novo alias. 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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Value

Especifica o nome do elemento de comando ou de cmdlet que está recebendo o alias.

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

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

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

Entradas

None

Não é possível canalizar objetos para esse cmdlet.

Saídas

None

Por padrão, esse cmdlet não retorna nenhuma saída.

AliasInfo

Quando você usa o parâmetro PassThru , esse cmdlet retorna um objeto AliasInfo que representa o novo alias.

Observações

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

  • nal

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