Update-ModuleManifest

Referência

Módulo:: PowerShellGet

Atualizações um ficheiro de manifesto de módulo.

Syntax

Update-ModuleManifest
      [-Path] <String>
      [-NestedModules <Object[]>]
      [-Guid <Guid>]
      [-Author <String>]
      [-CompanyName <String>]
      [-Copyright <String>]
      [-RootModule <String>]
      [-ModuleVersion <Version>]
      [-Description <String>]
      [-ProcessorArchitecture <ProcessorArchitecture>]
      [-CompatiblePSEditions <String[]>]
      [-PowerShellVersion <Version>]
      [-ClrVersion <Version>]
      [-DotNetFrameworkVersion <Version>]
      [-PowerShellHostName <String>]
      [-PowerShellHostVersion <Version>]
      [-RequiredModules <Object[]>]
      [-TypesToProcess <String[]>]
      [-FormatsToProcess <String[]>]
      [-ScriptsToProcess <String[]>]
      [-RequiredAssemblies <String[]>]
      [-FileList <String[]>]
      [-ModuleList <Object[]>]
      [-FunctionsToExport <String[]>]
      [-AliasesToExport <String[]>]
      [-VariablesToExport <String[]>]
      [-CmdletsToExport <String[]>]
      [-DscResourcesToExport <String[]>]
      [-PrivateData <Hashtable>]
      [-Tags <String[]>]
      [-ProjectUri <Uri>]
      [-LicenseUri <Uri>]
      [-IconUri <Uri>]
      [-ReleaseNotes <String[]>]
      [-Prerelease <String>]
      [-HelpInfoUri <Uri>]
      [-PassThru]
      [-DefaultCommandPrefix <String>]
      [-ExternalModuleDependencies <String[]>]
      [-PackageManagementProviders <String[]>]
      [-RequireLicenseAcceptance]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

O Update-ModuleManifest cmdlet atualiza um ficheiro de manifesto de módulo (.psd1).

Exemplos

Exemplo 1: Atualizar um manifesto de módulo

Este exemplo atualiza um ficheiro de manifesto de módulo existente. A splatting é utilizada para transmitir valores de parâmetros para Update-ModuleManifest. Para obter mais informações, consulte about_Splatting.

$Params = @{
  Path = "C:\Test\TestManifest.psd1"
  Author = "TestUser1"
  CompanyName = "Contoso Corporation"
  Copyright = "(c) 2019 Contoso Corporation. All rights reserved."
}

Update-ModuleManifest @Params

$Params é um splat que armazena os valores de parâmetros para Path, Author, CompanyName e Copyright. Update-ModuleManifest obtém os valores dos parâmetros de @Params e atualiza o manifesto do módulo TestManifest.psd1.

Parâmetros

-AliasesToExport

Especifica os aliases exportados pelo módulo. Os carateres universais são permitidos.

Utilize este parâmetro para restringir os aliases exportados pelo módulo. O AliasesToExport pode remover aliases da lista de aliases exportados, mas não pode adicionar aliases à lista.

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

-Author

Especifica o autor do módulo.

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

-ClrVersion

Especifica a versão mínima do Common Language Runtime (CLR) do Microsoft .NET Framework que o módulo necessita.

Nota

Esta definição é válida apenas para a edição powerShell Desktop, como Windows PowerShell 5.1, e aplica-se apenas a versões .NET Framework inferiores a 4.5. Este requisito não tem qualquer efeito para versões mais recentes do PowerShell ou do .NET Framework.

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

-CmdletsToExport

Especifica os cmdlets que o módulo exporta. Os carateres universais são permitidos.

Utilize este parâmetro para restringir os cmdlets que são exportados pelo módulo. CmdletsToExport pode remover cmdlets da lista de cmdlets exportados, mas não pode adicionar cmdlets à lista.

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

-CompanyName

Especifica a empresa ou fornecedor que criou o módulo.

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

-CompatiblePSEditions

Especifica as PSEditions compatíveis do módulo. Para obter informações sobre o PSEdition, veja Modules with compatible PowerShell Editions (Módulos com edições do PowerShell compatíveis).

Type:	String[]
Accepted values:	Desktop, Core
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Pede-lhe confirmação antes de executar Update-ModuleManifest.

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

-Copyright

Especifica uma instrução de direitos de autor para o módulo.

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

-DefaultCommandPrefix

Especifica o prefixo de comando predefinido.

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

-Description

Especifica uma descrição do módulo.

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

-DotNetFrameworkVersion

