Update-ModuleManifest

Referência

Módulo:: PowerShellGet

Atualiza um arquivo de manifesto do 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 arquivo de manifesto do módulo (.psd1).

Este é um cmdlet proxy para o Update-PSModuleManifest cmdlet no Microsoft.PowerShell.PSResourceGet. Para obter mais informações, consulte Update-PSModuleManifest.

Exemplos

Exemplo 1: Atualizar um manifesto de módulo

Este exemplo atualiza um arquivo de manifesto de módulo existente. O splatting é usado para passar valores de parâmetro 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âmetro para Path, Author, CompanyName e Copyright. Update-ModuleManifest obtém os valores de parâmetro de @Params e atualiza o manifesto do módulo, TestManifest.psd1.

Parâmetros

-AliasesToExport

Especifica os aliases que o módulo exporta. Caracteres curinga são permitidos.

Use esse parâmetro para restringir os aliases exportados pelo módulo. 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 CLR (Common Language Runtime) do Microsoft .NET Framework que o módulo exige.

Observação

Essa configuração é válida apenas para a edição do PowerShell Desktop, como Windows PowerShell 5.1, e só se aplica a .NET Framework versões inferiores à 4.5. Esse requisito não tem 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. Caracteres curinga são permitidos.

Use esse parâmetro para restringir os cmdlets 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 o 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, consulte Módulos com edições compatíveis do PowerShell.

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

-Confirm

Solicita a 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 declaração de direitos autorais do 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 padrão.

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 exige.

Observação

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

-DscResourcesToExport

Especifica os recursos de Desired State Configuration (DSC) que o módulo exporta. Caracteres curinga 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ódulo externo.

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 arquivos de formatação (.ps1xml) que são executados quando o módulo é importado.

Quando você importa um módulo, o PowerShell executa o Update-FormatData cmdlet com os arquivos especificados. Como os arquivos de formatação não têm escopo, eles 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. Caracteres curinga são permitidos.

Use esse parâmetro para restringir as funções 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 usado 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 da Internet do arquivo XML HelpInfo do módulo. Insira um URI (Uniform Resource Identifier) que comece com http ou https.

O arquivo XML HelpInfo dá suporte ao recurso Ajuda Atualizável que foi introduzido no PowerShell versão 3.0. Ele contém informações sobre o local dos arquivos de ajuda para download do módulo e os números de versão dos arquivos de ajuda mais recentes para cada localidade com suporte.

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

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

-IconUri

Especifica a URL de um ícone para o módulo. O ícone especificado é exibido na página da 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 a 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.

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

Essa chave foi projetada para atuar como um inventário de módulo. Os módulos listados no valor dessa 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 arquivos na chave NestedModules são executados na ordem em que 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 provedores de gerenciamento de pacotes.

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

-PassThru

Retorna um objeto que representa o item com o qual você está trabalhando. Por padrã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 arquivo do manifesto do módulo. Insira um caminho e um nome de arquivo com uma .psd1 extensão de nome de arquivo, como $PSHOME\Modules\MyModule\MyModule.psd1.

Se você especificar o caminho para um arquivo existente, Update-ModuleManifest substituirá o arquivo sem aviso, a menos que o arquivo tenha o atributo somente leitura.

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

Você não pode usar variáveis, como $PSHOME ou $HOME, em resposta a um prompt para um valor de parâmetro Path . Para usar uma variável, inclua o parâmetro Path 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 host do PowerShell que o módulo requer. Insira o nome do programa host, como Host ISE do PowerShell ou ConsoleHost. Curingas não são permitidos.

Para localizar o nome de um programa host, no programa, digite $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 host do PowerShell que funciona com o módulo. Insira 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 funcionará com este módulo. Por exemplo, você pode especificar 3.0, 4.0 ou 5.0 como o valor desse 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 passados para o módulo quando ele é importado.

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

-ProcessorArchitecture

Especifica a arquitetura do processador que o módulo requer.

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

Amd64
Arm
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 a URL de uma página da 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 de caracteres que contém notas de versão ou comentários que você deseja que 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 arquivos de assembly (.dll) exigidos pelo módulo. Digite os nomes de arquivo de assembly. O PowerShell carrega os assemblies especificados antes de atualizar tipos ou formatos, importar módulos aninhados ou importar o arquivo de módulo especificado no valor da chave RootModule .

Use esse parâmetro para especificar todos os assemblies que o módulo requer, incluindo assemblies que devem ser carregados para atualizar qualquer formatação ou arquivos de tipo listados nas chaves FormatsToProcess ou TypesToProcess , mesmo que esses assemblies também estejam listados 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 os módulos que devem estar no estado de sessão global. Se os módulos necessários não estiverem no estado de sessão global, o PowerShell os importará. Se os módulos necessários não estiverem disponíveis, o Import-Module comando falhará.

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

-RequireLicenseAcceptance

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

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

-RootModule

Especifica o arquivo primário ou raiz do módulo. Insira o nome de arquivo de um script (.ps1), um módulo de script (.psm1), um manifesto do módulo (.psd1), um assembly (.dll), um arquivo XML de definição de cmdlet (.cdxml) ou um fluxo de trabalho (.xaml). Quando o módulo é importado, os membros que são exportados do arquivo do módulo raiz são importados para o estado de sessão do chamador.

Se um módulo tiver um arquivo de manifesto e nenhum arquivo raiz tiver sido especificado na chave RootModule , o manifesto se tornará o arquivo primário do módulo. E o módulo se torna um módulo de manifesto (ModuleType = Manifest).

Para exportar membros de .psm1 arquivos ou .dll em um módulo que tenha um manifesto, os nomes desses arquivos devem ser especificados nos valores das chaves RootModule ou NestedModules no manifesto. Caso contrário, seus membros não serão exportados.

No PowerShell 2.0, essa chave se chamava ModuleToProcess.

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

-ScriptsToProcess

Especifica arquivos de script (.ps1) que são executados no estado de sessão do chamador quando o módulo é importado. Você pode usar esses scripts para preparar um ambiente, assim como você pode usar um script de logon.

Para especificar scripts que são executados no estado de sessão do módulo, use 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 marcas.

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

-TypesToProcess

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

Quando você importa o módulo, o PowerShell executa o Update-TypeData cmdlet com os arquivos especificados. Como os arquivos de tipo não têm escopo, eles 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 que o módulo exporta. Caracteres curinga são permitidos.

Use esse parâmetro para restringir as variáveis 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