Leer en inglés

Compartir a través de

Export-ModuleMember

  • Referencia
Módulo:
Microsoft.PowerShell.Core

Especifica los miembros del módulo que se exportan.

Sintaxis

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

Description

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. 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.

Ejemplos

Ejemplo 1: Exportación de funciones y alias en un módulo de script

PowerShell 
Export-ModuleMember -Function * -Alias *

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

Ejemplo 2: Exportación de alias y funciones específicos

PowerShell 
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.

Ejemplo 3: Exportar ningún miembro

PowerShell 
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.

Ejemplo 4: Exportación de una variable específica

PowerShell 
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.

Ejemplo 5: Varios comandos de exportación

PowerShell 
# 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 de Export-ModuleMember 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, solo se exportan las funciones New-Test y Start-Test y el alias de STT.

Ejemplo 6: Exportación de miembros en un módulo dinámico

PowerShell 
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, se usa Export-ModuleMember para exportar tanto el alias de Hi como la función SayHello en el módulo dinámico.

Parámetros

-Alias

Especifica los alias que se exportan desde el archivo de módulo de script. Escriba los nombres de alias. Se permiten caracteres comodín.

Tipo:String[]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:True

-Cmdlet

Especifica los cmdlets que se exportan desde el archivo del módulo de script. Escriba los nombres de cmdlet. Se permiten caracteres comodín.

No puede crear cmdlets en un archivo de módulo de script, pero puede importar cmdlets de un módulo binario en un módulo de script y volver a exportarlos desde el módulo de script.

Tipo:String[]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:True

-Function

Especifica las funciones que se exportan desde el archivo del módulo de script. Escriba los nombres de función. Se permiten caracteres comodín. También puede canalizar cadenas de nombre de función para Export-ModuleMember.

Tipo:String[]
Posición:0
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:True

-Variable

Especifica las variables que se exportan desde el archivo del módulo de script. Escriba los nombres de las variables, sin un carácter de signo de dólar ($). Se permiten caracteres comodín.

Tipo:String[]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:True

Entradas

String

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

Salidas

None

Este cmdlet no devuelve ninguna salida.

Notas

  • 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.