Export-ModuleMember

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

El cmdlet Export-ModuleMember especifica los miembros del módulo que se exportan desde un archivo de módulo de script (.psm1) o desde un módulo dinámico creado mediante el cmdlet New-Module. Los miembros del módulo incluyen cmdlets, funciones, variables y alias. Este cmdlet solo se puede usar en un archivo de módulo de script o en un módulo dinámico.

Si un módulo de script no incluye un comando Export-ModuleMember, se exportan las funciones y alias del módulo de script, pero las variables no. Cuando un módulo de script incluye comandos Export-ModuleMember, solo se exportan los miembros especificados en los comandos Export-ModuleMember de . También puede usar Export-ModuleMember para suprimir o exportar miembros que el módulo de script importa desde otros módulos.

Un comando Export-ModuleMember es opcional, pero es un procedimiento recomendado. Incluso si el comando confirma los valores predeterminados, muestra la intención del autor del módulo.

Export-ModuleMember -Function * -Alias *

Este comando exporta todas las funciones y alias definidos en el módulo de script.

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

Este comando exporta tres alias y tres funciones definidas en el módulo de script.

Puede usar este formato de comando para especificar los nombres de los miembros del módulo.

Export-ModuleMember

Este comando especifica que no se exportan miembros definidos en el módulo de script.

Este comando impide que los miembros del módulo se exportan, pero no oculta los miembros. Los usuarios pueden leer y copiar miembros del módulo o usar el operador de llamada (&) para invocar miembros del módulo que no se exportan.

Export-ModuleMember -Variable increment

Este comando exporta solo la variable $increment desde el módulo de script. No se exportan otros miembros.

Si desea exportar una variable, además de exportar las funciones de un módulo, el comando Export-ModuleMember debe incluir los nombres de todas las funciones y el nombre de la variable.

# 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

Estos comandos muestran cómo se interpretan varios comandos Export-Module Member en un archivo de módulo de script (.psm1).

Estos comandos crean tres funciones y un alias y, a continuación, exportan dos de las funciones y el alias.

Sin los comandos Export-ModuleMember, se exportarían las tres funciones y el alias. Con los comandos Export-ModuleMember de , solo se exportan las funciones New-Test y Start-Test y el alias STT.

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

Este comando muestra cómo usar Export-ModuleMember en un módulo dinámico que se crea mediante el cmdlet New-Module.

En este ejemplo, export-ModuleMember se usa para exportar el alias Hi y la función SayHello en el módulo dinámico.

# From TestModule.psm1
function Export
{
  param (
    [Parameter(Mandatory=$true)]
    [ValidateSet("function","variable")]
    $Type,
    [Parameter(Mandatory=$true)]
    $Name,
    [Parameter(Mandatory=$true)]
    $Value
    )

    if ($Type -eq "function")
    {
        Set-item "function:script:$Name" $Value
        Export-ModuleMember $Name
    }
    else
    {
    Set-Variable -scope Script $Name $Value
    Export-ModuleMember -variable $Name
    }
}

Export function New-Test {Write-Output 'I am New-Test function'}
function helper {Write-Output 'I am helper function'}

Export variable Interval 0
$Interval = 2

En este ejemplo se incluye una función denominada Export que declara una función o crea una variable y, a continuación, escribe un comando Export-ModuleMember para la función o variable. Esto le permite declarar y exportar una función o variable en un solo comando.

Para usar la función export , incluyalo en el módulo de script. Para exportar una función, escriba antes de la palabra clave Function .

Para exportar una variable, use el siguiente formato para declarar la variable y establecer su valor:

Export variable <variable-name> <value>

Los comandos del ejemplo muestran el formato correcto. En este ejemplo, solo se exportan las función New-Test y la variable $Interval.

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Puede canalizar cadenas de nombre de función a este cmdlet.

Este cmdlet no genera ningún resultado.

• Para excluir un miembro de la lista de miembros exportados, agregue un comando Export-ModuleMember que muestre todos los demás miembros, pero omita el miembro que desea excluir.