Update-ModuleManifest

Referencia

Módulo:: PowerShellGet

Actualiza un archivo de manifiesto de módulo.

Syntax

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

El Update-ModuleManifest cmdlet actualiza un archivo de manifiesto de módulo (.psd1).

Se trata de un cmdlet de proxy para el Update-PSModuleManifest cmdlet en Microsoft.PowerShell.PSResourceGet. Para obtener más información, vea Update-PSModuleManifest.

Ejemplos

Ejemplo 1: Actualización de un manifiesto de módulo

En este ejemplo se actualiza un archivo de manifiesto de módulo existente. La expansión se usa para pasar valores de parámetro a Update-ModuleManifest. Para obtener más información, 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 es una plataforma que almacena los valores de parámetro para Path, Author, CompanyName y Copyright. Update-ModuleManifest obtiene los valores de parámetro de @Params y actualiza el manifiesto del módulo , TestManifest.psd1.

Parámetros

-AliasesToExport

Especifica los alias que exporta el módulo. Se permiten los caracteres comodín.

Use este parámetro para restringir los alias exportados por el módulo. AliasesToExport puede quitar alias de la lista de alias exportados, pero no puede agregar alias a la lista.

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

-Author

Especifica el autor del módulo.

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

-ClrVersion

Especifica la versión mínima de Common Language Runtime (CLR) de Microsoft .NET Framework que requiere el módulo.

Nota

Esta configuración solo es válida para la edición de PowerShell Desktop, como Windows PowerShell 5.1 y solo se aplica a las versiones de .NET Framework inferiores a la 4.5. Este requisito no tiene ningún efecto para las versiones más recientes de PowerShell o .NET Framework.

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

-CmdletsToExport

Especifica los cmdlets que exporta el módulo. Se permiten los caracteres comodín.

Use este parámetro para restringir los cmdlets exportados por el módulo. CmdletsToExport puede quitar cmdlets de la lista de cmdlets exportados, pero no puede agregar cmdlets a la lista.

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

-CompanyName

Especifica la empresa o proveedor que creó el módulo.

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

-CompatiblePSEditions

Especifica las PSEditions compatibles del módulo. Para obtener información sobre PSEdition, vea Módulos con ediciones de PowerShell compatibles.

Type:	String[]
Accepted values:	Desktop, Core
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Le pide confirmación antes de ejecutar Update-ModuleManifest.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Copyright

Especifica una instrucción de copyright para el módulo.

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

-DefaultCommandPrefix

Especifica el prefijo de comando predeterminado.

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

-Description

Especifica una descripción del módulo.

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

-DotNetFrameworkVersion

Especifica la versión mínima de Microsoft .NET Framework que requiere el módulo.

Nota

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

-DscResourcesToExport

Especifica los recursos de Desired State Configuration (DSC) que exporta el módulo. Se permiten los caracteres comodín.

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

-ExternalModuleDependencies

Especifica una matriz de dependencias de módulos externos.

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

-FileList

Especifica todos los elementos que se incluyen en el módulo.

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

-FormatsToProcess

Especifica los archivos de formato (.ps1xml) que se ejecutan cuando se importa el módulo.

Al importar un módulo, PowerShell ejecuta el Update-FormatData cmdlet con los archivos especificados. Dado que los archivos de formato no tienen ámbito, afectan a todos los estados de sesión de la sesión.

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

-FunctionsToExport

Especifica las funciones que exporta el módulo. Se permiten los caracteres comodín.

Use este parámetro para restringir las funciones exportadas por el módulo. FunctionsToExport puede quitar funciones de la lista de alias exportados, pero no puede agregar funciones a la lista.

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

-Guid

Especifica un identificador único para el módulo. El GUID puede utilizarse para distinguir módulos con el mismo nombre.

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

-HelpInfoUri

Especifica la dirección de Internet del archivo XML HelpInfo del módulo. Escriba un identificador uniforme de recursos (URI) que comience por http o https.

El archivo XML HelpInfo admite la característica ayuda actualizable que se introdujo en la versión 3.0 de PowerShell. Contiene información sobre la ubicación de los archivos de ayuda descargables del módulo y los números de versión de los archivos de ayuda más recientes para cada configuración regional compatible.

Para obtener información sobre la Ayuda actualizable, consulte about_Updatable_Help. Para obtener información sobre el archivo XML HelpInfo , vea Compatibilidad con la Ayuda actualizable.

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

-IconUri

Especifica la dirección URL de un icono para el módulo. El icono especificado se muestra en la página web de la galería del módulo.

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

-LicenseUri

Especifica la dirección URL de los términos de licencia para el módulo.

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

-ModuleList

Especifica una matriz de módulos que se incluyen en el módulo.

Escriba el nombre de cada módulo como una cadena o como una tabla hash con claves ModuleName y ModuleVersion. La tabla hash también puede tener una clave GUID opcional. Puede combinar las cadenas y las tablas hash en el valor del parámetro.

Esta clave está diseñada para actuar como un inventario de módulo. Los módulos que aparecen en el valor de esta clave no se procesan automáticamente.

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

-ModuleVersion

Especifica la versión del módulo.

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

-NestedModules

Especifica los módulos de script (.psm1) y los módulos binarios (.dll) que se importan en el estado de sesión del módulo. Los archivos de la clave NestedModules se ejecutan en el orden en que se muestran en el valor .

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

-PackageManagementProviders

