Export-Alias

Modul:

Microsoft.PowerShell.Utility Module

Exportiert Informationen zu aktuell definierten Aliasen in eine Datei.

Syntax

ByPath (Standardwert)

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

Beschreibung

Das Cmdlet Export-Alias exportiert die Aliase in der aktuellen Sitzung in eine Datei. Wenn die Ausgabedatei nicht vorhanden ist, erstellt das Cmdlet sie.

Export-Alias kann die Aliase in einem bestimmten Bereich oder in allen Bereichen exportieren. Es kann die Daten im CSV-Format oder als Reihe von Set-Alias-Befehlen generieren, die Sie einer Sitzung oder einem PowerShell-Profil hinzufügen können.

Beispiele

Beispiel 1: Exportieren eines Alias

Export-Alias -Path "Alias.csv"

Mit diesem Befehl werden aktuelle Aliasinformationen in eine Datei mit dem Namen Alias.csv im aktuellen Verzeichnis exportiert.

Beispiel 2: Exportieren eines Alias, es sei denn, die Exportdatei ist bereits vorhanden

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

Dieser Befehl exportiert die Aliase der aktuellen Sitzung in eine Datei namens „Alias.csv“.

Da der NoClobber Parameter angegeben ist, schlägt der Befehl fehl, wenn bereits eine Alias.csv Datei im aktuellen Verzeichnis vorhanden ist.

Beispiel 3: Anfügen von Aliasen an eine Datei

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

Dieser Befehl fügt die Aliase der aktuellen Sitzung an eine Datei namens „Alias.csv“ an.

Der Befehl verwendet den parameter Description, um den Kommentaren oben in der Datei eine Beschreibung hinzuzufügen.

Der Befehl verwendet außerdem den Force-Parameter, um beliebige vorhandene Dateien namens „Alias.csv“ zu überschreiben, auch wenn sie über das ReadOnly-Attribut verfügen.

Beispiel 4: Exportieren von Aliasen als Skript

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 diesem Beispiel wird gezeigt, wie Sie das Skriptdateiformat verwenden, das Export-Alias generiert.

Der erste Befehl exportiert die Aliase der Sitzung in die Datei „Alias.ps1“. Er verwendet den As-Parameter mit einen Script-Wert, um eine Datei zu generieren, die einen Set-Alias-Befehl für jeden Alias enthält.

Mit dem zweiten Befehl werden die Aliase in der Alias.ps1-Datei zum CurrentUser-CurrentHost-Profil hinzugefügt. Der Pfad zum Profil wird in der variablen $PROFILE gespeichert. Der Befehl verwendet das Cmdlet Get-Content, um die Aliase aus der Alias.ps1-Datei und dem Cmdlet Add-Content abzurufen, um sie dem Profil hinzuzufügen. Weitere Informationen finden Sie unter about_Profiles.

Durch den dritten und vierten Befehl werden die Aliase in der Datei „Alias.ps1“ einer Remotesitzung auf dem Computer Server01 hinzugefügt. Der dritte Befehl verwendet das cmdlet New-PSSession zum Erstellen der Sitzung. Der vierte Befehl verwendet den FilePath-Parameter des cmdlets Invoke-Command, um die Alias.ps1 Datei in der neuen Sitzung auszuführen.

Parameter

-Append

Gibt an, dass dieses Cmdlet die Ausgabe an die angegebene Datei anhängt, anstatt den vorhandenen Inhalt dieser Datei zu überschreiben.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-As

Gibt das Ausgabeformat an. CSV ist die Standardeinstellung. Die zulässigen Werte für diesen Parameter sind:

• CSV. Durch Trennzeichen getrenntes Format (.csv).
• Skript. Erstellt eines Set-Alias-Befehls für jeden exportierten Alias. Wenn Sie die Ausgabedatei mit einer .ps1 Dateinamenerweiterung benennen, können Sie sie als Skript ausführen, um die Aliase einer beliebigen Sitzung hinzuzufügen.

Parametereigenschaften

Typ:	ExportAliasFormat
Standardwert:	None
Zulässige Werte:	Csv, Script
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	False
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	vgl

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Description

