Update-PSModuleManifest

Referência

Módulo:: Microsoft.PowerShell.PSResourceGet

Atualiza um arquivo de manifesto do módulo.

Syntax

Update-PSModuleManifest
      [-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[]>]
      [-Tags <String[]>]
      [-ProjectUri <Uri>]
      [-LicenseUri <Uri>]
      [-IconUri <Uri>]
      [-ReleaseNotes <String>]
      [-Prerelease <String>]
      [-HelpInfoUri <Uri>]
      [-DefaultCommandPrefix <String>]
      [-ExternalModuleDependencies <String[]>]
      [-RequireLicenseAcceptance]
      [-PrivateData <Hashtable>]
      [<CommonParameters>]

Description

Esse cmdlet atualiza os dados armazenados em um arquivo de manifesto do módulo. Os parâmetros permitem que você especifique quais propriedades são atualizadas. Update-PSModuleManifest substitui todos os valores existentes no manifesto do módulo.

O cmdlet não retorna um objeto .

Exemplos

Exemplo 1

Este exemplo altera a propriedade Author no manifesto do módulo para New Author.

Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Author 'New Author'

Exemplo 2

Este exemplo altera a propriedade Prerelease para beta2.

Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Prerelease 'beta2'

Exemplo 3

Este exemplo atualiza várias propriedades.

$parameters = @{
    Path = 'C:\MyModules\TestModule'
    Tags = 'Windows', 'Linux'
    Description = 'A module for managing packages.'
}
Update-PSModuleManifest

Parâmetros

-AliasesToExport

Especifica os aliases 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:	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 exigida pelo módulo.

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.

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

-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 exigida pelo módulo.

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) exportados pelo módulo. Caracteres curinga são permitidos.

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

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

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 é 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:.

Para obter mais informações, consulte Ajuda atualizável.

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

-IconUri

Especifica o URI 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 cada nome de módulo como uma cadeia de caracteres ou como 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.

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.

Type:	Object[]
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 filename com uma .psd1 extensão de arquivo.

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

-PowerShellHostName

Especifica o nome do programa host do PowerShell exigido pelo módulo. Insira o nome do programa host, como Host ISE do PowerShell ou ConsoleHost. Curingas não são permitidos.

O nome de um programa host é armazenado em $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 funciona com este módulo. Por exemplo, você pode especificar versões como 5.1 ou 7.2.

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

-Prerelease

Especifica o valor de pré-lançamento acrescentado à versão do módulo. Por exemplo, se Prerelease for preview e ModuleVersion for 1.0.0, a versão do módulo será 1.0.0-preview.

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

-PrivateData

Especifica os dados passados para o módulo quando eles são importados. Pode ser qualquer valor arbitrário armazenado em uma tabela de hash.

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
None (desconhecido ou não especificado)
X86

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

-ProjectUri

Especifica o URI 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 cadeia de caracteres que contém notas de versão ou comentários para o módulo.

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. O PowerShell carrega os assemblies especificados antes de atualizar tipos ou formatos, importar módulos aninhados ou importar o arquivo de módulo especificado na chave RootModule .

Use RequiredAssemblies para 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 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á.

O valor pode ser uma matriz que contém nomes de módulo ou especificações de módulo. Uma especificação de módulo é uma tabela de hash que tem as chaves a seguir.

ModuleName - Necessário Especifica o nome do módulo.
GUID - Opcional Especifica o GUID do módulo.
Também é necessário especificar pelo menos uma das três chaves abaixo.
- ModuleVersion – Especifica uma versão mínima aceitável do módulo.
- MaximumVersion – Especifica a versão máxima aceitável do módulo.
- RequiredVersion – Especifica uma versão exata e necessária do módulo. Isso não pode ser usado com as outras chaves de versão.

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:	False
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 de módulo (.psd1), um assembly (.dll) ou um arquivo XML de definição de cmdlet (.cdxml). Quando o módulo é importado, os membros exportados 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 for especificado na chave RootModule , o manifesto se tornará o arquivo primário do módulo. O módulo é conhecido como módulo de manifesto (ModuleType = Manifest).

Para exportar membros de .psm1 arquivos ou .dll , os nomes desses arquivos devem ser especificados nos valores das chaves RootModule ou NestedModules no manifesto.

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[]
Aliases:	Tag
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 quais variáveis são exportadas pelo módulo.

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

Entradas

None

Saídas

Object

Observações

Para obter uma descrição completa do arquivo de manifesto do módulo, consulte about_Module_Manifests.

New-ModuleManifest

Compartilhar via