New-Alias
Cria um novo alias.
Sintaxe
Default (Predefinição)
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 Windows PowerShell. Os aliases criados usando Novo Alias não são salvos depois que você sai da sessão ou fecha o Windows PowerShell. Você pode usar o cmdlet Export-Alias para salvar suas informações de alias em um arquivo. Mais tarde, você pode usar Import-Alias para recuperar essas informações de alias salvas.
Exemplos
Exemplo 1: Criar um alias para um cmdlet
PS C:\> New-Alias -Name "List" Get-ChildItem
Este comando cria um alias chamado List para representar o cmdlet Get-ChildItem.
Exemplo 2: Criar um alias somente leitura para um cmdlet
PS C:\> New-Alias -Name "W" -Value Get-WmiObject -Description "quick wmi alias" -Option ReadOnly
PS C:\> Get-Alias -Name "W" | Format-List *
Este comando cria um alias chamado W para representar o cmdlet Get-WmiObject. 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 canalizá-lo para Format-List para exibir todas as informações sobre ele.
Parâmetros
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Cf. |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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 dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Force
Indica que o cmdlet age como Set-Alias se o alias nomeado já existir.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-Option
Especifica o valor da propriedade Opções de do alias. Os valores válidos são:
- Nenhum: o alias não tem restrições (valor padrão)
- Somente leitura: o alias pode ser excluído, mas não pode ser alterado, exceto usando o parâmetro Force
- Constante: O alias não pode ser excluído ou alterado
- Privado: o alias está disponível apenas no escopo atual
- AllScope: O alias é copiado para quaisquer novos escopos criados
- Não especificado: A opção não está especificada
Para ver a propriedade Opções
Propriedades dos parâmetros
| Tipo: | ScopedItemOptions |
| Default value: | [System.Management.Automation.ScopedItemOptions]::None |
| Valores aceites: | None, ReadOnly, Constant, Private, AllScope, Unspecified |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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 dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Scope
Especifica o escopo do novo alias. Os valores aceitáveis para este parâmetro são:
- A nível mundial
- Locais
- Script
- Um número relativo ao escopo atual (0 através do 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.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Value
Especifica o nome do cmdlet ou elemento de comando que está sendo aliased.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | 1 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | Wi |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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 canalizar a entrada para este cmdlet.
Saídas
None or System.Management.Automation.AliasInfo
Quando você usa o parâmetro Passthru, New-Alias gera um System.Management.Automation.AliasInfo objeto que representa o novo alias. Caso contrário, esse cmdlet não gerará nenhuma saída.
Notas
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.