Publish-Module

Módulo:

PowerShellGet Module

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

Sintaxis

ModuleNameParameterSet (valor predeterminado)

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

Description

El cmdlet Publish-Module 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 el módulo para publicarlo por el nombre del módulo o por la ruta de acceso a la carpeta que contiene el módulo.

Al especificar un módulo por nombre, Publish-Module publica el primer módulo que se encontraría ejecutando Get-Module -ListAvailable <Name>. Si especifica una versión mínima de un módulo que se va a publicar, Publish-Module publica el primer módulo con una versión mayor o igual que la versión mínima especificada.

La publicación de un módulo requiere metadatos que se muestran en la página de la galería del módulo. Los metadatos necesarios incluyen el nombre del módulo, la versión, la descripción y el autor. Aunque la mayoría de los metadatos se toman del manifiesto del módulo, algunos metadatos deben especificarse en Publish-Module parámetros, como Tag, ReleaseNote, IconUri, ProjectUri y LicenseUri, ya que estos parámetros coinciden con los campos de una galería basada en NuGet.

Los parámetros que toman números de versión del módulo esperan cadenas con formato de números de versión.

• Los números de versión estándar tienen un formato de x.y.z donde x, y y z son números
• Las versiones preliminares tienen un formato de x.y.z-<prerelease_label> donde la <prerelease_label> cadena arbitraria está asignada a esa versión.

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 -Name "MyDscModule" -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, en relación 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 = @{
    Name        = "MyDscModule"
    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

Permite publicar módulos marcados como versión preliminar.

Propiedades de parámetro

Tipo:	SwitchParameter
Valor predeterminado:	False
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

ModuleNameParameterSet

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-Confirm

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

Propiedades de parámetro

Tipo:	SwitchParameter
Valor predeterminado:	False
Admite caracteres comodín:	False
DontShow:	False
Alias:	cf

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-Credential

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

Propiedades de parámetro

Tipo:	PSCredential
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-Exclude

Define los archivos que se excluirán del módulo publicado.

Propiedades de parámetro

Tipo:	String[]
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

ModuleNameParameterSet

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-Force

Obliga a que el comando se ejecute sin pedir confirmación del usuario.

Propiedades de parámetro

Tipo:	SwitchParameter
Valor predeterminado:	False
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-FormatVersion

Acepta solo los valores válidos especificados por el atributo ValidateSet.

Para obtener más información, vea de declaración de atributos ValidateSet y ValidateSetAttribute.

Propiedades de parámetro

Tipo:	Version
Valor predeterminado:	None
Valores aceptados:	2.0
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-IconUri

Especifica la dirección URL de un icono para el módulo. El icono especificado se muestra en la página web de la galería del módulo.

Propiedades de parámetro

Tipo:	Uri
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-LicenseUri

Especifica la dirección URL de los términos de licencia del módulo que desea publicar.

Propiedades de parámetro

Tipo:	Uri
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-Name

Especifica el nombre del módulo que desea publicar. Publish-Module busca el nombre del módulo especificado en $Env:PSModulePath.

Propiedades de parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

ModuleNameParameterSet

Posición:	Named
Obligatorio:	True
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	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.

Propiedades de parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	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.

Propiedades de parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

ModulePathParameterSet

Posición:	Named
Obligatorio:	True
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	True
Valor de los argumentos restantes:	False

-ProjectUri

Especifica la dirección URL de una página web sobre este proyecto.

Propiedades de parámetro

Tipo:	Uri
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-ReleaseNotes

Especifica una cadena que contiene notas de la versión o comentarios que desea que estén disponibles para los usuarios de esta versión del módulo.

Propiedades de parámetro

Tipo:	String[]
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-Repository

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

Propiedades de parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-RequiredVersion

Especifica la versión exacta de un único módulo que se va a publicar.

Propiedades de parámetro

Tipo:	String
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

ModuleNameParameterSet

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-SkipAutomaticTags

Quita los comandos y los recursos que se incluyen como etiquetas. Omite automáticamente la adición de etiquetas a un módulo.

Propiedades de parámetro

Tipo:	SwitchParameter
Valor predeterminado:	False
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-Tags

Agrega una o varias etiquetas al módulo que está publicando. Las etiquetas de ejemplo incluyen DesiredStateConfiguration, DSC, DSCResourceKit o PSModule. Separe varias etiquetas con comas.

Propiedades de parámetro

Tipo:	String[]
Valor predeterminado:	None
Admite caracteres comodín:	False
DontShow:	False

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

-WhatIf

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

Propiedades de parámetro

Tipo:	SwitchParameter
Valor predeterminado:	False
Admite caracteres comodín:	False
DontShow:	False
Alias:	Wi

Conjuntos de parámetros

(All)

Posición:	Named
Obligatorio:	False
Valor de la canalización:	False
Valor de la canalización por nombre de propiedad:	False
Valor de los argumentos restantes:	False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

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.

Importante

A partir de abril de 2020, la Galería de PowerShell ya no admite las versiones 1.0 y 1.1 de seguridad de la capa de transporte (TLS). Si no usa TLS 1.2 o superior, recibirá un error al intentar acceder a la Galería de PowerShell. Use el comando siguiente para asegurarse de que usa TLS 1.2:

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

Para obtener más información, consulte el anuncio en el blog de PowerShell.

La publicación de un módulo requiere metadatos que se muestran en la página de la galería del módulo. Los metadatos necesarios incluyen el nombre del módulo, la versión, la descripción y el autor. La mayoría de los metadatos se toman del manifiesto del módulo, pero algunos metadatos se pueden especificar en parámetros Publish-Module, como Tag, ReleaseNote, IconUri, ProjectUriy LicenseUri. Para obtener más información, consulte Valores de manifiesto del paquete que afectan a la interfaz de usuario de la Galería de PowerShell.

Vínculos relacionados

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