Compartilhar via

New-Alias

Módulo:
Microsoft.PowerShell.Utility Module

Cria um novo alias.

Sintaxe

Default (Default) 

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

Description

O cmdlet New-Alias cria um novo alias na sessão atual do PowerShell. Os aliases criados usando New-Alias não são salvos após você sair da sessão ou fechar o PowerShell. Você pode usar o cmdlet Export-Alias para salvar suas informações de alias em um arquivo. Posteriormente, você pode usar Import-Alias 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 Lista 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 chamado C para representar o cmdlet Get-ChildItem. Ele cria uma descrição, quick gci alias, 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.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Force

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Name

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

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes: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 qualquer novo escopo criado.
  • Unspecified: A opção não é especificada

Esses valores são definidos como uma enumeração baseada em sinalizador. Você pode combinar vários valores para definir vários sinalizadores usando esse parâmetro. Os valores podem ser passados para a opção parâmetro 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 binária-OR. Passar valores como uma matriz é a opção mais simples e também permite usar o preenchimento com Tab nos valores.

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

Propriedades do parâmetro

Tipo:ScopedItemOptions
Valor padrão:[System.Management.Automation.ScopedItemOptions]::None
Valores aceitos:None, ReadOnly, Constant, Private, AllScope, Unspecified
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PassThru

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Scope

Especifica o escopo do novo alias. Os valores aceitáveis para este parâmetro são:

  • Global
  • Local
  • Script
  • Um número relativo ao escopo atual (0 por meio do número de escopos, em que 0 é o escopo atual e 1 é seu pai).

Local é o padrão. Para obter mais informações, consulte about_Scopes.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Value

Especifica o nome do cmdlet ou do elemento de comando que está sendo aliased.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:1
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-WhatIf

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

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

None

Não é possível transferir 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 PowerShell inclui os seguintes aliases para New-Alias:

  • Todas as plataformas:

    • 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-Alias.