Export-Alias

  • Riferimento
Modulo:
Microsoft.PowerShell.Utility

Esporta in un file le informazioni sugli alias attualmente definiti.

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 Export-Alias cmdlet esporta gli alias nella sessione corrente in un file. Se il file di output non esiste, il cmdlet lo creerà.

Export-Alias può esportare gli alias in un ambito specifico 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 sugli alias correnti 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 della 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 della 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 script generato Export-Alias .

Il primo comando esporta gli alias della sessione nel file Alias.ps1. Usa il parametro As con un valore script per generare un file che contiene un comando Set-Alias per ogni alias.

Il secondo comando aggiunge gli alias nel file Alias.ps1 al profilo CurrentUser-CurrentHost. Il percorso del profilo viene salvato nella $Profile variabile . Il comando usa il Get-Content cmdlet per ottenere gli alias dal file Alias.ps1 e il Add-Content cmdlet 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 New-PSSession cmdlet per creare la sessione. Il quarto comando usa il parametro FilePath del Invoke-Command cmdlet 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.

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

-As

Specifica il formato di output. Il valore predefinito è CSV. I valori validi per questo parametro sono:

  • CSV. formato con valori delimitati da virgole (CSV).
  • Script. Crea un Set-Alias comando per ogni alias esportato. Se al file di output si assegna un nome con estensione ps1, è possibile eseguirlo come script per aggiungere gli alias a qualsiasi sessione.
Type:ExportAliasFormat
Accepted values:Csv, Script
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Richiede conferma prima di eseguire il cmdlet.

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

-Description

Specifica la descrizione del file esportato. La descrizione viene visualizzata come commento all'inizio del file, dopo le informazioni di intestazione.

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

-Force

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

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

Per impostazione predefinita, Export-Alias sovrascrive i file senza avviso, a meno che l'attributo di sola lettura o nascosto 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 la sovrascrittura dei file con l'attributo nascosto.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 carattere 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.

Type:String
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

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

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

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

-NoClobber

Indica che questo cmdlet impedisce Export-Alias la sovrascrittura di qualsiasi file, anche se il parametro Force viene usato nel comando .

Se il parametro NoClobber viene omesso, Export-Alias sovrascriverà un file esistente senza avviso, a meno che l'attributo di sola lettura non sia impostato 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.

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

-PassThru

Restituisce un oggetto che rappresenta l'elemento in uso. Per impostazione predefinita, il cmdlet non genera alcun output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-Scope

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

  • Generale
  • Locale
  • 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.

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

-WhatIf

Mostra gli effetti dell'esecuzione del cmdlet. Il cmdlet non viene eseguito.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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 usa 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 esportare gli alias solo in un file.