Compartir a través de


Publish-Module

Publica un módulo especificado desde el equipo local en una galería en línea.

Syntax

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

Description

El Publish-Module cmdlet publica un módulo en una galería basada en NuGet en línea mediante una clave de API, almacenada como parte del perfil de un usuario en la galería. Puede especificar que el módulo se publique por el nombre de módulo o por la ruta de acceso a la carpeta que contiene el módulo.

Se trata de un cmdlet de proxy para el Publish-PSResource cmdlet en Microsoft.PowerShell.PSResourceGet. Para obtener más información, consulte Publish-PSResource.

Ejemplos

Ejemplo 1: Publicación de un módulo

En este ejemplo, MyDscModule se publica en la galería en línea mediante la clave de API para indicar la cuenta de la galería en línea del propietario del módulo. Si MyDscModule no es un módulo de manifiesto válido que especifica un nombre, una versión, una descripción y un autor, se produce un error.

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

Ejemplo 2: Publicación de un módulo con metadatos de la galería

En este ejemplo, MyDscModule se publica en la galería en línea mediante la clave de API para indicar la cuenta de la galería del propietario del módulo. Los metadatos adicionales proporcionados se muestran en la página web del módulo de la galería. El propietario agrega dos etiquetas de búsqueda para el módulo, relacionadas con Active Directory; se agrega una breve nota de versión. Si MyDscModule no es un módulo de manifiesto válido que especifica un nombre, una versión, una descripción y un autor, se produce un error.

$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

Parámetros

-AllowPrerelease

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-Confirm

Le pide confirmación antes de ejecutar .Publish-Module

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

-Credential

Especifica una cuenta de usuario que tiene derechos para publicar un módulo para un proveedor de paquetes o un origen especificados.

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

-Exclude

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-Force

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-FormatVersion

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-IconUri

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-LicenseUri

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-Name

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-NuGetApiKey

Especifica la clave de API que desea usar para publicar un módulo en la galería en línea. La clave de API forma parte de su perfil en la galería en línea y se puede encontrar en la página de la cuenta de usuario de la galería. La clave de API es una funcionalidad específica de NuGet.

El cmdlet de proxy asigna este parámetro al parámetro ApiKey de Publish-PSResource.

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

-Path

Especifica la ruta de acceso al módulo que desea publicar. Este parámetro acepta la ruta de acceso a la carpeta que contiene el módulo. La carpeta debe tener el mismo nombre que el módulo.

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

-ProjectUri

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-ReleaseNotes

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-Repository

Especifica el nombre descriptivo de un repositorio que se ha registrado mediante la ejecución Register-PSRepositoryde . El repositorio debe tener una propiedad PublishLocation, que es un URI de NuGet válido. PublishLocation se puede establecer mediante la ejecución Set-PSRepositoryde .

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

-RequiredVersion

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-SkipAutomaticTags

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-Tags

El cmdlet de proxy omite este parámetro, ya que no es compatible con Publish-PSResource.

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

-WhatIf

Muestra lo que sucedería si se ejecuta.Publish-Module El cmdlet no se ejecuta.

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

Entradas

String

PSCredential

Salidas

Object

Notas

PowerShell incluye los siguientes alias para Publish-Module:

  • Todas las plataformas:
    • pumo

Publish-Module se ejecuta en PowerShell 3.0 o versiones posteriores de PowerShell, en Windows 7 o Windows 2008 R2 y versiones posteriores de Windows.

El Galería de PowerShell ya no admite las versiones 1.0 y 1.1 de Seguridad de la capa de transporte (TLS). Debe usar TLS 1.2 o superior. Use el siguiente comando para asegurarse de que usa TLS 1.2:

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

La publicación de un módulo requiere los metadatos que se muestran en la página de la galería para el módulo. Los metadatos necesarios incluyen el nombre del módulo, la versión, la descripción y el autor. Los metadatos deben definirse en el manifiesto del módulo. Para obtener más información, consulte Valores del manifiesto del paquete que afectan a la interfaz de usuario de Galería de PowerShell.