Especifica una matriz de proveedores de administración de paquetes.

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

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, Update-ModuleManifest no genera ninguna salida.

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

-Path

Especifica la ruta de acceso y el nombre de archivo del manifiesto del módulo. Escriba una ruta de acceso y un nombre de archivo con una .psd1 extensión de nombre de archivo, como $PSHOME\Modules\MyModule\MyModule.psd1.

Si especifica la ruta de acceso a un archivo existente, Update-ModuleManifest reemplaza el archivo sin advertencia a menos que el archivo tenga el atributo de solo lectura.

El manifiesto debe encontrarse en el directorio del módulo y el nombre del archivo de manifiesto debe ser el mismo que el nombre del directorio del módulo, pero con una .psd1 extensión.

No se pueden usar variables, como $PSHOME o $HOME, en respuesta a una solicitud de un valor de parámetro Path . Para utilizar una variable, incluya el parámetro Path en el comando.

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

-PowerShellHostName

Especifica el nombre del programa host de PowerShell que requiere el módulo. Escriba el nombre del programa host, como Host de ISE de PowerShell o ConsoleHost. No se permiten caracteres comodín.

Para buscar el nombre de un programa host, en el programa, escriba $Host.Name.

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

-PowerShellHostVersion

Especifica la versión mínima del programa host de PowerShell que funciona con el módulo. Escriba un número de versión, como la 1.1.

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

-PowerShellVersion

Especifica la versión mínima de PowerShell que funcionará con este módulo. Por ejemplo, puede especificar 3.0, 4.0 o 5.0 como valor de este parámetro.

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

-Prerelease

Indica que el módulo está en versión preliminar.

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

-PrivateData

Especifica los datos que se pasan al módulo cuando se importan.

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

-ProcessorArchitecture

Especifica la arquitectura de procesador que requiere el módulo.

Los valores permitidos para este parámetro son los siguientes:

Amd64
Arm
IA64
MSIL
Ninguno (desconocido o no especificado)
X86

Type:	ProcessorArchitecture
Accepted values:	None, MSIL, X86, IA64, Amd64, Arm
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProjectUri

Especifica la dirección URL de una página web sobre este proyecto.

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

-ReleaseNotes

Especifica una matriz de cadenas que contiene notas de la versión o comentarios que desea que esté disponible para esta versión del script.

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

-RequiredAssemblies

Especifica los archivos de ensamblado (.dll) que requiere el módulo. Escriba los nombres de los archivos de ensamblado. PowerShell carga los ensamblados especificados antes de actualizar tipos o formatos, importar módulos anidados o importar el archivo de módulo especificado en el valor de la clave RootModule .

Use este parámetro para especificar todos los ensamblados que requiere el módulo, incluidos los ensamblados que se deben cargar para actualizar los archivos de formato o tipo que se enumeran en las claves FormatsToProcess o TypesToProcess , incluso si esos ensamblados también se enumeran como módulos binarios en la clave NestedModules .

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

-RequiredModules

Especifica los módulos que deben estar en el estado de sesión global. Si los módulos necesarios no están en el estado de sesión global, PowerShell los importa. Si los módulos necesarios no están disponibles, se produce un error en el Import-Module comando.

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

-RequireLicenseAcceptance

Especifica que se requiere una aceptación de licencia para el módulo.

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

-RootModule

Especifica el archivo principal o raíz del módulo. Escriba el nombre de archivo de un script (.ps1), un módulo de script (.psm1), un manifiesto de módulo (), un ensamblado (.psd1), un archivo XML de definición de cmdlet (.dll.cdxml) o un flujo de trabajo (.xaml). Cuando se importa el módulo, los miembros que se exportan desde el archivo de módulo raíz se importan en el estado de sesión del llamador.

Si un módulo tiene un archivo de manifiesto y no se ha especificado ningún archivo raíz en la clave RootModule , el manifiesto se convierte en el archivo principal del módulo. Además, el módulo se convierte en un módulo de manifiesto (ModuleType = Manifest).

Para exportar miembros de o .dll archivos de .psm1 un módulo que tenga un manifiesto, los nombres de esos archivos deben especificarse en los valores de las claves RootModule o NestedModules del manifiesto. De lo contrario, sus miembros no se exportan.

En PowerShell 2.0, esta clave se llamó ModuleToProcess.

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

-ScriptsToProcess

Especifica los archivos de script (.ps1) que se ejecutan en el estado de sesión del autor de la llamada cuando se importa el módulo. Puede usar estos scripts para preparar un entorno, igual que podría utilizar un script de inicio de sesión.

Para especificar los scripts que se ejecutan en el estado de sesión del módulo, utilice la clave NestedModules.

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

-Tags

Especifica una matriz de etiquetas.

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

-TypesToProcess

Especifica los archivos de tipo (.ps1xml) que se ejecutan cuando se importa el módulo.

Al importar el módulo, PowerShell ejecuta el Update-TypeData cmdlet con los archivos especificados. Dado que los archivos de tipo no tienen ámbito, afectan a todos los estados de sesión de la sesión.

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

-VariablesToExport

Especifica las variables que exporta el módulo. Se permiten los caracteres comodín.

Use este parámetro para restringir las variables exportadas por el módulo. VariablesToExport puede quitar variables de la lista de variables exportadas, pero no puede agregar variables a la lista.

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

-WhatIf

Muestra lo que sucedería si Update-ModuleManifest se ejecutase. El cmdlet no se ejecuta.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Entradas

String

Salidas

Object

Compartir a través de