O cmdlet Publish-Module publica um módulo em uma galeria online baseada em NuGet usando uma chave de API, armazenada como parte do perfil de um usuário na galeria. Você pode especificar o módulo a ser publicado pelo nome do módulo ou pelo caminho para a pasta que contém o módulo.
Quando você especifica um módulo por nome, Publish-Module publica o primeiro módulo que seria encontrado executando Get-Module -ListAvailable <Name>. Se você especificar uma versão mínima de um módulo a ser publicado, Publish-Module publicará o primeiro módulo com uma versão maior ou igual à versão mínima especificada.
Exemplos
Exemplo 1: publicar um módulo
Neste exemplo, MyDscModule é publicado na galeria online usando 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 especifica um nome, versão, descrição e autor, ocorrerá um erro.
Exemplo 2: publicar um módulo com metadados da galeria
Neste exemplo, MyDscModule é publicado na galeria online usando a chave de API para indicar a conta da galeria do proprietário do módulo. Os metadados adicionais fornecidos são exibidos na página da Web do módulo na galeria. O proprietário adiciona duas marcas de pesquisa para o módulo, relacionando-o ao Active Directory; uma breve nota de versão é adicionada. Se MyDscModule não for um módulo de manifesto válido que especifica um nome, versão, descrição e autor, ocorrerá um erro.
Publish-Module -Name "MyDscModule" -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73" -LicenseUri "https://contoso.com/license" -Tag "Active Directory","DSC" -ReleaseNote "Updated the ActiveDirectory DSC Resources to support adding users."
Parâmetros
-Confirm
Solicita a confirmação antes de executar o Publish-Module.
Propriedades do parâmetro
Tipo:
SwitchParameter
Valor padrão:
False
Dá suporte a curingas:
False
DontShow:
False
Aliases:
cf
Conjuntos de parâmetros
(All)
Cargo:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
False
Valor dos argumentos restantes:
False
-FormatVersion
Aceita apenas valores válidos especificados pelo atributo ValidateSet.
Especifica a URL de um ícone para o módulo. O ícone especificado é exibido na página da Web da galeria do módulo.
Propriedades do parâmetro
Tipo:
Uri
Valor padrão:
None
Dá suporte a curingas:
False
DontShow:
False
Conjuntos de parâmetros
(All)
Cargo:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
False
Valor dos argumentos restantes:
False
-LicenseUri
Especifica a URL dos termos de licenciamento para o módulo que você deseja publicar.
Propriedades do parâmetro
Tipo:
Uri
Valor padrão:
None
Dá suporte a curingas:
False
DontShow:
False
Conjuntos de parâmetros
(All)
Cargo:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
False
Valor dos argumentos restantes:
False
-Name
Especifica o nome do módulo que você deseja publicar.
Publish-Module pesquisa o nome do módulo especificado em $Env:PSModulePath.
Propriedades do parâmetro
Tipo:
String
Valor padrão:
None
Dá suporte a curingas:
False
DontShow:
False
Conjuntos de parâmetros
ModuleNameParameterSet
Cargo:
Named
Obrigatório:
True
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
True
Valor dos argumentos restantes:
False
-NuGetApiKey
Especifica a chave de API que você deseja usar 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 usuário na galeria. A chave de API é uma funcionalidade específica do NuGet.
Propriedades do parâmetro
Tipo:
String
Valor padrão:
None
Dá suporte a curingas:
False
DontShow:
False
Conjuntos de parâmetros
(All)
Cargo:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
False
Valor dos argumentos restantes:
False
-Path
Especifica o caminho para o módulo que você deseja publicar. Esse parâmetro aceita o caminho para a pasta que contém o módulo.
Propriedades do parâmetro
Tipo:
String
Valor padrão:
None
Dá suporte a curingas:
False
DontShow:
False
Conjuntos de parâmetros
ModulePathParameterSet
Cargo:
Named
Obrigatório:
True
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
True
Valor dos argumentos restantes:
False
-ProjectUri
Especifica a URL de uma página da Web sobre este projeto.
Propriedades do parâmetro
Tipo:
Uri
Valor padrão:
None
Dá suporte a curingas:
False
DontShow:
False
Conjuntos de parâmetros
(All)
Cargo:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
False
Valor dos argumentos restantes:
False
-ReleaseNotes
Especifica uma cadeia de caracteres que contém notas de versão ou comentários que você deseja estar disponível para os usuários desta versão do módulo.
Propriedades do parâmetro
Tipo:
String[]
Valor padrão:
None
Dá suporte a curingas:
False
DontShow:
False
Conjuntos de parâmetros
(All)
Cargo:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
False
Valor dos argumentos restantes:
False
-Repository
Especifica o nome amigável de um repositório que foi registrado executando Register-PSRepository. O repositório deve ter um PublishLocation, que é um URI nuGet válido.
O PublishLocation pode ser definido executando .
Propriedades do parâmetro
Tipo:
String
Valor padrão:
None
Dá suporte a curingas:
False
DontShow:
False
Conjuntos de parâmetros
(All)
Cargo:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
False
Valor dos argumentos restantes:
False
-RequiredVersion
Especifica a versão exata de um único módulo a ser publicado.
Propriedades do parâmetro
Tipo:
Version
Valor padrão:
None
Dá suporte a curingas:
False
DontShow:
False
Conjuntos de parâmetros
ModuleNameParameterSet
Cargo:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
False
Valor dos argumentos restantes:
False
-Tags
Adiciona uma ou mais marcas ao módulo que você está publicando. As marcas de exemplo incluem DesiredStateConfiguration, DSC, DSCResourceKit ou PSModule. Separe várias marcas com vírgulas.
Propriedades do parâmetro
Tipo:
String[]
Valor padrão:
None
Dá suporte a curingas:
False
DontShow:
False
Conjuntos de parâmetros
(All)
Cargo:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
False
Valor dos argumentos restantes:
False
-WhatIf
Mostra o que aconteceria se Publish-Module fosse executado. O cmdlet não é executado.
Propriedades do parâmetro
Tipo:
SwitchParameter
Valor padrão:
False
Dá suporte a curingas:
False
DontShow:
False
Aliases:
wi
Conjuntos de parâmetros
(All)
Cargo:
Named
Obrigatório:
False
Valor do pipeline:
False
Valor do pipeline pelo nome da propriedade:
False
Valor dos argumentos restantes:
False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
Entradas
PSModuleInfo
Saídas
None
Publish-Module não mostrará nenhuma saída se um módulo for publicado com êxito.
Observações
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.
A publicação de um módulo requer metadados exibidos 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. A maioria dos metadados é obtida do manifesto do módulo, mas alguns metadados podem ser especificados em parâmetros Publish-Module, como Tag, ReleaseNote, IconUri, ProjectUri e LicenseUri. Para obter mais informações, consulte Valores de manifesto do pacote que afetam a interface do usuário da Galeria do PowerShell.