Exportiert Informationen über gegenwärtig definierte Aliase in eine Datei.
Syntax
Export-Alias [-Path] <string> [[-Name] <string[]>] [-Append] [-As {<Csv> | <Script>}] [-Beschreibung <string>] [-Force] [-NoClobber] [-PassThru] [-Scope <string>] [-Bestätigung] [-WhatIf] [<CommonParameters>]
Beschreibung
Mit dem Cmdlet "Export-Alias" werden die Aliase in der aktuellen Sitzung in eine Datei exportiert. Wenn die Ausgabedatei nicht vorhanden ist, wird sie vom Cmdlet erstellt.
Mit Export-Alias können die Aliase in einem bestimmten Bereich oder in allen Bereichen exportiert werden, und die Daten können im CSV-Format oder als eine Reihe von Set-Alias-Befehlen, die Sie einer Sitzung oder einem Windows PowerShell-Profil hinzufügen können, generiert werden.
Parameter
-Append
Fügt die Ausgabe an die angegebene Datei an und überschreibt nicht den Inhalt dieser Datei.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-As <ExportAliasFormat>
Bestimmt das Ausgabeformat. CSV ist das Standardformat.
Gültige Werte:
– CSV: CSV (Comma-Separated Value)-Format.
– Script: Erstellt den Befehl "Set-Alias" für jeden exportierten Alias. Wenn Sie für die Ausgabedatei die Dateinamenerweiterung ".ps1" verwenden, können Sie sie als Skript ausführen, um einer beliebigen Sitzung die Aliase hinzuzufügen.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-Beschreibung <string>
Fügt der exportierten Datei eine Beschreibung hinzu. Die Beschreibung wird am Anfang der Datei nach den Headerinformationen als Kommentar angezeigt.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-Force
Überschreibt die Ausgabedatei, auch wenn für die Datei das Schreibschutzattribut festgelegt ist.
Standardmäßig werden mit Export-Alias Dateien ohne Warnung überschrieben, sofern nicht das Schreibschutzattribut oder Hidden-Attribut festgelegt ist oder der NoClobber-Parameter in dem Befehl verwendet wird. Der NoClobber-Parameter hat Vorrang vor dem Force-Parameter, wenn beide Parameter in einem Befehl verwendet werden.
Mit dem Force-Parameter kann nicht erzwungen werden, dass mit Export-Alias Dateien überschrieben werden, die das Hidden-Attribut aufweisen.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
Does not overwrite read-only files. |
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-Name <string[]>
Gibt die Namen der zu exportierenden Aliase an. Platzhalter sind zulässig.
Standardmäßig werden mit Export-Alias alle Aliase in der Sitzung oder dem Bereich exportiert.
|
Erforderlich? |
false |
|
Position? |
2 |
|
Standardwert |
Export all aliases |
|
Pipelineeingaben akzeptieren? |
true (ByPropertyName) |
|
Platzhalterzeichen akzeptieren? |
false |
-NoClobber
Verhindert, dass mit Export-Alias Dateien überschrieben werden, auch wenn der Force-Parameter im Befehl verwendet wird.
Wenn der NoClobber-Parameter weggelassen wird, überschreibt Export-Alias eine vorhandene Datei ohne Warnung, es sein denn, für die Datei ist das Schreibschutzattribut festgelegt. NoClobber hat Vorrang vor dem Force-Parameter. Daher kann Export-Alias Dateien mit dem Schreibschutzattribut überschreiben.
NoClobber verhindert nicht, dass einer vorhandenen Datei mit dem Append-Parameter Inhalt hinzugefügt wird.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
Overwrites read-write files. |
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-PassThru
Gibt Objekte zurück, die die exportierten Aliase darstellen. Standardmäßig wird von diesem Cmdlet keine Ausgabe generiert.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
No output |
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-Path <string>
Gibt den Pfad der Ausgabedatei an. Platzhalter sind zulässig, jedoch muss der resultierende Pfadwert in einen einzelnen Dateinamen aufgelöst werden können. Dieser Parameter ist erforderlich.
|
Erforderlich? |
true |
|
Position? |
1 |
|
Standardwert |
keine |
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-Scope <string>
Gibt den Bereich an, aus dem die Aliase exportiert werden sollen.
Gültige Werte sind "Global", "Local", "Script" oder eine Zahl relativ zum aktuellen Bereich (0 bis zur Anzahl der Bereiche, wobei 0 der aktuelle Bereich und 1 der übergeordnete Bereich ist). Der Standardwert ist "local". Weitere Informationen finden Sie unter "about_Scopes".
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
Local |
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-Bestätigung
Fordert Sie vor der Ausführung des Befehls zur Bestätigung auf.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
-WhatIf
Beschreibt die Auswirkungen einer Ausführung des Befehls, ohne den Befehl tatsächlich auszuführen.
|
Erforderlich? |
false |
|
Position? |
named |
|
Standardwert |
|
|
Pipelineeingaben akzeptieren? |
false |
|
Platzhalterzeichen akzeptieren? |
false |
<CommonParameters>
Dieses Cmdlet unterstützt die folgenden allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer und -OutVariable. Weitere Informationen finden Sie unter about_Commonparameters.
Eingaben und Ausgaben
Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können. Der Rückgabetyp ist der Typ der Objekte, die das Cmdlet zurückgibt.
|
Eingaben |
Keine. Objekte können nicht über die Pipeline an dieses Cmdlet übergeben werden. |
|
Ausgaben |
Keiner oder System.Management.Automation.AliasInfo Wenn Sie den Passthru-Parameter verwenden, gibt Export-Alias ein System.Management.Automation.AliasInfo-Objekt zurück, das den Alias darstellt. Andernfalls wird von diesem Cmdlet keine Ausgabe generiert. |
Hinweise
Mit Export-Alias können Aliase nur in eine Datei exportiert werden.
Beispiel 1
C:\PS>export-alias -path alias.csv Beschreibung ----------- Mit diesem Befehl werden aktuelle Aliasinformationen in die Datei "Alias.csv" im aktuellen Verzeichnis exportiert.
Beispiel 2
C:\PS>export-alias -path alias.csv -noclobber Beschreibung ----------- Mit diesem Befehl werden die Aliase in der aktuellen Sitzung in die Datei "Alias.csv" exportiert. Weil der NoClobber-Parameter angegeben wurde, verursacht der Befehl einen Fehler, wenn im aktuellen Verzeichnis bereits die Datei "Alias.csv" vorhanden ist.
Beispiel 3
C:\PS>export-alias -path alias.csv -append -description "Appended Aliases" -force Beschreibung ----------- Mit diesem Befehl werden die Aliase in der aktuellen Sitzung an die Datei "Alias.csv" angefügt. Im Befehl wird den Kommentaren am Anfang der Datei mit dem Description-Parameter eine Beschreibung hinzugefügt. Außerdem werden mit dem Force-Parameter vorhandene Alias.csv-Dateien überschrieben, auch wenn sie über das Schreibschutzattribut verfügen.
Beispiel 4
C:\PS>export-alias -path alias.ps1 -as script C:\PS> add-content -path $profile -value (get-content alias.ps1) C:\PS> $s = new-pssession -computername Server01 C:\PS> invoke-command -session $s -filepath .\alias.ps1 Beschreibung ----------- In diesem Beispiel wird die Verwendung des mit Export-Alias generierten Skriptdateiformats veranschaulicht. Im ersten Befehl werden die Aliase in der Sitzung in die Datei "Alias.ps1" exportiert. Der As-Parameter mit dem Wert "Script" wird zum Generieren einer Datei verwendet, die für jeden Alias den Befehl "Set-Alias" enthält. Mit dem zweiten Befehl werden dem Profil "CurrentUser-CurrentHost" die Aliase in der Datei "Alias.ps1" hinzugefügt. (Der Pfad des Profils wird in der Variablen "$profile" gespeichert.) Im Befehl werden mit dem Cmdlet "Get-Content" die Aliase aus der Datei "Alias.ps1" abgerufen, und mit dem Cmdlet "Add-Content" werden sie dem Profil hinzugefügt. Weitere Informationen finden Sie unter "about_Profiles". Mit dem dritten und vierten Befehl werden die Aliase in der Datei "Alias.ps1" einer Remotesitzung auf dem Computer "Server01" hinzugefügt. Im dritten Befehl wird die Sitzung mit dem Cmdlet "New-PSSession" erstellt. Im vierten Befehl wird die Datei "Alias.ps1" mithilfe des FilePath-Parameters des Cmdlet "Invoke-Command" in der neuen Sitzung ausgeführt.
Siehe auch