Update-PSModuleManifest
Actualiza un archivo de manifiesto de módulo.
Syntax
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 actualiza los datos almacenados en un archivo de manifiesto de módulo. Los parámetros permiten especificar qué propiedades se actualizan. Update-PSModuleManifest
sobrescribe los valores existentes en el manifiesto del módulo.
El cmdlet no devuelve un objeto .
Ejemplos
Ejemplo 1
En este ejemplo se cambia la propiedad Author del manifiesto del módulo a New Author
.
Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Author 'New Author'
Ejemplo 2
En este ejemplo se cambia la propiedad Versión preliminar a beta2
.
Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Prerelease 'beta2'
Ejemplo 3
En este ejemplo se actualizan varias propiedades.
$parameters = @{
Path = 'C:\MyModules\TestModule'
Tags = 'Windows', 'Linux'
Description = 'A module for managing packages.'
}
Update-PSModuleManifest
Parámetros
-AliasesToExport
Especifica los alias 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: | 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 requerida por el módulo.
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.
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 |
-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 requerida por el módulo.
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: | True |
-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 procesan 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.
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 se usa para distinguir entre 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:
.
Para obtener más información, consulte Ayuda actualizable.
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-IconUri
Especifica el URI 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 cada nombre de módulo como una cadena o como tabla hash con las claves ModuleName y ModuleVersion . La tabla hash también puede tener una clave GUID opcional. Puede combinar cadenas y tablas hash en el valor del parámetro.
Esta clave está diseñada para actuar como un inventario de módulo.
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 aparecen.
Escriba cada nombre de módulo como una cadena o como tabla hash con las claves ModuleName y ModuleVersion . La tabla hash también puede tener una clave GUID opcional. Puede combinar cadenas y tablas hash en el valor del parámetro.
Type: | Object[] |
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 filename con una .psd1
extensión de archivo.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
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.
El nombre de un programa host se almacena en $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 funciona con este módulo. Por ejemplo, puede especificar versiones como 5.1
o 7.2
.
Type: | Version |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Prerelease
Especifica el valor de versión preliminar que se anexa a la versión del módulo. Por ejemplo, si la versión preliminar es preview
y ModuleVersion es 1.0.0
, la versión del módulo es 1.0.0-preview
.
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. Puede ser cualquier valor arbitrario almacenado en una tabla hash.
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
None
(desconocido o no especificado)X86
Type: | ProcessorArchitecture |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ProjectUri
Especifica el URI 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 cadena que contiene notas de la versión o comentarios para el módulo.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RequiredAssemblies
Especifica los archivos de ensamblado (.dll
) necesarios para el módulo. PowerShell carga los ensamblados especificados antes de actualizar tipos o formatos, importar módulos anidados o importar el archivo de módulo especificado en la clave RootModule .
Use RequiredAssemblies para ensamblados que se deben cargar para actualizar cualquier formato o archivo de tipo que aparezca en las claves FormatsToProcess o TypesToProcess , incluso si esos ensamblados también aparecen 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.
El valor puede ser una matriz que contiene nombres de módulo o especificaciones de módulo. Una especificación de módulo es una tabla hash que tiene las siguientes claves.
ModuleName
- Obligatorio Especifica el nombre del módulo.GUID
- Opcional Especifica el GUID del módulo.- También es necesario especificar al menos una de las tres claves siguientes.
ModuleVersion
: especifica una versión mínima aceptable del módulo.MaximumVersion
: especifica la versión máxima aceptable del módulo.RequiredVersion
: especifica una versión exacta y necesaria del módulo. Esto no se puede usar con las otras claves de versión.
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: | False |
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 (.psd1
), un ensamblado (.dll
) o un archivo XML de definición de cmdlet (.cdxml
). Cuando se importa el módulo, los miembros exportados desde el módulo raíz se importan en el estado de sesión del autor de la llamada.
Si un módulo tiene un archivo de manifiesto y no se especifica ningún archivo en la clave RootModule , el manifiesto se convierte en el archivo principal del módulo. El módulo se conoce como módulo de manifiesto (ModuleType =
Manifest
).
Para exportar miembros de .psm1
o .dll
archivos, los nombres de esos archivos deben especificarse en los valores de las claves RootModule o NestedModules del manifiesto.
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[] |
Aliases: | Tag |
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.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | True |
Entradas
None
Salidas
Notas
Para obtener una descripción completa del archivo de manifiesto del módulo, consulte about_Module_Manifests.
Vínculos relacionados
Comentarios
https://aka.ms/ContentUserFeedback.
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea:Enviar y ver comentarios de