Export-ModuleMember

  • Riferimento
Modulo:
Microsoft.PowerShell.Core

Specifica i membri del modulo esportati.

Sintassi

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

Descrizione

Il Export-ModuleMember cmdlet specifica i membri del modulo esportati da un file di modulo di script (.psm1) o da un modulo dinamico creato usando il New-Module cmdlet . I membri del modulo includono cmdlet, funzioni, variabili e alias. Questo cmdlet può essere usato solo in un file del modulo di script o in un modulo dinamico.

Se un modulo script non include un Export-ModuleMember comando, le funzioni e gli alias nel modulo script vengono esportati, ma le variabili non sono. Quando un modulo script include Export-ModuleMember comandi, vengono esportati solo i membri specificati nei Export-ModuleMember comandi. È anche possibile usare Export-ModuleMember per eliminare o esportare i membri importati dal modulo script da altri moduli.

Un Export-ModuleMember comando è facoltativo, ma è una procedura consigliata. Anche se il comando conferma i valori predefiniti, illustra l'intenzione dell'autore del modulo.

Esempio

Esempio 1: Esportare funzioni e alias in un modulo script

Export-ModuleMember -Function * -Alias *

Questo comando esporta tutte le funzioni e gli alias definiti nel modulo script.

Esempio 2: Esportare alias e funzioni specifici

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

Questo comando esporta tre alias e tre funzioni definiti nel modulo di script.

È possibile usare questo formato di comando per specificare i nomi dei membri del modulo.

Esempio 3: Esportare nessun membro

Export-ModuleMember

Questo comando specifica che non viene esportato alcun membro definito nel modulo di script.

Il comando impedisce l'esportazione dei membri del modulo, ma non li nasconde. Gli utenti possono leggere e copiare membri del modulo o usare l'operatore di chiamata (&) per richiamare i membri del modulo che non vengono esportati.

Esempio 4: Esportare una variabile specifica

Export-ModuleMember -Variable increment

Questo comando esporta solo la $increment variabile dal modulo script. Non vengono esportati altri membri.

Se si vuole esportare una variabile, oltre a esportare le funzioni in un modulo, il Export-ModuleMember comando deve includere i nomi di tutte le funzioni e il nome della variabile.

Esempio 5: più comandi di esportazione

# 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

Questi comandi mostrano come vengono interpretati più Export-ModuleMember comandi in un file di modulo di script (.psm1).

Tali comandi creano tre funzioni e un alias e quindi esportano due delle tre funzioni e l'alias.

Senza i Export-ModuleMember comandi, tutte e tre le funzioni e l'alias verranno esportati. Con i Export-ModuleMember comandi vengono esportati solo le New-Test funzioni e Start-Test e l'alias STT .

Esempio 6: Esportare membri in un modulo dinamico

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

Questo comando illustra come usare Export-ModuleMember in un modulo dinamico creato usando il New-Module cmdlet .

In questo esempio viene Export-ModuleMember usato per esportare sia l'alias Hi che la SayHello funzione nel modulo dinamico.

Parametri

-Alias

Specifica gli alias esportati dal file del modulo di script. Immettere i nomi degli alias. I caratteri jolly sono consentiti.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Cmdlet

Specifica i cmdlet esportati dal file del modulo di script. Immettere i nomi dei cmdlet. I caratteri jolly sono consentiti.

Non è possibile creare i cmdlet in un file del modulo di script, ma è possibile importare i cmdlet da un modulo binario in un modulo di script e riesportarli dal modulo di script.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Function

Specifica le funzioni esportate dal file del modulo di script. Immettere i nomi delle funzioni. I caratteri jolly sono consentiti. È anche possibile inviare tramite pipe le stringhe del nome della funzione a Export-ModuleMember.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

-Variable

Specifica le variabili esportate dal file del modulo di script. Immettere i nomi delle variabili senza un simbolo di dollaro ($). I caratteri jolly sono consentiti.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:True

Input

String

È possibile inviare tramite pipe le stringhe del nome della funzione a questo cmdlet.

Output

None

Questo cmdlet non restituisce output.

Note

  • Per escludere un membro dall'elenco dei membri esportati, aggiungere un Export-ModuleMember comando che elenca tutti gli altri membri, ma omette il membro da escludere.