New-ModuleManifest

Sintaxe

New-ModuleManifest
   [-Path] <String>
   [-NestedModules <Object[]>]
   [-Guid <Guid>]
   [-Author <String>]
   [-CompanyName <String>]
   [-Copyright <String>]
   [-RootModule <String>]
   [-ModuleVersion <Version>]
   [-Description <String>]
   [-ProcessorArchitecture <ProcessorArchitecture>]
   [-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[]>]
   [-CompatiblePSEditions <String[]>]
   [-PrivateData <Object>]
   [-Tags <String[]>]
   [-ProjectUri <Uri>]
   [-LicenseUri <Uri>]
   [-IconUri <Uri>]
   [-ReleaseNotes <String>]
   [-Prerelease <String>]
   [-RequireLicenseAcceptance]
   [-ExternalModuleDependencies <String[]>]
   [-HelpInfoUri <String>]
   [-PassThru]
   [-DefaultCommandPrefix <String>]
   [-WhatIf]
   [-Confirm] 
   [<CommonParameters>]

Description

O New-ModuleManifest cmdlet cria um novo arquivo de manifesto do módulo (.psd1), preenche seus valores e salva o arquivo de manifesto no caminho especificado.

Os autores do módulo podem usar esse cmdlet para criar um manifesto para o módulo. Um manifesto de módulo é um ficheiro .psd1 que contém uma tabela hash. As chaves e os valores na tabela hash descrevem o conteúdo e atributos do módulo, definem os pré-requisitos e determinam como os componentes são processados. Os manifestos não são necessários para um módulo.

New-ModuleManifest Cria um manifesto que inclui todas as chaves de manifesto comumente usadas, para que você possa usar a saída padrão como um modelo de manifesto. Para adicionar ou alterar valores, ou para adicionar chaves de módulo que este cmdlet não adiciona, abra o arquivo resultante em um editor de texto.

Cada parâmetro, exceto Path e PassThru, cria uma chave de manifesto do módulo e seu valor. Em um manifesto de módulo, somente a chave ModuleVersion é necessária. A menos que especificado na descrição do parâmetro, se você omitir um parâmetro do comando, New-ModuleManifest criará uma cadeia de caracteres de comentário para o valor associado que não terá efeito.

No PowerShell 2.0, New-ModuleManifest solicita os valores dos parâmetros comumente usados que não são especificados no comando, além dos valores de parâmetro necessários. A partir do PowerShell 3.0, New-ModuleManifest solicita somente quando os valores de parâmetro necessários não são especificados.

Se você estiver planejando publicar seu módulo na Galeria do PowerShell, o manifesto deverá conter valores para determinadas propriedades. Para obter mais informações, consulte Metadados necessários para itens publicados na Galeria do PowerShell na documentação da Galeria.

Exemplos

Exemplo 1 - Criar um novo manifesto de módulo

Este exemplo cria um novo manifesto de módulo no arquivo especificado pelo parâmetro Path . O parâmetro PassThru envia a saída para o pipeline e para o arquivo.

A saída mostra os valores padrão de todas as chaves no manifesto.

New-ModuleManifest -Path C:\ps-test\Test-Module\Test-Module.psd1 -PassThru

#
# Module manifest for module 'Test-Module'
#
# Generated by: ContosoAdmin
#
# Generated on: 7/12/2019
#

@{

# Script module or binary module file associated with this manifest.
# RootModule = ''

# Version number of this module.
ModuleVersion = '0.0.1'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = 'e1826c6e-c420-4eef-9ac8-185e3669ca6a'

# Author of this module
Author = 'ContosoAdmin'

# Company or vendor of this module
CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) ContosoAdmin. All rights reserved.'

# Description of the functionality provided by this module
# Description = ''

# Minimum version of the PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @()

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        # Tags = @()

        # A URL to the license for this module.
        # LicenseUri = ''

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        # ReleaseNotes = ''

        # Prerelease string of this module
        # Prerelease = ''

        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

Exemplo 2 - Criar um novo manifesto com algumas configurações pré-preenchidas

Este exemplo cria um novo manifesto de módulo. Ele usa os parâmetros PowerShellVersion e AliasesToExport para adicionar valores às chaves de manifesto correspondentes.

$moduleSettings = @{
    PowerShellVersion = 1.0
    Path   = 'C:\ps-test\ManifestTest.psd1'
    AliasesToExport   = @(
      'JKBC'
      'DRC'
      'TAC'
    )
}
New-ModuleManifest @moduleSettings

Exemplo 3 - Criar um manifesto que requer outros módulos

Este exemplo utiliza um formato de cadeia para especificar o nome do módulo BitsTransfer e o formato da tabela hash para especificar o nome, um GUID e uma versão do módulo PSScheduledJob.

