Freigeben über


Export-ModuleMember

Gibt die Modulmmber an, die exportiert werden.

Syntax

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

Beschreibung

Das Cmdlet Export-ModuleMember gibt die Modulmember an, die aus einer Skriptmoduldatei (.psm1) oder aus einem dynamischen Modul exportiert werden, das mit dem Cmdlet New-Module erstellt wurde. 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 Export-ModuleMember Befehl enthält, werden die Funktionen und Aliase im Skriptmodul exportiert, aber die Variablen sind nicht. Wenn ein Skriptmodul Export-ModuleMember Befehle enthält, werden nur die in den Export-ModuleMember Befehlen angegebenen Member exportiert. Sie können auch Export-ModuleMember verwenden, um Member zu unterdrücken oder zu exportieren, die das Skriptmodul aus anderen Modulen importiert.

Ein Export-ModuleMember-Befehl ist optional, es ist jedoch 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 Anrufoperator (&) verwenden, um Modulmmber aufzurufen, die nicht exportiert werden.

Beispiel 4: Exportieren einer bestimmten Variablen

Export-ModuleMember -Variable increment

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

Wenn Sie eine Variable exportieren möchten, muss der Befehl Export-ModuleMember 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 funktionen New-Test und Start-Test sowie der alias STT 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, wie sie Export-ModuleMember in einem dynamischen Modul verwenden, das mithilfe des Cmdlets New-Module erstellt wird.

In diesem Beispiel wird Export-ModuleMember verwendet, 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. Wildcardzeichen sind zulässig.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:True

-Cmdlet

Gibt die Cmdlets an, die aus der Skriptmoduldatei exportiert werden. Geben Sie die Cmdlet-Namen ein. Wildcardzeichen 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.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:True

-Function

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

Typ:String[]
Position:0
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:True

-Variable

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

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:True

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.