Condividi tramite

Export-Alias

Modulo:
Microsoft.PowerShell.Utility Module

Esporta informazioni sugli alias attualmente definiti in un file.

Sintassi

ByPath (Impostazione predefinita) 

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

ByLiteralPath 

Export-Alias
    [[-Name] <String[]>]
    -LiteralPath <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 è in grado di esportare gli alias in un determinato ambito o in tutti gli ambiti e può generare i dati sia in formato CSV che come una serie di comandi Set-Alias, i quali è 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é il parametro NoClobber viene specificato, 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 utilizza 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

Questo esempio mostra come usare il formato di file di script generato da Export-Alias.

Il primo comando esporta gli alias dalla sessione al 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 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.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti: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.

Proprietà dei parametri

Tipo:ExportAliasFormat
Valore predefinito:None
Valori accettati:Csv, Script
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Confirm

Richiede conferma prima di eseguire il cmdlet.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False
Alias:cfr

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-Description

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

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti: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, 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 a sovrascrivere i file con l'attributo nascosto.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-LiteralPath

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

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:PSPath

Set di parametri

ByLiteralPath
Posizione:Named
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Name

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

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

Proprietà dei parametri

Tipo:

String[]

Valore predefinito:None
Supporta i caratteri jolly:True
DontShow:False

Set di parametri

(All)
Posizione:1
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-NoClobber

Indica che questo cmdlet impedisce a Export-Alias di sovrascrivere qualsiasi 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.

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False
Alias:NoOverwrite

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-PassThru

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

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti: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.

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:True
DontShow:False

Set di parametri

ByPath
Posizione:0
Obbligatorio:True
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-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 fino al numero totale di ambiti, dove 0 rappresenta l'ambito corrente e 1 il suo ambito padre)

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

Proprietà dei parametri

Tipo:String
Valore predefinito:None
Supporta i caratteri jolly:False
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

-WhatIf

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

Proprietà dei parametri

Tipo:SwitchParameter
Valore predefinito:False
Supporta i caratteri jolly:False
DontShow:False
Alias:Wi

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:False
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

None

Gli oggetti non possono essere inviati tramite pipe 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

Windows PowerShell include gli alias seguenti per Export-Alias:

  • epal
  • È possibile solo Export-Aliases in un file.