New-ModuleManifest
Создает новый манифест модуля.
Синтаксис
New-ModuleManifest
[-Path] <string>
[-NestedModules <Object[]>]
[-Guid <guid>]
[-Author <string>]
[-CompanyName <string>]
[-Copyright <string>]
[-RootModule <string>]
[-ModuleVersion <version>]
[-Description <string>]
[-ProcessorArchitecture <ProcessorArchitecture>]
[-PowerShellVersion <version>]
[-ClrVersion <version>]
[-DotNetFrameworkVersion <version>]
[-PowerShellHostName <string>]
[-PowerShellHostVersion <version>]
[-RequiredModules <Object[]>]
[-TypesToProcess <string[]>]
[-FormatsToProcess <string[]>]
[-ScriptsToProcess <string[]>]
[-RequiredAssemblies <string[]>]
[-FileList <string[]>]
[-ModuleList <Object[]>]
[-FunctionsToExport <string[]>]
[-AliasesToExport <string[]>]
[-VariablesToExport <string[]>]
[-CmdletsToExport <string[]>]
[-DscResourcesToExport <string[]>]
[-PrivateData <Object>]
[-Tags <string[]>]
[-ProjectUri <uri>]
[-LicenseUri <uri>]
[-IconUri <uri>]
[-ReleaseNotes <string>]
[-HelpInfoUri <string>]
[-PassThru]
[-DefaultCommandPrefix <string>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Описание
Командлет New-ModuleManifest
создает файл манифеста модуля (.psd1
), заполняет его значения и сохраняет файл манифеста в указанном пути.
Авторы модулей могут использовать этот командлет для создания манифеста для модуля. Манифест модуля — это файл .psd1
, содержащий хэш-таблицу. Ключи и значения в хэш-таблице описывают содержимое и атрибуты модуля, определяют необходимые компоненты и определяют способ обработки компонентов. Манифесты не требуются для модуля.
New-ModuleManifest
создает манифест, содержащий все часто используемые ключи манифеста, поэтому вы можете использовать выходные данные по умолчанию в качестве шаблона манифеста. Чтобы добавить или изменить значения или добавить ключи модулей, которые этот командлет не добавляет, откройте полученный файл в текстовом редакторе.
Каждый параметр, за исключением path и PassThru, создает ключ манифеста модуля и его значение.
В манифесте модуля требуется только ключ ModuleVersion. Если не указано в описании параметра, если параметр не указан из команды, New-ModuleManifest
создает строку комментария для связанного значения, которое не влияет.
В PowerShell 2.0 New-ModuleManifest
запрашивает значения часто используемых параметров, которые не указаны в команде, помимо обязательных значений параметров. Начиная с PowerShell 3.0, New-ModuleManifest
запрашивает только в том случае, если обязательные значения параметров не указаны.
Примеры
Пример 1. Создание манифеста модуля
В этом примере создается новый манифест модуля в файле, указанном параметром пути
В выходных данных показаны значения по умолчанию всех ключей в манифесте.
New-ModuleManifest -Path C:\ps-test\Test-Module\Test-Module.psd1 -PassThru
#
# Module manifest for module 'Test-Module'
#
# Generated by: ContosoAdmin
#
# Generated on: 1/22/2019
#
@{
# Script module or binary module file associated with this manifest.
# RootModule = ''
# Version number of this module.
ModuleVersion = '1.0'
# ID used to uniquely identify this module
GUID = '47179120-0bcb-4f14-8d80-f4560107f85c'
# Author of this module
Author = 'ContosoAdmin'
# Company or vendor of this module
CompanyName = 'Unknown'
# Copyright statement for this module
Copyright = '(c) 2019 ContosoAdmin. All rights reserved.'
# Description of the functionality provided by this module
# Description = ''
# Minimum version of the Windows PowerShell engine required by this module
# PowerShellVersion = ''
# Name of the Windows PowerShell host required by this module
# PowerShellHostName = ''
# Minimum version of the Windows PowerShell host required by this module
# PowerShellHostVersion = ''
# Minimum version of the .NET Framework required by this module
# DotNetFrameworkVersion = ''
# Minimum version of the common language runtime (CLR) required by this module
# CLRVersion = ''
# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''
# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()
# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()
# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()
# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()
# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()
# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()
# Functions to export from this module
FunctionsToExport = '*'
# Cmdlets to export from this module
CmdletsToExport = '*'
# Variables to export from this module
VariablesToExport = '*'
# Aliases to export from this module
AliasesToExport = '*'
# List of all modules packaged with this module.
# ModuleList = @()
# List of all files packaged with this module
# FileList = @()
# Private data to pass to the module specified in RootModule/ModuleToProcess
# PrivateData = ''
# HelpInfo URI of this module
# HelpInfoURI = ''
# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''
}
Пример 2. Создание нового манифеста с некоторыми предварительно заполненными параметрами
В этом примере создается новый манифест модуля. В нем используются параметры PowerShellVersion
New-ModuleManifest -PowerShellVersion 1.0 -AliasesToExport JKBC, DRC, TAC -Path C:\ps-test\ManifestTest.psd1
Пример 3. Создание манифеста, требующего других модулей
В этом примере используется строковый формат для указания имени модуля BitsTransfer и хэш-таблицы для указания имени, GUIDи версии модуля PSScheduledJob.
$moduleSettings = @{
RequiredModules = ("BitsTransfer", @{
ModuleName="PSScheduledJob"
ModuleVersion="1.0.0.0";
GUID="50cdb55f-5ab7-489f-9e94-4ec21ff51e59"
})
Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings
В этом примере показано, как использовать форматы строк и хэш-таблицыModuleList
Пример 4. Создание манифеста, поддерживающего обновляемую справку
В этом примере используется параметр HelpInfoUri
$moduleSettings = @{
HelpInfoUri = 'https://https://go.microsoft.com/fwlink/?LinkID=603'
Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings
Сведения о обновляемой справке см. в about_Updatable_Help. Сведения о XML-файле HelpInfo см. в поддержке обновляемой справки.
Пример 5. Получение сведений о модуле
В этом примере показано, как получить значения конфигурации модуля. Значения в манифесте модуля отражаются в значениях свойств объекта модуля.
Командлет Format-List
для отображения всех свойств и значений объекта модуля.
Get-Module Microsoft.PowerShell.Diagnostics -List | Format-List -Property *
LogPipelineExecutionDetails : False
Name : Microsoft.PowerShell.Diagnostics
Path : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics\Micro
soft.PowerShell.Diagnostics.psd1
Definition :
Description :
Guid : ca046f10-ca64-4740-8ff9-2565dba61a4f
HelpInfoUri : https://go.microsoft.com/fwlink/?LinkID=210596
ModuleBase : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics
PrivateData :
Version : 3.0.0.0
ModuleType : Manifest
Author : Microsoft Corporation
AccessMode : ReadWrite
ClrVersion : 4.0
CompanyName : Microsoft Corporation
Copyright : Microsoft Corporation. All rights reserved.
DotNetFrameworkVersion :
ExportedFunctions : {}
ExportedCmdlets : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
Import-Counter], [Export-Counter, Export-Counter]...}
ExportedCommands : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
Import-Counter], [Export-Counter, Export-Counter]...}
FileList : {}
ModuleList : {}
NestedModules : {}
PowerShellHostName :
PowerShellHostVersion :
PowerShellVersion : 3.0
ProcessorArchitecture : None
Scripts : {}
RequiredAssemblies : {}
RequiredModules : {}
RootModule :
ExportedVariables : {}
ExportedAliases : {}
ExportedWorkflows : {}
SessionState :
OnRemove :
ExportedFormatFiles : {C:\Windows\system32\WindowsPowerShell\v1.0\Event.format.ps1xml,
C:\Windows\system32\WindowsPowerShell\v1.0\Diagnostics.format.ps1xml}
ExportedTypeFiles : {C:\Windows\system32\WindowsPowerShell\v1.0\GetEvent.types.ps1xml}
Параметры
-AliasesToExport
Указывает псевдонимы, экспортируемые модулем. Разрешены подстановочные знаки.
Этот параметр можно использовать для ограничения псевдонимов, экспортированных модулем. Он может удалить псевдонимы из списка экспортированных псевдонимов, но он не может добавлять псевдонимы в список.
Если этот параметр не указан, New-ModuleManifest
создает ключ AliasesToExport со значением *
(все), то есть все псевдонимы, определенные в модуле, экспортируются манифестом.
Тип: | String[] |
Position: | Named |
Default value: | * (all) |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | True |
-Author
Указывает автора модуля.
Если этот параметр не указан, New-ModuleManifest
создает ключ Author с именем текущего пользователя.
Тип: | String |
Position: | Named |
Default value: | Name of the current user |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ClrVersion
Указывает минимальную версию среды CLR microsoft .NET Framework, которую требует модуль.
Тип: | Version |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-CmdletsToExport
Указывает командлеты, экспортируемые модулем. Разрешены подстановочные знаки.
Этот параметр можно использовать для ограничения командлетов, экспортируемых модулем. Он может удалить командлеты из списка экспортированных командлетов, но он не может добавлять командлеты в список.
Если этот параметр не указан, New-ModuleManifest
создает ключ КомандлетыToExport со значением *
(все), то есть все командлеты, определенные в модуле, экспортируются манифестом.
Тип: | String[] |
Position: | Named |
Default value: | * (all) |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | True |
-CompanyName
Определяет компанию или поставщика, создавшего модуль.
Если этот параметр не указан,
Тип: | String |
Position: | Named |
Default value: | "Unknown" |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Confirm
Запрашивает подтверждение перед запуском командлета.
Тип: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Copyright
Указывает заявление об авторских правах для модуля.
Если этот параметр не указан, New-ModuleManifest
создает ключ авторских прав со значением (c) <year> <username>. All rights reserved.
, где <year>
текущий год, а <username>
— значение ключа Author.
Тип: | String |
Position: | Named |
Default value: | (c) <year> <username>. All rights reserved. |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DefaultCommandPrefix
Указывает префикс, который добавляется к существительным всех команд в модуле при их импорте в сеанс. Введите строку префикса. Префиксы предотвращают конфликты имен команд в сеансе пользователя.
Пользователи модуля могут переопределить этот префикс, указав параметр префикса командлета Import-Module
.
Этот параметр появился в PowerShell 3.0.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Description
Описывает содержимое модуля.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DotNetFrameworkVersion
Указывает минимальную версию Microsoft .NET Framework, которую требует модуль.
Тип: | Version |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-DscResourcesToExport
Указывает ресурсы требуемой конфигурации состояния (DSC), экспортируемые модулем. Разрешены подстановочные знаки.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | True |
-FileList
Указывает все элементы, включенные в модуль.
Этот ключ предназначен для работы в качестве инвентаризации модулей. Файлы, перечисленные в ключе, включаются при публикации модуля, но все функции не экспортируются автоматически.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-FormatsToProcess
Указывает файлы форматирования (.ps1xml
), которые выполняются при импорте модуля.
При импорте модуля PowerShell запускает командлет Update-FormatData
с указанными файлами.
Так как файлы форматирования не ограничены, они влияют на все состояния сеанса в сеансе.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-FunctionsToExport
Указывает функции, экспортируемые модулем. Разрешены подстановочные знаки.
Этот параметр можно использовать для ограничения функций, экспортируемых модулем. Он может удалить функции из списка экспортированных псевдонимов, но он не может добавлять функции в список.
Если этот параметр не указан, New-ModuleManifest
создает ключ FunctionsToExport со значением *
(все), то есть все функции, определенные в модуле, экспортируются манифестом.
Тип: | String[] |
Position: | Named |
Default value: | * (all) |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | True |
-Guid
Указывает уникальный идентификатор модуля. GUID можно использовать для различения модулей с одинаковым именем.
Если этот параметр не указан,
Чтобы создать новую GUID в PowerShell, введите [guid]::NewGuid()
.
Тип: | Guid |
Position: | Named |
Default value: | A GUID generated for the module |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-HelpInfoUri
Указывает интернет-адрес XML-файла HelpInfo для модуля. Введите универсальный код ресурса (URI), начинающийся с http или https.
XML-файл HelpInfo поддерживает обновляемую функцию справки, представленную в PowerShell 3.0. Он содержит сведения о расположении скачиваемых файлов справки для модуля и номера версий самых новых файлов справки для каждого поддерживаемого языкового стандарта.
Сведения о обновляемой справке см. в about_Updatable_Help. Сведения о XML-файле HelpInfo см. в поддержке обновляемой справки.
Этот параметр появился в PowerShell 3.0.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-IconUri
Указывает URL-адрес значка модуля. Указанный значок отображается на веб-странице коллекции для модуля.
Тип: | Uri |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-LicenseUri
Указывает URL-адрес условий лицензирования модуля.
Тип: | Uri |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ModuleList
Перечисляет все модули, включенные в этот модуль.
Введите имя каждого модуля в виде строки или хэш-таблицы с ключами ModuleName и ModuleVersion. Хэш-таблица также может иметь необязательный ключ GUID. Строки и хэш-таблицы можно объединить в значении параметра.
Этот ключ предназначен для работы в качестве инвентаризации модулей. Модули, перечисленные в значении этого ключа, не обрабатываются автоматически.
Тип: | Object[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ModuleVersion
Указывает версию модуля.
Этот параметр не является обязательным, но в манифесте требуется ключ moduleVersion New-ModuleManifest
создает ключ ModuleVersion со значением 1.0.
Тип: | Version |
Position: | Named |
Default value: | 1.0 |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-NestedModules
Задает модули скриптов (.psm1
) и двоичные модули (.dll
), импортируемые в состояние сеанса модуля. Файлы в NestedModules запускаются в том порядке, в котором они указаны в значении.
Введите имя каждого модуля в виде строки или хэш-таблицы с ключами ModuleName и ModuleVersion. Хэш-таблица также может иметь необязательный ключ GUID. Строки и хэш-таблицы можно объединить в значении параметра.
Как правило, вложенные модули содержат команды, необходимые корневому модулю для внутренней обработки.
По умолчанию команды в вложенных модулях экспортируются из состояния сеанса модуля в состояние сеанса вызывающего объекта, но корневой модуль может ограничить экспортируемые команды. Например, с помощью команды Export-ModuleMember
.
Вложенные модули в состоянии сеанса модуля доступны корневому модулю, но они не возвращаются командой Get-Module
в состоянии сеанса вызывающего объекта.
Скрипты (.ps1
), перечисленные в nestedModules ключ, выполняются в состоянии сеанса модуля, а не в состоянии сеанса вызывающего объекта. Чтобы запустить скрипт в состоянии сеанса вызывающего объекта, укажите имя файла скрипта в значении ключа ScriptsToProcess манифеста.
Тип: | Object[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-PassThru
Записывает полученный манифест модуля в консоль и создает файл .psd1
. По умолчанию этот командлет не создает выходные данные.
Тип: | SwitchParameter |
Position: | Named |
Default value: | False |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Path
Указывает путь и имя файла нового манифеста модуля. Введите путь и имя файла с расширением имени файла .psd1
, например $pshome\Modules\MyModule\MyModule.psd1
. Требуется параметр пути
Если указать путь к существующему файлу, New-ModuleManifest
заменяет файл без предупреждения, если файл не имеет атрибута только для чтения.
Манифест должен находиться в каталоге модуля, а имя файла манифеста должно совпадать с именем каталога модуля, но с расширением имени файла .psd1
.
Заметка
Нельзя использовать переменные, такие как $PSHOME
или $HOME
, в ответ на запрос на значение параметра пути. Чтобы использовать переменную, добавьте параметр пути
Тип: | String |
Position: | 1 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-PowerShellHostName
Указывает имя конечной программы PowerShell, которую требует модуль. Введите имя хост-программы, например узла интегрированной среды сценариев Windows PowerShell или ConsoleHost. Подстановочные знаки не разрешены.
Чтобы найти имя хост-программы, введите $Host.Name
.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-PowerShellHostVersion
Указывает минимальную версию хост-программы PowerShell, которая работает с модулем. Введите номер версии, например 1.1.
Тип: | Version |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-PowerShellVersion
Указывает минимальную версию PowerShell, которая работает с этим модулем. Например, можно ввести 1.0, 2.0 или 3.0 в качестве значения параметра.
Тип: | Version |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-PrivateData
Указывает данные, передаваемые модулю при его импорте.
Тип: | Object |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ProcessorArchitecture
Указывает архитектуру процессора, требуемую модулем. Допустимые значения: x86, AMD64, IA64, MSIL и None (неизвестно или не указано).
Тип: | ProcessorArchitecture |
Допустимые значения: | None, MSIL, X86, IA64, Amd64, Arm |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ProjectUri
Указывает URL-адрес веб-страницы этого проекта.
Тип: | Uri |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ReleaseNotes
Задает заметки о выпуске.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-RequiredAssemblies
Указывает файлы сборки (.dll
), необходимые модулю. Введите имена файлов сборки.
PowerShell загружает указанные сборки перед обновлением типов или форматов, импортом вложенных модулей или импортом файла модуля, указанного в значении ключа RootModule.
Используйте этот параметр для перечисления всех необходимых сборок, включая сборки, которые необходимо загрузить для обновления всех файлов форматирования или типов, перечисленных в FormatToProcess или TypesToProcess ключей, даже если эти сборки также перечислены как двоичные модули в вложенных модул ключей.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-RequiredModules
Указывает модули, которые должны находиться в состоянии глобального сеанса. Если необходимые модули не в состоянии глобального сеанса, PowerShell импортирует их. Если необходимые модули недоступны, команда Import-Module
завершается ошибкой.
Введите имя каждого модуля в виде строки или хэш-таблицы с ключами ModuleName и ModuleVersion. Хэш-таблица также может иметь необязательный ключ GUID. Строки и хэш-таблицы можно объединить в значении параметра.
В PowerShell 2.0 Import-Module
не импортирует необходимые модули автоматически. Он просто проверяет, находятся ли необходимые модули в состоянии глобального сеанса.
Тип: | Object[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-RootModule
Указывает основной или корневой файл модуля. Введите имя файла скрипта (.ps1
), модуль скрипта (.psm1
), манифест модуля (.psd1
), сборку (.dll
), XML-файл определения командлета (.cdxml
) или рабочий процесс (.xaml
). При импорте модуля члены, экспортированные из корневого файла модуля, импортируются в состояние сеанса вызывающего объекта.
Если модуль содержит файл манифеста и корневой файл не был назначен в ключе RootModule, манифест становится основным файлом для модуля, а модуль становится модулем манифеста (ModuleType = Manifest).
Чтобы экспортировать элементы из .psm1
или .dll
файлов в модуле с манифестом, имена этих файлов необходимо указать в значениях RootModule или NestedModules ключи в манифесте. В противном случае их члены не экспортируются.
Заметка
В PowerShell 2.0 этот ключ был вызван ModuleToProcess. Можно использовать имя параметра RootModule или псевдоним ModuleToProcess.
Тип: | String |
Aliases: | ModuleToProcess |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-ScriptsToProcess
Задает файлы скрипта (.ps1
), которые выполняются в состоянии сеанса вызывающего объекта при импорте модуля.
Эти сценарии можно использовать для подготовки среды так же, как и скрипт входа.
Чтобы указать скрипты, которые выполняются в состоянии сеанса модуля, используйте ключ NestedModules.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-Tags
Задает массив тегов.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-TypesToProcess
Указывает файлы типов (.ps1xml
), которые выполняются при импорте модуля.
При импорте модуля PowerShell запускает командлет Update-TypeData
с указанными файлами.
Так как файлы типов не ограничены, они влияют на все состояния сеанса в сеансе.
Тип: | String[] |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-VariablesToExport
Указывает переменные, экспортируемые модулем. Разрешены подстановочные знаки.
Этот параметр можно использовать для ограничения переменных, экспортируемых модулем. Он может удалять переменные из списка экспортированных переменных, но не может добавлять переменные в список.
Если этот параметр не указан, New-ModuleManifest
создает ключ ПеременныеToExport со значением *
(все), то есть все переменные, определенные в модуле, экспортируются манифестом.
Тип: | String[] |
Position: | Named |
Default value: | * (all) |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | True |
-WhatIf
Показывает, что произойдет, если New-ModuleManifest
выполняется. Командлет не выполняется.
Тип: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
Входные данные
None
Входные данные в этот командлет невозможно передать.
Выходные данные
None or System.String
По умолчанию New-ModuleManifest
не создает выходные данные. Однако если используется параметр PassThru, он создает объект System.String, представляющий манифест модуля.
Примечания
New-ModuleManifest
создает файлы манифеста модуля (.psd1
) в кодировке UTF16.
Манифесты модуля обычно необязательны. Однако для экспорта сборки, установленной в глобальном кэше сборок, требуется манифест модуля.
Чтобы добавить или изменить файлы в каталоге $pshome\Modules
, запустите PowerShell с параметром Запуск от имени администратора.
В PowerShell 2.0 многие параметры New-ModuleManifest
были обязательными, даже если они не требовались в манифесте модуля. Начиная с PowerShell 3.0, обязательны только параметр path.
Сеанс — это экземпляр среды выполнения PowerShell. Сеанс может иметь одно или несколько состояний сеанса. По умолчанию сеанс имеет только глобальное состояние сеанса, но каждый импортированный модуль имеет собственное состояние сеанса. Состояния сеанса позволяют командам в модуле выполняться без влияния на состояние глобального сеанса.
Состояние сеанса вызывающего объекта — это состояние сеанса, в которое импортируется модуль. Как правило, он относится к состоянию глобального сеанса, но когда модуль импортирует вложенные модули, вызывающий — это модуль, а состояние сеанса вызывающего объекта — это состояние сеанса модуля.