Update-ModuleManifest
Atualiza um arquivo de manifesto do módulo.
Sintaxe
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. A splatting é usada 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 e atualiza o manifesto do @Params 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.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | True |
-Author
Especifica o autor do módulo.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-ClrVersion
Especifica a versão mínima do CLR (Common Language Runtime) do Microsoft .NET Framework exigido pelo módulo.
Observação
Essa configuração é válida somente para a edição do PowerShell Desktop, como o Windows PowerShell 5.1, e se aplica apenas a versões do .NET Framework inferiores à 4.5. Esse requisito não tem efeito para versões mais recentes do PowerShell ou do .NET Framework.
| Tipo: | Version |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | True |
-CompanyName
Especifica a empresa ou o fornecedor que criou o módulo.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-CompatiblePSEditions
Especifica as PSEditions compatíveis do módulo. Para obter informações sobre PSEdition, consulte Módulos com edições compatíveis do PowerShell.
| Tipo: | String[] |
| Valores aceitos: | Desktop, Core |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Confirm
Solicita confirmação antes de executar Update-ModuleManifest.
| Tipo: | SwitchParameter |
| Aliases: | cf |
| Cargo: | Named |
| Valor padrão: | False |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Copyright
Especifica uma declaração de direitos autorais para o módulo.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-DefaultCommandPrefix
Especifica o prefixo de comando padrão.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Description
Especifica uma descrição do módulo.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-DotNetFrameworkVersion
Especifica a versão mínima do Microsoft .NET Framework necessária para o módulo.
Observação
Essa configuração é válida somente para a edição do PowerShell Desktop, como o Windows PowerShell 5.1, e se aplica apenas a versões do .NET Framework inferiores à 4.5. Esse requisito não tem efeito para versões mais recentes do PowerShell ou do .NET Framework.
| Tipo: | Version |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-DscResourcesToExport
Especifica os recursos de DSC (Configuração de Estado Desejado) exportados pelo módulo. Caracteres curinga são permitidos.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-ExternalModuleDependencies
Especifica uma matriz de dependências de módulo externo.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-FileList
Especifica todos os itens incluídos no módulo.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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 cmdlet Update-FormatData com os arquivos especificados.
Como os arquivos de formatação não estão no escopo, eles afetam todos os estados de sessão na sessão.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | True |
-Guid
Especifica um identificador exclusivo para o módulo. O GUID pode ser usado para distinguir entre módulos com o mesmo nome.
| Tipo: | Guid |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-HelpInfoUri
Especifica o endereço da Internet do arquivo XML HelpInfo do módulo. Insira um URI (Uniform Resource Identifier) que começa com http ou https.
O arquivo XML HelpInfo dá suporte ao recurso de 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.
| Tipo: | Uri |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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.
| Tipo: | Uri |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-LicenseUri
Especifica a URL dos termos de licenciamento do módulo.
| Tipo: | Uri |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-ModuleList
Especifica uma matriz de módulos que estão incluídos no módulo.
Insira cada nome de módulo como uma cadeia de caracteres ou como uma tabela de hash com 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.
| Tipo: | Object[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-ModuleVersion
Especifica a versão do módulo.
| Tipo: | Version |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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.
Insira cada nome de módulo como uma cadeia de caracteres ou como uma tabela de hash com 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.
| Tipo: | Object[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-PackageManagementProviders
Especifica uma matriz de provedores de gerenciamento de pacotes.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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 extensão de nome de arquivo .psd1, 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 caminho no comando.
| Tipo: | String |
| Cargo: | 0 |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-PowerShellHostName
Especifica o nome do programa host do PowerShell exigido pelo módulo. Insira o nome do programa host, como o Host ISE do PowerShell ou o ConsoleHost. Não são permitidos caracteres.
Para localizar o nome de um programa host, no programa, digite $Host.Name.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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.
| Tipo: | Version |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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.
| Tipo: | Version |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Prerelease
Indica que o módulo é pré-lançamento.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-PrivateData
Especifica os dados que são passados para o módulo quando são importados.
| Tipo: | Hashtable |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-ProcessorArchitecture
Especifica a arquitetura do processador necessária para o módulo.
Os valores aceitáveis para este parâmetro são:
- Amd64
- Braço
- IA64
- MSIL
- Nenhum (desconhecido ou não especificado)
- X86
| Tipo: | ProcessorArchitecture |
| Valores aceitos: | None, MSIL, X86, IA64, Amd64, Arm |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-ProjectUri
Especifica a URL de uma página da Web sobre este projeto.
| Tipo: | Uri |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-ReleaseNotes
Especifica uma matriz de cadeia de caracteres que contém notas de versão ou comentários que você deseja que estejam disponíveis para esta versão do script.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-RequiredAssemblies
Especifica os arquivos de assembly (.dll) necessários para o módulo. Insira os nomes dos arquivos de montagem.
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 sejam listados como módulos binários na chave NestedModules .
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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 comando Import-Module falhará.
| Tipo: | Object[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-RequireLicenseAcceptance
Especifica que uma aceitação de licença é necessária para o módulo.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-RootModule
Especifica o arquivo primário ou raiz do módulo. Insira o nome do arquivo de um script (.ps1), um módulo de script (.psm1), um manifesto de 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 = Manifesto).
Para exportar os membros de arquivos .psm1 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 foi chamada ModuleToProcess.
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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 executados no estado de sessão do módulo, use a chave NestedModules.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Tags
Especifica um array de tags.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | 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 cmdlet Update-TypeData com os arquivos especificados.
Como os arquivos de tipo não estão no escopo, eles afetam todos os estados de sessão na sessão.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-VariablesToExport
Especifica as variáveis exportadas pelo módulo. 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.
| Tipo: | String[] |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | True |
-WhatIf
Mostra o que aconteceria se Update-ModuleManifest fosse executado. O cmdlet não é executado.
| Tipo: | SwitchParameter |
| Aliases: | wi |
| Cargo: | Named |
| Valor padrão: | False |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
