Publish-Module

  • Referência
Módulo:
PowerShellGet

Publica um módulo especificado do computador local numa galeria online.

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

O Publish-Module cmdlet publica um módulo numa galeria online baseada em NuGet com uma chave de API, armazenada como parte do perfil de um utilizador na galeria. Pode especificar o módulo a publicar pelo nome do módulo ou pelo caminho para a pasta que contém o módulo.

Este é um cmdlet proxy para o Publish-PSResource cmdlet no Microsoft.PowerShell.PSResourceGet. Para obter mais informações, veja Publish-PSResource.

Exemplos

Exemplo 1: Publicar um módulo

Neste exemplo, MyDscModule é publicado na galeria online com a chave de API para indicar a conta da galeria online do proprietário do módulo. Se MyDscModule não for um módulo de manifesto válido que especifique um nome, versão, descrição e autor, ocorrerá um erro.

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

Exemplo 2: publicar um módulo com metadados de galeria

Neste exemplo, MyDscModule é publicado na galeria online com a chave de API para indicar a conta de galeria do proprietário do módulo. Os metadados adicionais fornecidos são apresentados na página Web do módulo na galeria. O proprietário adiciona duas etiquetas de pesquisa para o módulo, relacionando-o com o Active Directory; é adicionada uma breve nota de versão. Se MyDscModule não for um módulo de manifesto válido que especifique um nome, versão, descrição e autor, ocorrerá um erro.

$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

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-Confirm

Pede-lhe confirmação antes de executar o Publish-Module.

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

-Credential

Especifica uma conta de utilizador que tem direitos para publicar um módulo para um fornecedor ou origem de pacote especificado.

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

-Exclude

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-Force

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-FormatVersion

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-IconUri

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-LicenseUri

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-Name

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-NuGetApiKey

Especifica a chave de API que pretende utilizar para publicar um módulo na galeria online. A chave de API faz parte do seu perfil na galeria online e pode ser encontrada na página da sua conta de utilizador na galeria. A chave de API é uma funcionalidade específica do NuGet.

O cmdlet proxy mapeia este parâmetro para o 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 o caminho para o módulo que pretende publicar. Este parâmetro aceita o caminho para a pasta que contém o módulo. A pasta tem de ter o mesmo nome que o módulo.

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

-ProjectUri

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-ReleaseNotes

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-Repository

Especifica o nome amigável de um repositório que foi registado ao executar Register-PSRepository. O repositório tem de ter uma PublishLocation, que é um URI NuGet válido. A PublishLocation pode ser definida ao executar Set-PSRepository.

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

-RequiredVersion

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-SkipAutomaticTags

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-Tags

O cmdlet proxy ignora este parâmetro, uma vez que não é suportado pelo Publish-PSResource.

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

-WhatIf

Mostra o que aconteceria se a execução Publish-Module fosse executada. O cmdlet não é executado.

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

Entradas

String

PSCredential

Saídas

Object

Notas

O PowerShell inclui os seguintes aliases para Publish-Module:

  • Todas as plataformas:
    • pumo

Publish-Module é executado no PowerShell 3.0 ou versões posteriores do PowerShell, no Windows 7 ou Windows 2008 R2 e versões posteriores do Windows.

O Galeria do PowerShell já não suporta as versões 1.0 e 1.1 do Transport Layer Security (TLS). Tem de utilizar o TLS 1.2 ou superior. Utilize o seguinte comando para garantir que está a utilizar o TLS 1.2:

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

A publicação de um módulo requer metadados que são apresentados na página da galeria do módulo. Os metadados necessários incluem o nome do módulo, a versão, a descrição e o autor. Os metadados têm de ser definidos no manifesto do módulo. Para obter mais informações, veja Valores de manifesto de pacote que afetam a IU do Galeria do PowerShell.