Export-ModuleMember

Modul:
Microsoft.PowerShell.Core Module

Gibt die Modulmmber an, die exportiert werden.

Syntax

Default (Standard) 

Export-ModuleMember
    [[-Function] <String[]>]
    [-Cmdlet <String[]>]
    [-Variable <String[]>]
    [-Alias <String[]>]
    [<CommonParameters>]

Beschreibung

Das Export-ModuleMember Cmdlet gibt die Modulmember an, die aus einer Skriptmoduldatei (.psm1) oder aus einem mithilfe des New-Module Cmdlets erstellten dynamischen Modul exportiert werden. Modulmmber gehören Cmdlets, Funktionen, Variablen und Aliase. Dieses Cmdlet kann nur in einer Skriptmoduldatei oder einem dynamischen Modul verwendet werden.

Wenn ein Skriptmodul keinen Befehl enthält Export-ModuleMember , werden die Funktionen und Aliase im Skriptmodul exportiert, die Variablen jedoch nicht. Wenn ein Skriptmodul Befehle enthält Export-ModuleMember , werden nur die in den Export-ModuleMember Befehlen angegebenen Member exportiert. Sie können auch Export-ModuleMember Elemente unterdrücken oder exportieren, die das Skriptmodul aus anderen Modulen importiert.

Ein Export-ModuleMember Befehl ist optional, aber es ist eine bewährte Methode. Auch wenn der Befehl die Standardwerte bestätigt, wird die Absicht des Modulautors veranschaulicht.

Beispiele

Beispiel 1: Exportieren von Funktionen und Aliasen in einem Skriptmodul

Export-ModuleMember -Function * -Alias *

Mit diesem Befehl werden alle im Skriptmodul definierten Funktionen und Aliase exportiert.

Beispiel 2: Exportieren bestimmter Aliase und Funktionen

Export-ModuleMember -Function Get-Test, New-Test, Start-Test -Alias gtt, ntt, stt

Mit diesem Befehl werden drei Aliase und drei im Skriptmodul definierte Funktionen exportiert.

Sie können dieses Befehlsformat verwenden, um die Namen von Modulmitgliedern anzugeben.

Beispiel 3: Keine Mitglieder exportieren

Export-ModuleMember

Dieser Befehl gibt an, dass keine Elemente exportiert werden, die im Skriptmodul definiert sind.

Mit diesem Befehl wird verhindert, dass die Modulmmber exportiert werden, aber die Member werden nicht ausgeblendet. Benutzer können Modulmmber lesen und kopieren oder den Aufrufoperator (&) verwenden, um Modulmmber aufzurufen, die nicht exportiert werden.

Beispiel 4: Exportieren einer bestimmten Variablen

Export-ModuleMember -Variable increment

Mit diesem Befehl wird nur die $increment Variable aus dem Skriptmodul exportiert. Es werden keine anderen Member exportiert.

Wenn Sie eine Variable exportieren möchten, muss der Export-ModuleMember Befehl zusätzlich zum Exportieren der Funktionen in einem Modul die Namen aller Funktionen und den Namen der Variablen enthalten.

Beispiel 5: Mehrere Exportbefehle

# From TestModule.psm1
function New-Test
{
    Write-Output 'I am New-Test function'
}
Export-ModuleMember -Function New-Test

function Validate-Test
{
    Write-Output 'I am Validate-Test function'
}
function Start-Test
{
    Write-Output 'I am Start-Test function'
}
Set-Alias stt Start-Test
Export-ModuleMember -Function Start-Test -Alias stt

Diese Befehle zeigen, wie mehrere Export-ModuleMember Befehle in einer Skriptmoduldatei (.psm1) interpretiert werden.

Diese Befehle erstellen drei Funktionen und einen Alias und exportieren dann zwei der Funktionen und den Alias.

Ohne die Export-ModuleMember Befehle würden alle drei Funktionen und der Alias exportiert. Mit den Export-ModuleMember Befehlen werden nur die New-Test Funktionen und Start-Test der STT Alias exportiert.

Beispiel 6: Exportieren von Mitgliedern in einem dynamischen Modul

New-Module -Script {function SayHello {"Hello!"}; Set-Alias Hi SayHello; Export-ModuleMember -Alias Hi -Function SayHello}

Dieser Befehl zeigt die Verwendung Export-ModuleMember in einem dynamischen Modul, das mithilfe des New-Module Cmdlets erstellt wird.

In diesem Beispiel wird verwendet, Export-ModuleMember um sowohl den Hi Alias als auch die SayHello Funktion im dynamischen Modul zu exportieren.

Parameter

-Alias

Gibt die Aliase an, die aus der Skriptmoduldatei exportiert werden. Geben Sie die Aliasnamen ein. Platzhalterzeichen sind zulässig.

Parametereigenschaften

Typ:

String[]

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

Parametersätze

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

-Cmdlet

Gibt die Cmdlets an, die aus der Skriptmoduldatei exportiert werden. Geben Sie die Cmdlet-Namen ein. Platzhalterzeichen sind zulässig.

Sie können keine Cmdlets in einer Skriptmoduldatei erstellen, aber Sie können Cmdlets aus einem Binärmodul in ein Skriptmodul importieren und sie aus dem Skriptmodul erneut exportieren.

Parametereigenschaften

Typ:

String[]

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

Parametersätze

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

-Function

Gibt die Funktionen an, die aus der Skriptmoduldatei exportiert werden. Geben Sie die Funktionsnamen ein. Platzhalterzeichen sind zulässig. Sie können auch Funktionsnamenzeichenfolgen an Export-ModuleMember.

Parametereigenschaften

Typ:

String[]

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

Parametersätze

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

-Variable

Gibt die Variablen an, die aus der Skriptmoduldatei exportiert werden. Geben Sie die Variablennamen ohne Dollarzeichen ($) ein. Platzhalterzeichen sind zulässig.

Parametereigenschaften

Typ:

String[]

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

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
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

String

Sie können Funktionsnamenzeichenfolgen an dieses Cmdlet weiterleiten.

Ausgaben

None

Dieses Cmdlet gibt keine Ausgabe zurück.

Hinweise

  • Um ein Mitglied aus der Liste der exportierten Mitglieder auszuschließen, fügen Sie einen Export-ModuleMember Befehl hinzu, der alle anderen Mitglieder auflistet, aber das Element ausgelassen, das Sie ausschließen möchten.