Publish-Module

  • Ссылка
Модуль:
PowerShellGet

Публикует указанный модуль с локального компьютера в коллекцию в Интернете.

Синтаксис

Publish-Module
       -Name <String>
       [-RequiredVersion <String>]
       [-NuGetApiKey <String>]
       [-Repository <String>]
       [-Credential <PSCredential>]
       [-FormatVersion <Version>]
       [-ReleaseNotes <String[]>]
       [-Tags <String[]>]
       [-LicenseUri <Uri>]
       [-IconUri <Uri>]
       [-ProjectUri <Uri>]
       [-Exclude <String[]>]
       [-Force]
       [-AllowPrerelease]
       [-SkipAutomaticTags]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Publish-Module
       -Path <String>
       [-NuGetApiKey <String>]
       [-Repository <String>]
       [-Credential <PSCredential>]
       [-FormatVersion <Version>]
       [-ReleaseNotes <String[]>]
       [-Tags <String[]>]
       [-LicenseUri <Uri>]
       [-IconUri <Uri>]
       [-ProjectUri <Uri>]
       [-Force]
       [-SkipAutomaticTags]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Описание

Командлет Publish-Module публикует модуль в онлайн-коллекции на основе NuGet с помощью ключа API, хранящегося в составе профиля пользователя в коллекции. Модуль для публикации можно указывать с помощью имени модуля или пути к папке, содержащей модуль.

Это командлет прокси-сервера для командлета Publish-PSResource в Microsoft.PowerShell.PSResourceGet. Дополнительные сведения см. в разделе Publish-PSResource.

Примеры

Пример 1. Публикация модуля

В этом примере MyDscModule публикуется в онлайн-коллекции с помощью ключа API для указания учетной записи владельца модуля в коллекции. Если MyDscModule не является допустимым модулем манифеста, указывающим имя, версию, описание и автора, возникает ошибка.

Publish-Module -Path c:\projects\MyDscModule\1.0.0 -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73"

Пример 2. Публикация модуля с метаданными коллекции

В этом примере MyDscModule публикуется в онлайн-коллекции с помощью ключа API для указания учетной записи владельца модуля. Дополнительные метаданные отображаются на веб-странице модуля в коллекции. Владелец добавляет два тега поиска для модуля, связав его с Active Directory; добавлена краткая заметка о выпуске. Если MyDscModule не является допустимым модулем манифеста, указывающим имя, версию, описание и автора, возникает ошибка.

$parameters = @{
    Path        = 'c:\projects\MyDscModule\1.0.0'
    NuGetApiKey = '11e4b435-6cb4-4bf7-8611-5162ed75eb73'
    LicenseUri  = 'http://contoso.com/license'
    Tag         = 'Active Directory','DSC'
    ReleaseNote = 'Updated the ActiveDirectory DSC Resources to support adding users.'
}
Publish-Module @parameters

Параметры

-AllowPrerelease

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Запрашивает подтверждение перед запуском Publish-Module.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Указывает учетную запись пользователя, которая имеет права на публикацию модуля для указанного поставщика пакета или источника.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Exclude

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FormatVersion

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:Version
Accepted values:2.0
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IconUri

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LicenseUri

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-NuGetApiKey

Указывает ключ API, который требуется использовать для публикации модуля в онлайн-коллекции. Ключ API является частью вашего профиля в онлайн-коллекции. Его можно найти на странице учетной записи пользователя в коллекции. Ключ API — это функциональные возможности NuGet.

Командлет прокси-сервера сопоставляет этот параметр с параметром ApiKey объекта Publish-PSResource.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Указывает путь к модулю, который требуется опубликовать. Этот параметр принимает путь к папке, содержащей модуль. Имя папки должно совпадать с именем модуля.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProjectUri

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReleaseNotes

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Repository

Указывает понятное имя репозитория, зарегистрированного с помощью команды Register-PSRepository. Репозиторий должен иметь значение PublishLocation, которое является допустимым URI NuGet. Параметр PublishLocation можно задать, выполнив команду Set-PSRepository.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredVersion

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkipAutomaticTags

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tags

Командлет прокси-сервера игнорирует этот параметр, так как он не поддерживается Publish-PSResource.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Показывает, что произойдет при выполнении Publish-Module . Командлет не выполняется.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

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

String

PSCredential

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

Object

Примечания

PowerShell включает следующие псевдонимы для Publish-Module:

  • Для всех платформ.
    • pumo

Publish-Module Выполняется в PowerShell 3.0 или более поздних выпусках PowerShell, Windows 7 или Windows 2008 R2 и более поздних выпусках Windows.

Коллекция PowerShell больше не поддерживает протокол TLS версий 1.0 и 1.1. Необходимо использовать TLS 1.2 или более поздней версии. Чтобы проверить, используется ли TLS 1.2, выполните следующую команду:

[Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12

Для публикации модуля требуются метаданные, которые отображаются на странице коллекции для этого модуля. Обязательные метаданные включают имя модуля, версию, описание и автора. Метаданные должны быть определены в манифесте модуля. Дополнительные сведения см. в статье Значения манифеста пакета, влияющие на пользовательский интерфейс коллекция PowerShell.