Especifica a versão mínima do microsoft .NET Framework que o módulo necessita.

Nota

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

-DscResourcesToExport

Especifica os recursos Desired State Configuration (DSC) que o módulo exporta. Os carateres universais são permitidos.

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

-ExternalModuleDependencies

Especifica uma matriz de dependências de módulos externos.

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

-FileList

Especifica todos os itens incluídos no módulo.

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

-FormatsToProcess

Especifica os ficheiros de formatação (.ps1xml) que são executados quando o módulo é importado.

Quando importa um módulo, o PowerShell executa o Update-FormatData cmdlet com os ficheiros especificados. Uma vez que os ficheiros de formatação não estão no âmbito, afetam todos os estados de sessão na sessão.

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

-FunctionsToExport

Especifica as funções que o módulo exporta. Os carateres universais são permitidos.

Utilize este parâmetro para restringir as funções que são exportadas pelo módulo. FunctionsToExport pode remover funções da lista de aliases exportados, mas não pode adicionar funções à lista.

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

-Guid

Especifica um identificador exclusivo para o módulo. O GUID pode ser utilizado para distinguir entre módulos com o mesmo nome.

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

-HelpInfoUri

Especifica o endereço internet do ficheiro HelpInfo XML do módulo. Introduza um Uniform Resource Identifier (URI) que comece com http ou https.

O ficheiro HelpInfo XML suporta a funcionalidade Ajuda Atual que foi introduzida na versão 3.0 do PowerShell. Contém informações sobre a localização dos ficheiros de ajuda transferíveis do módulo e os números de versão dos ficheiros de ajuda mais recentes para cada região suportada.

Para obter informações sobre a Ajuda Atualizável, consulte about_Updatable_Help. Para obter informações sobre o ficheiro HelpInfo XML , consulte Suporte de Ajuda Atualizável.

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

-IconUri

Especifica o URL de um ícone para o módulo. O ícone especificado é apresentado na página Web da galeria do módulo.

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

-LicenseUri

Especifica o URL dos termos de licenciamento do módulo.

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

-ModuleList

Especifica uma matriz de módulos incluídos no módulo.

Introduza o nome de cada módulo como uma cadeia ou como uma tabela hash com as chaves ModuleName e ModuleVersion. A tabela hash também pode ter uma chave GUID opcional. Pode combinar cadeias e tabelas hash no valor do parâmetro.

Esta chave foi concebida para funcionar como um inventário de módulos. Os módulos listados no valor desta chave não são processados automaticamente.

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

-ModuleVersion

Especifica a versão do módulo.

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

-NestedModules

Especifica módulos de script (.psm1) e módulos binários (.dll) que são importados para o estado de sessão do módulo. Os ficheiros na chave NestedModules são executados pela ordem pela qual estão listados no valor.

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

-PackageManagementProviders

Especifica uma matriz de fornecedores de gestão de pacotes.

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

-PassThru

Devolve um objeto que representa o item com o qual está a trabalhar. Por predefinição, Update-ModuleManifest não gera nenhuma saída.

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

-Path

Especifica o caminho e o nome do ficheiro do manifesto do módulo. Introduza um caminho e um nome de ficheiro com uma .psd1 extensão de nome de ficheiro, como $PSHOME\Modules\MyModule\MyModule.psd1.

Se especificar o caminho para um ficheiro existente, Update-ModuleManifest substitui o ficheiro sem aviso, a menos que o ficheiro tenha o atributo só de leitura.

O manifesto deve estar localizado no diretório do módulo e o nome do ficheiro de manifesto deve ser o mesmo que o nome do diretório do módulo, mas com uma .psd1 extensão.

Não pode utilizar variáveis, como $PSHOME ou $HOME, em resposta a um pedido de um valor de parâmetro Caminho . Para utilizar uma variável, inclua o parâmetro Caminho no comando .

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

-PowerShellHostName

Especifica o nome do programa anfitrião do PowerShell de que o módulo necessita. Introduza o nome do programa anfitrião, como Anfitrião ISE do PowerShell ou ConsoleHost. Os carateres universais não são permitidos.

Para localizar o nome de um programa anfitrião, no programa, escreva $Host.Name.

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

-PowerShellHostVersion

Especifica a versão mínima do programa anfitrião do PowerShell que funciona com o módulo. Introduza um número de versão, como 1.1.

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

-PowerShellVersion

Especifica a versão mínima do PowerShell que irá funcionar com este módulo. Por exemplo, pode especificar 3.0, 4.0 ou 5.0 como o valor deste parâmetro.

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

