Condividi tramite

Export-ModuleMember

Modulo:
Microsoft.PowerShell.Core Module

Specifica i membri del modulo esportati.

Sintassi

Default (impostazione predefinita). 

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

Descrizione

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

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

Un comando Export-ModuleMember è facoltativo, ma è una procedura consigliata. Anche se il comando conferma i valori predefiniti, dimostra 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 definite nel modulo 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 vengono esportati membri definiti nel modulo script.

Questo comando impedisce l'esportazione dei membri del modulo, ma non nasconde i membri. 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 variabile $increment dal modulo script. Nessun altro membro viene esportato.

Se si vuole esportare una variabile, oltre a esportare le funzioni in un modulo, il comando Export-ModuleMember 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 più comandi Export-ModuleMember vengono interpretati in un file di modulo script (.psm1).

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

Senza i comandi Export-ModuleMember, tutte e tre le funzioni e l'alias verranno esportati. Con i comandi Export-ModuleMember, vengono esportate solo le funzioni New-Test 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 cmdlet New-Module.

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

Parametri

-Alias

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

Proprietà dei parametri

Tipo:

String[]

Valore predefinito:None
Supporta i caratteri jolly:True
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Cmdlet

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

Non è possibile creare cmdlet in un file di modulo script, ma è possibile importare i cmdlet da un modulo binario in un modulo script ed esportarli nuovamente dal modulo script.

Proprietà dei parametri

Tipo:

String[]

Valore predefinito:None
Supporta i caratteri jolly:True
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Function

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

Proprietà dei parametri

Tipo:

String[]

Valore predefinito:None
Supporta i caratteri jolly:True
DontShow:False

Set di parametri

(All)
Posizione:0
Obbligatorio:False
Valore dalla pipeline:True
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

-Variable

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

Proprietà dei parametri

Tipo:

String[]

Valore predefinito:None
Supporta i caratteri jolly:True
DontShow:False

Set di parametri

(All)
Posizione:Named
Obbligatorio:False
Valore dalla pipeline:False
Valore dalla pipeline in base al nome della proprietà:True
Valore dagli argomenti rimanenti:False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

String

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

Output

None

Questo cmdlet non restituisce alcun output.

Note

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