Condividi tramite

Export-Alias

  • Riferimento
Modulo:
Microsoft.PowerShell.Utility

Esporta informazioni sugli alias attualmente definiti in un file.

Sintassi

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>]

Descrizione

Il cmdlet Export-Alias esporta gli alias nella sessione corrente in un file. Se il file di output non esiste, il cmdlet lo creerà.

Export-Alias possibile esportare gli alias in un determinato ambito o in tutti gli ambiti, può generare i dati in formato CSV o come una serie di comandi Set-Alias che è possibile aggiungere a una sessione o a un profilo di PowerShell.

Esempio

Esempio 1: Esportare un alias

Export-Alias -Path "Alias.csv"

Questo comando esporta le informazioni sull'alias corrente in un file denominato Alias.csv nella directory corrente.

Esempio 2: Esportare un alias a meno che il file di esportazione non esista già

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

Questo comando esporta gli alias nella sessione corrente in un file Alias.csv.

Poiché viene specificato il parametro NoClobber, il comando avrà esito negativo se esiste già un file Alias.csv nella directory corrente.

Esempio 3: Accodare alias a un file

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

Questo comando aggiunge gli alias nella sessione corrente al file Alias.csv.

Il comando usa il parametro description per aggiungere una descrizione ai commenti nella parte superiore del file.

Il comando usa anche il parametro force per sovrascrivere eventuali file di Alias.csv esistenti, anche se hanno l'attributo di sola lettura.

Esempio 4: Esportare alias come 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

In questo esempio viene illustrato come usare il formato di file di script generato Export-Alias.

Il primo comando esporta gli alias nella sessione nel file Alias.ps1. Usa il parametro As con il valore Script per generare un file contenente un comando Set-Alias per ogni alias.

Il secondo comando aggiunge gli alias nel file Alias.ps1 al profilo di CurrentUser-CurrentHost. Il percorso del profilo viene salvato nella variabile $PROFILE. Il comando usa il cmdlet Get-Content per ottenere gli alias dal file Alias.ps1 e dal cmdlet Add-Content per aggiungerli al profilo. Per altre informazioni, vedere about_Profiles.

Il terzo e il quarto comando aggiungono gli alias nel file Alias.ps1 a una sessione remota nel computer Server01. Il terzo comando usa il cmdlet New-PSSession per creare la sessione. Il quarto comando usa il parametro FilePath del cmdlet Invoke-Command per eseguire il file Alias.ps1 nella nuova sessione.

Parametri

-Append

Indica che questo cmdlet aggiunge l'output al file specificato, anziché sovrascrivere il contenuto esistente del file.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-As

Specifica il formato di output. CSV è l'impostazione predefinita. I valori accettabili per questo parametro sono:

  • CSV. Formato con valori delimitati da virgole (CSV).
  • Copione. Crea un comando Set-Alias per ogni alias esportato. Se si assegna un nome al file di output con un'estensione .ps1 nome file, è possibile eseguirlo come script per aggiungere gli alias a qualsiasi sessione.
Tipo:ExportAliasFormat
Valori accettati:Csv, Script
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Tipo:SwitchParameter
Alias:cf
Posizione:Named
Valore predefinito:False
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Description

Specifica la descrizione del file esportato. La descrizione viene visualizzata come commento nella parte superiore del file, seguendo le informazioni sull'intestazione.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Force

Forza l'esecuzione del comando senza chiedere conferma dell'utente.

Sovrascrive il file di output, anche se l'attributo di sola lettura è impostato nel file.

Per impostazione predefinita, Export-Alias sovrascrive i file senza avviso, a meno che l'attributo nascosto o di sola lettura non sia impostato o che il parametro NoClobber venga usato nel comando. Il parametro NoClobber ha la precedenza sul parametro Force quando entrambi vengono usati in un comando.

Il parametro Force non può forzare Export-Alias sovrascrivere i file con l'attributo nascosto.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-LiteralPath

Specifica il percorso del file di output. A differenza di Path, il valore del parametro LiteralPath viene usato esattamente come viene tipizzato. Nessun carattere viene interpretato come caratteri jolly. Se il percorso include caratteri di escape, racchiuderlo tra virgolette singole. Le virgolette singole indicano a PowerShell di non interpretare alcun carattere come sequenze di escape.

Tipo:String
Alias:PSPath, LP
Posizione:Named
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:True
Accettare caratteri jolly:False

-Name

Specifica i nomi come matrice degli alias da esportare. Sono consentiti caratteri jolly.

Per impostazione predefinita, Export-Alias esporta tutti gli alias nella sessione o nell'ambito.

Tipo:String[]
Posizione:1
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:True
Accettare caratteri jolly:True

-NoClobber

Indica che questo cmdlet impedisce Export-Alias di sovrascrivere i file, anche se nel comando viene utilizzato il parametro Force.

Se il parametro NoClobber viene omesso, Export-Alias sovrascriverà un file esistente senza avviso, a meno che non sia impostato l'attributo di sola lettura nel file. NoClobber ha la precedenza sul parametro Force, che consente Export-Alias di sovrascrivere un file con l'attributo di sola lettura.

NoClobber non impedisce al parametro append di aggiungere contenuto a un file esistente.

Tipo:SwitchParameter
Alias:NoOverwrite
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-PassThru

Restituisce un oggetto che rappresenta l'elemento con cui si sta lavorando. Per impostazione predefinita, questo cmdlet non genera alcun output.

Tipo:SwitchParameter
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-Path

Specifica il percorso del file di output. I caratteri jolly sono consentiti, ma il valore del percorso risultante deve essere risolto in un singolo nome file.

Tipo:String
Posizione:0
Valore predefinito:None
Necessario:True
Accettare l'input della pipeline:False
Accettare caratteri jolly:True

-Scope

Specifica l'ambito da cui devono essere esportati gli alias. I valori accettabili per questo parametro sono:

  • Global
  • Local
  • Script
  • Numero relativo all'ambito corrente (da 0 al numero di ambiti in cui 0 è l'ambito corrente e 1 è il relativo elemento padre)

Il valore predefinito è Local. Per altre informazioni, vedere about_Scopes.

Tipo:String
Posizione:Named
Valore predefinito:None
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

-WhatIf

Mostra cosa accadrebbe se il cmdlet viene eseguito. Il cmdlet non viene eseguito.

Tipo:SwitchParameter
Alias:wi
Posizione:Named
Valore predefinito:False
Necessario:False
Accettare l'input della pipeline:False
Accettare caratteri jolly:False

Input

None

Non è possibile inviare tramite pipe oggetti a questo cmdlet.

Output

None

Per impostazione predefinita, questo cmdlet non restituisce alcun output.

AliasInfo

Quando si utilizza il parametro PassThru, questo cmdlet restituisce un oggetto aliasInfo che rappresenta l'alias.

Note

PowerShell include gli alias seguenti per Export-Alias:

  • Tutte le piattaforme:
    • epal
  • È possibile Export-Aliases solo in un file.