$moduleSettings = @{
  RequiredModules = ("BitsTransfer", @{
    ModuleName="PSScheduledJob"
    ModuleVersion="1.0.0.0";
    GUID="50cdb55f-5ab7-489f-9e94-4ec21ff51e59"
  })
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

Este exemplo mostra como utilizar os formatos de cadeia e tabela hash dos parâmetros ModuleList, RequiredModules e NestedModules. Pode combinar cadeias e tabelas hash no mesmo valor do parâmetro.

Exemplo 4 - Criar um manifesto que suporte ajuda atualizável

Este exemplo usa o parâmetro HelpInfoUri para criar uma chave HelpInfoUri no manifesto do módulo. O valor do parâmetro e da chave deve começar com http ou https. Esse valor informa ao sistema de Ajuda atualizável onde encontrar o arquivo de informações de ajuda atualizável XML HelpInfo para o módulo.

$moduleSettings = @{
  HelpInfoUri = 'http://https://go.microsoft.com/fwlink/?LinkID=603'
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

Para obter informações sobre a Ajuda atualizável, consulte about_Updatable_Help. Para obter informações sobre o arquivo XML HelpInfo, consulte Supporting Updatable Help.

Exemplo 5 - Obter informações do módulo

Este exemplo mostra como obter os valores de configuração de um módulo. Os valores no manifesto do módulo são refletidos nos valores das propriedades do objeto do módulo.

O Get-Module cmdlet é usado para obter o módulo Microsoft.PowerShell.Diagnostics usando o parâmetro List . O comando envia o módulo para o Format-List cmdlet para exibir todas as propriedades e valores do objeto module.

Get-Module Microsoft.PowerShell.Diagnostics -List | Format-List -Property *

LogPipelineExecutionDetails : False
Name                        : Microsoft.PowerShell.Diagnostics
Path                        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics\Micro
                              soft.PowerShell.Diagnostics.psd1
Definition                  :
Description                 :
Guid                        : ca046f10-ca64-4740-8ff9-2565dba61a4f
HelpInfoUri                 : https://go.microsoft.com/fwlink/?LinkID=210596
ModuleBase                  : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics
PrivateData                 :
Version                     : 3.0.0.0
ModuleType                  : Manifest
Author                      : Microsoft Corporation
AccessMode                  : ReadWrite
ClrVersion                  : 4.0
CompanyName                 : Microsoft Corporation
Copyright                   : Microsoft Corporation. All rights reserved.
DotNetFrameworkVersion      :
ExportedFunctions           : {}
ExportedCmdlets             : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
ExportedCommands            : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
FileList                    : {}
ModuleList                  : {}
NestedModules               : {}
PowerShellHostName          :
PowerShellHostVersion       :
PowerShellVersion           : 3.0
ProcessorArchitecture       : None
Scripts                     : {}
RequiredAssemblies          : {}
RequiredModules             : {}
RootModule                  :
ExportedVariables           : {}
ExportedAliases             : {}
ExportedWorkflows           : {}
SessionState                :
OnRemove                    :
ExportedFormatFiles         : {C:\Windows\system32\WindowsPowerShell\v1.0\Event.format.ps1xml,
                              C:\Windows\system32\WindowsPowerShell\v1.0\Diagnostics.format.ps1xml}
ExportedTypeFiles           : {C:\Windows\system32\WindowsPowerShell\v1.0\GetEvent.types.ps1xml}

Parâmetros

-AliasesToExport

-Author

-ClrVersion

-CmdletsToExport

-CompanyName

-CompatiblePSEditions

-Confirm

-Copyright

-DefaultCommandPrefix

-Description

-DotNetFrameworkVersion

-DscResourcesToExport

-ExternalModuleDependencies

-FileList

-FormatsToProcess

-FunctionsToExport

-Guid

-HelpInfoUri

-IconUri

-LicenseUri

-ModuleList

-ModuleVersion

-NestedModules

-PassThru

-Path

-PowerShellHostName

-PowerShellHostVersion

-PowerShellVersion

-Prerelease

-PrivateData

-ProcessorArchitecture

-ProjectUri

-ReleaseNotes

-RequiredAssemblies

-RequiredModules

-RequireLicenseAcceptance

-RootModule

-ScriptsToProcess

-Tags

-TypesToProcess

-VariablesToExport

-WhatIf

Entradas

None

Não é possível canalizar objetos para este cmdlet.

Saídas

None

Por padrão, esse cmdlet não retorna nenhuma saída.

String

Quando você usa o parâmetro PassThru , esse cmdlet retorna uma cadeia de caracteres que representa o manifesto do módulo.

Notas

New-ModuleManifestem execução em plataformas Windows e não-Windows cria arquivos de manifesto do módulo (.psd1) codificados como UTF8NoBOM.

Os manifestos do módulo são geralmente opcionais. No entanto, um manifesto de módulo é necessário para exportar um assembly que está instalado no cache de assembly global.

Para adicionar ou alterar arquivos no diretório, inicie o $pshome\Modules PowerShell com a opção Executar como administrador .

No PowerShell 2.0, muitos parâmetros de eram obrigatórios, mesmo que não fossem exigidos em um manifesto de New-ModuleManifest módulo. A partir do PowerShell 3.0, apenas o parâmetro Path é obrigatório.

Uma sessão é uma instância do ambiente de execução do PowerShell. Uma sessão pode ter um ou mais estados de sessão. Por padrão, uma sessão tem apenas um estado de sessão global, mas cada módulo importado tem seu próprio estado de sessão. Os estados de sessão permitem que os comandos em um módulo sejam executados sem afetar o estado da sessão global.

O estado da sessão do chamador é o estado da sessão para o qual um módulo é importado. Normalmente, refere-se ao estado da sessão global, mas quando um módulo importa módulos aninhados, o chamador é o módulo e o estado da sessão do chamador é o estado da sessão do módulo.

Ligações Relacionadas

• Export-ModuleMember
• Get-Module
• Import-Module
• New-Module
• Remove-Module
• Test-ModuleManifest
• about_Modules