Поделиться через

Export-ModuleMember

  • Ссылка
Модуль:
Microsoft.PowerShell.Core

Указывает элементы модуля, экспортированные.

Синтаксис

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

Описание

Командлет Export-ModuleMember указывает члены модуля, экспортированные из файла модуля скрипта (.psm1) или из динамического модуля, созданного с помощью командлета New-Module. Члены модуля включают командлеты, функции, переменные и псевдонимы. Этот командлет можно использовать только в файле модуля скрипта или динамическом модуле.

Если модуль скрипта не включает команду Export-ModuleMember, функции и псевдонимы в модуле скрипта экспортируются, но переменные не являются. Если модуль скрипта включает команды Export-ModuleMember, экспортируются только члены, указанные в командах Export-ModuleMember. Вы также можете использовать Export-ModuleMember для подавления или экспорта элементов, импортируемых модулем скрипта из других модулей.

Команда Export-ModuleMember является необязательной, но рекомендуется. Даже если команда подтверждает значения по умолчанию, она демонстрирует намерение автора модуля.

Примеры

Пример 1. Экспорт функций и псевдонимов в модуле скрипта

Export-ModuleMember -Function * -Alias *

Эта команда экспортирует все функции и псевдонимы, определенные в модуле скрипта.

Пример 2. Экспорт определенных псевдонимов и функций

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

Эта команда экспортирует три псевдонима и три функции, определенные в модуле скрипта.

Этот формат команды можно использовать для указания имен участников модуля.

Пример 3. Экспорт элементов без элементов

Export-ModuleMember

Эта команда указывает, что элементы, определенные в модуле скрипта, не экспортируются.

Эта команда предотвращает экспорт элементов модуля, но не скрывает их. Пользователи могут считывать и копировать члены модуля или использовать оператор вызова (&) для вызова членов модуля, которые не экспортируются.

Пример 4. Экспорт определенной переменной

Export-ModuleMember -Variable increment

Эта команда экспортирует только переменную $increment из модуля скрипта. Другие члены не экспортируются.

Если вы хотите экспортировать переменную, помимо экспорта функций в модуле, команда Export-ModuleMember должна содержать имена всех функций и имя переменной.

Пример 5. Несколько команд экспорта

# 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

Эти команды показывают, как в файле скрипта (.psm1) интерпретируются несколько команд Export-ModuleMember.

Эти команды создают три функции и один псевдоним, а затем экспортируют две функции и псевдоним.

Без Export-ModuleMember команд все три функции и псевдоним будут экспортированы. С помощью команд Export-ModuleMember экспортируются только функции New-Test и Start-Test и псевдоним STT.

Пример 6. Экспорт элементов в динамическом модуле

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

Эта команда показывает, как использовать Export-ModuleMember в динамическом модуле, созданном с помощью командлета New-Module.

В этом примере Export-ModuleMember используется для экспорта псевдонима Hi и функции SayHello в динамическом модуле.

Параметры

-Alias

Указывает псевдонимы, экспортированные из файла модуля скрипта. Введите имена псевдонимов. Разрешены подстановочные знаки.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:True

-Cmdlet

Указывает командлеты, экспортированные из файла модуля скрипта. Введите имена командлетов. Разрешены подстановочные знаки.

Нельзя создавать командлеты в файле модуля скрипта, но можно импортировать командлеты из двоичного модуля в модуль скрипта и повторно экспортировать их из модуля скрипта.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:True

-Function

Указывает функции, экспортированные из файла модуля скрипта. Введите имена функций. Разрешены подстановочные знаки. Можно также передать строки имени функции в Export-ModuleMember.

Тип:String[]
Position:0
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:True

-Variable

Указывает переменные, экспортированные из файла модуля скрипта. Введите имена переменных без символа знака доллара ($). Разрешены подстановочные знаки.

Тип:String[]
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:True
Принять подстановочные знаки:True

Входные данные

String

Строки имени функции можно передать в этот командлет.

Выходные данные

None

Этот командлет не возвращает выходные данные.

Примечания

  • Чтобы исключить члена из списка экспортированных элементов, добавьте команду Export-ModuleMember, которая содержит список всех остальных элементов, но не указывает на элемент, который требуется исключить.