Gibt die Beschreibung der exportierten Datei an. Die Beschreibung wird am Anfang der Datei nach den Headerinformationen als Kommentar angezeigt.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Force

Erzwingt die Ausführung des Befehls, ohne eine Benutzerbestätigung zu verlangen.

Überschreibt die Ausgabedatei, auch wenn das ReadOnly-Attribut für die Datei festgelegt wurde.

Standardmäßig überschreibt Export-Alias Dateien ohne Warnung, es sei denn, das Attribut „schreibgeschützt“ oder „versteckt“ ist festgelegt oder der Parameter NoClobber wird im Befehl verwendet. Der NoClobber-Parameter hat Vorrang vor dem Force-Parameter, wenn beide in einem Befehl verwendet werden.

Durch den Force-Parameter kann Export-Alias nicht gezwungen Export-Alias werden, Dateien mit dem Hidden-Attribut zu überschreiben.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-LiteralPath

Gibt den Pfad zur Ausgabedatei an. Im Gegensatz zu Path wird der Wert des LiteralPath-Parameters genau so verwendet, wie er eingegeben wurde. Es werden keine Zeichen als Wildcards interpretiert. Wenn der Pfad Escapezeichen enthält, müssen Sie ihn in einfache Anführungszeichen einschließen. Einfache Anführungszeichen signalisieren PowerShell, dass keine Zeichen als Escapesequenzen interpretiert werden sollen.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	PSPath, EP

Parametersätze

ByLiteralPath

Position:	Named
Obligatorisch.:	True
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	True
Wert aus verbleibenden Argumenten:	False

-Name

Gibt die Namen als Array der zu exportierenden Aliase an. Wildcards sind zulässig.

Standardmäßig exportiert Export-Alias alle in der Sitzung oder im Bereich enthaltenen Aliase.

Parametereigenschaften

Typ:	String[]
Standardwert:	None
Unterstützt Platzhalter:	True
Nicht anzeigen:	False

Parametersätze

(All)

Position:	1
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	True
Wert aus verbleibenden Argumenten:	False

-NoClobber

Gibt an, dass dieses Cmdlet verhindert, dass Export-Alias Dateien überschreiben, auch wenn der parameter Force im Befehl verwendet wird.

Wenn der NoClobber Parameter ausgelassen wird, überschreibt Export-Alias eine vorhandene Datei ohne Warnung, es sei denn, das Attribut "schreibgeschützt" ist für die Datei festgelegt. NoClobber hat Vorrang vor dem Parameter Force, der es Export-Alias ermöglicht, eine Datei mit dem schreibgeschützten Attribut zu überschreiben.

NoClobber verhindert nicht, dass einer vorhandenen Datei Inhalte durch den Append-Parameter hinzugefügt werden.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	NoOverwrite

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-PassThru

Gibt ein Objekt zurück, das das Element darstellt, mit dem Sie arbeiten. Standardmäßig generiert dieses Cmdlet keine Ausgabe.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Path

Gibt den Pfad zur Ausgabedatei an. Platzhalter sind zulässig, aber der resultierende Pfadwert muss in einen einzelnen Dateinamen aufgelöst werden.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	True
Nicht anzeigen:	False

Parametersätze

ByPath

Position:	0
Obligatorisch.:	True
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Scope

Gibt den Bereich an, aus dem die Aliase exportiert werden sollen. Die zulässigen Werte für diesen Parameter sind:

• Global
• Local
• Script
• 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.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-WhatIf

Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	False
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	Wi

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

None

Sie können keine Objekte an dieses Cmdlet weiterleiten.

Ausgaben

None

Standardmäßig gibt dieses Cmdlet keine Ausgabe zurück.

AliasInfo

Wenn Sie den PassThru Parameter verwenden, gibt dieses Cmdlet ein AliasInfo- Objekt zurück, das den Alias darstellt.

Hinweise

PowerShell enthält die folgenden Aliase für Export-Alias:

• Alle Plattformen:
  • epal

• Sie können Export-Alias nur für eine Datei ausführen.

Ähnliche Themen

• Get-Alias
• Import-Alias
• New-Alias
• Set-Alias