The Publish-Module cmdlet publishes a module to an online NuGet-based gallery by using an API key,
stored as part of a user's profile in the gallery. You can specify the module to publish either by
the module's name, or by the path to the folder containing the module.
This is a proxy cmdlet for the Publish-PSResource cmdlet in the
Microsoft.PowerShell.PSResourceGet. For more information, see
Publish-PSResource.
示例
Example 1: Publish a module
In this example, MyDscModule is published to the online gallery by using the API key to indicate
the module owner's online gallery account. If MyDscModule is not a valid manifest module that
specifies a name, version, description, and author, an error occurs.
In this example, MyDscModule is published to the online gallery by using the API key to indicate
the module owner's gallery account. The additional metadata provided is displayed on the webpage for
the module in the gallery. The owner adds two search tags for the module, relating it to Active
Directory; a brief release note is added. If MyDscModule is not a valid manifest module that
specifies a name, version, description, and author, an error occurs.
$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
The proxy cmdlet ignores this parameter since it's not supported by Publish-PSResource.
Specifies the API key that you want to use to publish a module to the online gallery. The API key is
part of your profile in the online gallery, and can be found on your user account page in the
gallery. The API key is NuGet-specific functionality.
The proxy cmdlet maps this parameter to the ApiKey parameter of Publish-PSResource.
Specifies the path to the module that you want to publish. This parameter accepts the path to the
folder that contains the module. The folder must have the same name as the module.
Specifies the friendly name of a repository that has been registered by running
Register-PSRepository. The repository must have a PublishLocation, which is a valid NuGet URI.
The PublishLocation can be set by running Set-PSRepository.
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters.
PowerShell includes the following aliases for Publish-Module:
All platforms:
pumo
Publish-Module runs on PowerShell 3.0 or later releases of PowerShell, on Windows 7 or Windows
2008 R2 and later releases of Windows.
The PowerShell Gallery no longer supports Transport Layer Security (TLS) versions 1.0 and 1.1. You
must use TLS 1.2 or higher. Use the following command to ensure you are using TLS 1.2:
Publishing a module requires metadata that is displayed on the gallery page for the module. Required
metadata includes the module name, version, description, and author. The metadata must be defined in
the module manifest. For more information, see
Package manifest values that impact the PowerShell Gallery UI.
