Publish-Module

Модуль:

PowerShellGet v3 Module

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

Синтаксис

ModuleNameParameterSet (по умолчанию)

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

ModulePathParameterSet

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.

Свойства параметра

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ModuleNameParameterSet

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Confirm

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

Свойства параметра

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	cf

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Credential

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

Свойства параметра

Тип:	PSCredential
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-Exclude

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

Свойства параметра

Тип:	String[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ModuleNameParameterSet

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Force

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

Свойства параметра

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-FormatVersion

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

Свойства параметра

Тип:	Version
Default value:	None
Допустимые значения:	2.0
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-IconUri

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

Свойства параметра

Тип:	Uri
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-LicenseUri

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

Свойства параметра

Тип:	Uri
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Name

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

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ModuleNameParameterSet

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-NuGetApiKey

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

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

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Path

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

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ModulePathParameterSet

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-ProjectUri

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

Свойства параметра

Тип:	Uri
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-ReleaseNotes

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

Свойства параметра

Тип:	String[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Repository

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

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-RequiredVersion

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

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ModuleNameParameterSet

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-SkipAutomaticTags

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

Свойства параметра

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Tags

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

Свойства параметра

Тип:	String[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-WhatIf

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

Свойства параметра

Тип:	SwitchParameter
Default value:	False
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	wi

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

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

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.

Связанные ссылки

• Find-Module
• Install-Module
• Register-PSRepository
• Set-PSRepository
• Uninstall-Module
• Update-Module