Partilhar via


Update-PSModuleManifest

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

Sintaxe

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

Este cmdlet atualiza os dados armazenados num ficheiro de manifesto de módulo. Os parâmetros permitem-lhe especificar as propriedades que são atualizadas. Update-PSModuleManifest substitui quaisquer valores existentes no manifesto do módulo.

O cmdlet não devolve um objeto.

Exemplos

Exemplo 1

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

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

Exemplo 2

Este exemplo altera a propriedade Pré-lançamento 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 exportados pelo módulo. Os carateres universais são permitidos.

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:True

-Author

Especifica o autor do módulo.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ClrVersion

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

Tipo:Version
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-CmdletsToExport

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

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:True

-CompanyName

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

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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).

Tipo:String[]
Valores aceites:Desktop, Core
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

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

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DefaultCommandPrefix

Especifica o prefixo de comando predefinido.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Description

Especifica uma descrição do módulo.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DotNetFrameworkVersion

Especifica a versão mínima do microsoft .NET Framework necessária pelo módulo.

Tipo:Version
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-DscResourcesToExport

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

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:True

-ExternalModuleDependencies

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

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-FileList

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

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-FormatsToProcess

Especifica os ficheiros de formatação (.ps1xml) que são processados 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.

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-FunctionsToExport

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

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:True

-Guid

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

Tipo:Guid
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-HelpInfoUri

Especifica o endereço internet do ficheiro HelpInfo XML do módulo. Introduza um Identificador de Recursos Uniforme (URI) que comece com http: ou https:.

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

Tipo:Uri
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-IconUri

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

Tipo:Uri
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-LicenseUri

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

Tipo:Uri
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ModuleList

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

Introduza cada nome de módulo como uma cadeia ou como uma tabela hash com as teclas 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.

Tipo:Object[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ModuleVersion

Especifica a versão do módulo.

Tipo:Version
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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.

Introduza cada nome de módulo como uma cadeia ou como uma tabela hash com as teclas 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.

Tipo:Object[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Path

Especifica o caminho e o nome do ficheiro do manifesto do módulo. Introduza filename com uma extensão de .psd1 ficheiro.

Tipo:String
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais: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.

O nome de um programa anfitrião é armazenado em $Host.Name.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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.

Tipo:Version
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-PowerShellVersion

Especifica a versão mínima do PowerShell que funciona com este módulo. Por exemplo, pode especificar versões como 5.1 ou 7.2.

Tipo:Version
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Prerelease

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

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-PrivateData

Especifica os dados que são transmitidos para o módulo quando são importados. Podem ser valores arbitrários armazenados numa tabela hash.

Tipo:Hashtable
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ProcessorArchitecture

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

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

  • Amd64
  • Arm
  • IA64
  • MSIL
  • None (desconhecido ou não especificado)
  • X86
Tipo:ProcessorArchitecture
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ProjectUri

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

Tipo:Uri
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-ReleaseNotes

Especifica uma cadeia que contém notas de versão ou comentários para o módulo.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-RequiredAssemblies

Especifica os ficheiros de assemblagem (.dll) necessários pelo módulo. O PowerShell carrega as assemblagens especificadas antes de atualizar tipos ou formatos, importar módulos aninhados ou importar o ficheiro de módulo especificado na chave RootModule .

Utilize o RequiredAssemblies para assemblagens que têm de ser carregadas para atualizar quaisquer ficheiros de formatação ou tipo listados nas teclas FormatsToProcess ou TypesToProcess , mesmo que essas assemblagens também estejam listadas na chave NestedModules .

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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 falhará.

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

  • 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 aceitável mínima 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. Isto não pode ser utilizado com as outras chaves de Versão.
Tipo:Object[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-RequireLicenseAcceptance

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

Tipo:SwitchParameter
Position:Named
Default value:False
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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) ou um ficheiro XML de definição de cmdlet (.cdxml). Quando o módulo é importado, os membros exportados 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 nenhum ficheiro for especificado na chave RootModule , o manifesto torna-se o ficheiro principal do módulo. O módulo é conhecido como um módulo de manifesto (ModuleType = Manifest).

Para exportar membros de .psm1 ou .dll ficheiros, os nomes desses ficheiros têm de ser especificados nos valores das chaves RootModule ou NestedModules no manifesto.

Tipo:String
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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 .

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Tags

Especifica uma matriz de etiquetas.

Tipo:String[]
Aliases:Tag
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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.

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais: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.

Tipo:String[]
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:True

Entradas

None

Saídas

Object

Notas

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