-Prerelease

Indica que o módulo é pré-lançamento.

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

-PrivateData

Especifica os dados que são transmitidos para o módulo quando são importados.

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

-ProcessorArchitecture

Especifica a arquitetura do processador de que o módulo necessita.

Os valores aceitáveis para este parâmetro são:

Amd64
Braço
IA64
MSIL
Nenhum (desconhecido ou não especificado)
X86

Type:	ProcessorArchitecture
Accepted values:	None, MSIL, X86, IA64, Amd64, Arm
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProjectUri

Especifica o URL de uma página Web sobre este projeto.

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

-ReleaseNotes

Especifica uma matriz de cadeia que contém notas de versão ou comentários que pretende que estejam disponíveis para esta versão do script.

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

-RequiredAssemblies

Especifica os ficheiros de assemblagem (.dll) necessários para o módulo. Introduza os nomes dos ficheiros de assemblagem. O PowerShell carrega as assemblagens especificadas antes de atualizar tipos ou formatos, importar módulos aninhados ou importar o ficheiro de módulo especificado no valor da chave RootModule .

Utilize este parâmetro para especificar todas as assemblagens necessárias para o módulo, incluindo assemblagens que têm de ser carregadas para atualizar qualquer formatação ou tipo de ficheiros listados nas chaves FormatsToProcess ou TypesToProcess , mesmo que essas assemblagens também estejam listadas como módulos binários na chave NestedModules .

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

-RequiredModules

Especifica módulos que têm de estar no estado de sessão global. Se os módulos necessários não estiverem no estado de sessão global, o PowerShell importa-os. Se os módulos necessários não estiverem disponíveis, o Import-Module comando falha.

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

-RequireLicenseAcceptance

Especifica que é necessária uma aceitação de licença para o módulo.

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

-RootModule

Especifica o ficheiro principal ou raiz do módulo. Introduza o nome de ficheiro de um script (.ps1), um módulo de script (.psm1), um manifesto de módulo (.psd1), uma assemblagem (.dll), um ficheiro XML de definição de cmdlet (.cdxml) ou um fluxo de trabalho (.xaml). Quando o módulo é importado, os membros exportados do ficheiro do módulo de raiz são importados para o estado de sessão do autor da chamada.

Se um módulo tiver um ficheiro de manifesto e não tiver sido especificado nenhum ficheiro de raiz na chave RootModule , o manifesto torna-se o ficheiro primário do módulo. Além disso, o módulo torna-se um módulo de manifesto (ModuleType = Manifesto).

Para exportar membros de .psm1 ou .dll ficheiros num módulo que tenha um manifesto, os nomes desses ficheiros têm de ser especificados nos valores das chaves RootModule ou NestedModules no manifesto. Caso contrário, os respetivos membros não são exportados.

No PowerShell 2.0, esta chave chamava-se ModuleToProcess.

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

-ScriptsToProcess

Especifica ficheiros de script (.ps1) que são executados no estado de sessão do autor da chamada quando o módulo é importado. Pode utilizar estes scripts para preparar um ambiente, tal como pode utilizar um script de início de sessão.

Para especificar scripts que são executados no estado de sessão do módulo, utilize a chave NestedModules .

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

-Tags

Especifica uma matriz de etiquetas.

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

-TypesToProcess

Especifica os ficheiros de tipo (.ps1xml) que são executados quando o módulo é importado.

Ao importar o módulo, o PowerShell executa o Update-TypeData cmdlet com os ficheiros especificados. Uma vez que os ficheiros de tipo não estão no âmbito, afetam todos os estados de sessão na sessão.

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

-VariablesToExport

Especifica as variáveis exportadas pelo módulo. São permitidos carateres universais.

Utilize este parâmetro para restringir as variáveis que são exportadas pelo módulo. VariablesToExport pode remover variáveis da lista de variáveis exportadas, mas não pode adicionar variáveis à lista.

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

-WhatIf

Mostra o que aconteceria se Update-ModuleManifest fosse executado. 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

Saídas

Object

Notas

Importante

A partir de abril de 2020, o Galeria do PowerShell já não suporta as versões 1.0 e 1.1 do Transport Layer Security (TLS). Se não estiver a utilizar o TLS 1.2 ou superior, receberá um erro ao tentar aceder ao Galeria do PowerShell. Utilize o seguinte comando para garantir que está a utilizar o TLS 1.2:

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

Para obter mais informações, veja o anúncio no blogue do PowerShell.

Partilhar via