Export-Alias

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

Exporta as informações sobre aliases definidos atualmente para um arquivo.

Sintaxe

Export-Alias
      [-Path] <String>
      [[-Name] <String[]>]
      [-PassThru]
      [-As <ExportAliasFormat>]
      [-Append]
      [-Force]
      [-NoClobber]
      [-Description <String>]
      [-Scope <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Export-Alias
      -LiteralPath <String>
      [[-Name] <String[]>]
      [-PassThru]
      [-As <ExportAliasFormat>]
      [-Append]
      [-Force]
      [-NoClobber]
      [-Description <String>]
      [-Scope <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O Export-Alias cmdlet exporta os aliases na sessão atual para um arquivo. Se o arquivo de saída não existe, o cmdlet o cria.

Export-Alias pode exportar os aliases em um escopo específico ou em todos os escopos, pode gerar os dados no formato CSV ou como uma série de comandos Set-Alias que você pode adicionar a uma sessão ou a um perfil do PowerShell.

Exemplos

Exemplo 1: Exportar um alias

Export-Alias -Path "alias.csv"

Este comando exporta as informações atuais de alias em um arquivo chamado Alias.csv no diretório atual.

Exemplo 2: Exportar um alias, a menos que o arquivo de exportação já exista

Export-Alias -Path "alias.csv" -NoClobber

Esse comando exporta os aliases na sessão atual para um arquivo Alias.csv.

Como o parâmetro NoClobber é especificado, o comando falhará se um arquivo Alias.csv já existir no diretório atual.

Exemplo 3: Acrescentar aliases a um arquivo

Export-Alias -Path "alias.csv" -Append -Description "Appended Aliases" -Force

Este comando anexa os aliases na sessão atual ao arquivo Alias.csv.

O comando usa o parâmetro Description para adicionar uma descrição aos comentários na parte superior do arquivo.

O comando também usa o parâmetro Force para substituir todos os arquivos Alias.csv existentes, mesmo que eles tenham o atributo somente leitura.

Exemplo 4: Exportar aliases como um script

Export-Alias -Path "alias.ps1" -As Script
Add-Content -Path $Profile -Value (Get-Content alias.ps1)
$S = New-PSSession -ComputerName Server01
Invoke-Command -Session $S -FilePath .\alias.ps1

Este exemplo mostra como usar o formato de arquivo de script gerado Export-Alias .

O primeiro comando exporta os aliases da sessão para o arquivo Alias.ps1. Ele usa o parâmetro As com um valor de Script para gerar um arquivo que contém um comando Set-Alias para cada alias.

O segundo comando adiciona os alias no arquivo Alias.ps1 ao perfil CurrentUser-CurrentHost. O caminho para o perfil é salvo na $Profile variável. O comando usa o Get-Content cmdlet para obter os aliases do arquivo Alias.ps1 e o Add-Content cmdlet para adicioná-los ao perfil. Para obter mais informações, consulte about_Profiles.

Os terceiro e o quarto comandos adicionam os aliases no arquivo Alias.ps1 a uma sessão remota no computador Server01. O terceiro comando usa o New-PSSession cmdlet para criar a sessão. O quarto comando usa o parâmetro FilePath do Invoke-Command cmdlet para executar o arquivo Alias.ps1 na nova sessão.

Parâmetros

-Append

Indica que esse cmdlet acrescenta a saída ao arquivo especificado, em vez de substituir o conteúdo existente desse arquivo.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-As

Especifica o formato de saída. CSV é o padrão. Os valores aceitáveis para esse parâmetro são:

  • CSV. Formato de valores separados por vírgulas (CSV).
  • Script. Cria um Set-Alias comando para cada alias exportado. Se você nomear o arquivo de saída com uma extensão de nome de arquivo .ps1, poderá executá-lo como um script para adicionar os aliases a qualquer sessão.
Tipo:ExportAliasFormat
Valores aceitos:Csv, Script
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Confirm

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

Tipo:SwitchParameter
Aliases:cf
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Description

Especifica a descrição do arquivo exportado. A descrição aparecerá como um comentário na parte superior do arquivo, após as informações de cabeçalho.

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Force

Força o comando a ser executado sem solicitar a confirmação do usuário.

Substitui o arquivo de saída, mesmo se o atributo somente leitura estiver definido no arquivo.

Por padrão, Export-Alias substitui arquivos sem aviso, a menos que o atributo somente leitura ou oculto seja definido ou o parâmetro NoClobber seja usado no comando. O parâmetro NoClobber tem precedência sobre o parâmetro Force quando ambos são usados em um comando.

O parâmetro Force não pode forçar Export-Alias a substituição de arquivos com o atributo oculto.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-LiteralPath

Especifica o caminho para o arquivo de saída. Ao contrário de Path, o valor do parâmetro LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. As aspas simples informam ao PowerShell para não interpretar nenhum caractere como sequências de escape.

Tipo:String
Aliases:PSPath
Cargo:Named
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-Name

Especifica os nomes como uma matriz dos aliases a serem exportados. Caracteres curinga são permitidos.

Por padrão, Export-Alias exporta todos os aliases na sessão ou no escopo.

Tipo:String[]
Cargo:1
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:True

-NoClobber

Indica que esse cmdlet impede Export-Alias a substituição de arquivos, mesmo que o parâmetro Force seja usado no comando.

Se o parâmetro NoClobber for omitido, Export-Alias o substituirá um arquivo existente sem aviso, a menos que o atributo somente leitura seja definido no arquivo. NoClobber tem precedência sobre o parâmetro Force , que permite Export-Alias sobrescrever um arquivo com o atributo somente leitura.

NoClobber não impede que o parâmetro Append adicione conteúdo a um arquivo existente.

Tipo:SwitchParameter
Aliases:NoOverwrite
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-PassThru

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

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Path

Especifica o caminho para o arquivo de saída. Caracteres curinga são permitidos, mas o valor do caminho resultante deve ser resolvido para um único nome de arquivo.

Tipo:String
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:True

-Scope

Especifica o escopo do qual os aliases devem ser exportados. 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 em que 0 é o escopo atual e 1 é seu pai)

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

Tipo:String
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-WhatIf

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

Tipo:SwitchParameter
Aliases:wi
Cargo:Named
Valor padrão:False
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

None

Você não pode 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 alias.

Observações

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

  • epal
  • Somente é possível usar o Export-Alias para exportar aliases para um arquivo.