Cómo escribir un manifiesto de módulo de PowerShell

Una vez que haya escrito su módulo de PowerShell, puede agregar un manifiesto de módulo opcional que incluya información sobre el módulo. Por ejemplo, puede describir el autor, especificar archivos en el módulo (como módulos anidados), ejecutar scripts para personalizar el entorno del usuario, cargar archivos de tipo y formato, definir requisitos del sistema y limitar los miembros que exporta el módulo.

Creando un manifiesto de módulo

Un manifiesto de módulo es un archivo de datos de PowerShell (.psd1) que describe el contenido de un módulo y determina cómo se procesa un módulo. El archivo de manifiesto es un archivo de texto que contiene una tabla hash de claves y valores. Para vincular un archivo de manifiesto a un módulo, nombra el manifiesto del mismo modo que el módulo y almacena el manifiesto en el directorio raíz del módulo.

Para módulos simples que contienen solo un único .psm1 o ensamblado binario, un manifiesto de módulo es opcional. Sin embargo, la recomendación es utilizar un manifiesto de módulo siempre que sea posible, ya que son útiles para ayudarle a organizar su código y mantener la información de versiones. Además, se requiere un manifiesto de módulo para exportar un ensamblado que está instalado en la caché de ensamblados global. También se requiere un manifiesto de módulo para los módulos que admiten la función de Ayuda actualizable. La ayuda actualizable utiliza la clave HelpInfoUri en el manifiesto del módulo para buscar el archivo de información de ayuda (HelpInfo XML) que contiene la ubicación de los archivos de ayuda actualizados para el módulo. Para obtener más información sobre la Ayuda actualizable, consulte Soporte de ayuda actualizable.

Para crear y utilizar un manifiesto de módulo

1. La mejor práctica para crear un manifiesto de módulo es utilizar el cmdlet New-ModuleManifest. Puede utilizar parámetros para especificar una o más de las claves y valores predeterminados del manifiesto. El único requisito es nombrar el archivo. New-ModuleManifest crea un manifiesto de módulo con los valores especificados e incluye las claves restantes y sus valores predeterminados. Si necesita crear varios módulos, utilice New-ModuleManifest para crear una plantilla de manifiesto de módulo que pueda modificarse para sus diferentes módulos. Para ver un ejemplo de un manifiesto de módulo predeterminado, consulte el manifiesto de módulo de muestra.

   New-ModuleManifest -Path C:\myModuleName.psd1 -ModuleVersion "2.0" -Author "YourNameHere"

   Una alternativa es crear manualmente la tabla hash del manifiesto del módulo utilizando la información mínima requerida, la ModuleVersion. Guarda el archivo con el mismo nombre que su módulo y usa la extensión de archivo .psd1. Luego puede editar el archivo y agregar las claves y valores apropiados.

2. Agregue los elementos adicionales que desee en el archivo de manifiesto.

   Para editar el archivo de manifiesto, utilice cualquier editor de texto que prefiera. Sin embargo, el archivo de manifiesto es un archivo de secuencia de comandos que contiene código, por lo que es posible que desee editarlo en un entorno de secuencias de comandos o de desarrollo, como Visual Studio Code. Todos los elementos de un archivo de manifiesto son opcionales, excepto el número ModuleVersion.

   Para obtener descripciones de las claves y valores que puede incluir en un manifiesto de módulo, consulte la tabla de elementos del manifiesto de módulo. Para obtener más información, consulte las descripciones de los parámetros en el cmdlet New-ModuleManifest.

3. Para abordar cualquier escenario que pueda no estar cubierto por los elementos del manifiesto del módulo base, tiene la opción de agregar código adicional al manifiesto de su módulo.

   Por motivos de seguridad, PowerShell solo ejecuta un pequeño subconjunto de las operaciones disponibles en un archivo de manifiesto del módulo. Generalmente, puede utilizar la instrucción if, operadores aritméticos y de comparación, y los tipos de datos básicos de PowerShell.

4. Una vez que haya creado el manifiesto de su módulo, puede probarlo para confirmar que las rutas descritas en el manifiesto sean correctas. Para probar el manifiesto de su módulo, use Test-ModuleManifest.

   Test-ModuleManifest myModuleName.psd1

5. Asegúrese de que el manifiesto de su módulo esté ubicado en el nivel superior del directorio que contiene su módulo.

   Cuando copia su módulo en un sistema y lo importa, PowerShell usa el manifiesto del módulo para importar su módulo.

6. Opcionalmente, puede probar directamente el manifiesto de su módulo con una llamada a Import-Module obteniendo el manifiesto en sí.

   Import-Module .\myModuleName.psd1

Elementos del manifiesto del módulo

La siguiente tabla describe los elementos que puede incluir en un manifiesto de módulo.

Manifiesto del módulo de muestra

El siguiente manifiesto de módulo de muestra se creó con New-ModuleManifest en PowerShell 7 y contiene las claves y los valores predeterminados.

#
# Module manifest for module 'SampleModuleManifest'
#
# Generated by: User01
#
# Generated on: 10/15/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 = 'b632e90c-df3d-4340-9f6c-3b832646bf87'

# Author of this module
Author = 'User01'

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

# Copyright statement for this module
Copyright = '(c) User01. 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 = ''

}

Ver también

• about_Comparison_Operadores
• acerca de_si
• Caché de ensamblaje global
• Import-Module
• New-ModuleManifest
• Test-ModuleManifest
• Update-ModuleManifest
• Escribir un módulo de Windows PowerShell