Partager via

Update-ModuleManifest

  • Référence
Module:
PowerShellGet

Met à jour un fichier manifeste de module.

Syntaxe

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

L’applet Update-ModuleManifest de commande met à jour un fichier manifeste de module (.psd1).

Il s’agit d’une applet de commande proxy pour l’applet Update-PSModuleManifest de commande dans Microsoft.PowerShell.PSResourceGet. Pour plus d’informations, consultez Update-PSModuleManifest.

Exemples

Exemple 1 : Mettre à jour un manifeste de module

Cet exemple met à jour un fichier manifeste de module existant. La mise en forme est utilisée pour passer des valeurs de paramètre à Update-ModuleManifest. Pour plus d'informations, consultez À propos de la projection.

$Params = @{
  Path = "C:\Test\TestManifest.psd1"
  Author = "TestUser1"
  CompanyName = "Contoso Corporation"
  Copyright = "(c) 2019 Contoso Corporation. All rights reserved."
}

Update-ModuleManifest @Params

$Params est une plaque qui stocke les valeurs des paramètres pour Path, Author, CompanyName et Copyright. Update-ModuleManifest obtient les valeurs des paramètres à partir et @Params met à jour le manifeste du module , TestManifest.psd1.

Paramètres

-AliasesToExport

Spécifie les alias que le module exporte. Les caractères génériques sont autorisés.

Utilisez ce paramètre pour restreindre les alias exportés par le module. AliasesToExport peut supprimer des alias de la liste des alias exportés, mais il ne peut pas ajouter d’alias à la liste.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:True

-Author

Spécifie l’auteur du module.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ClrVersion

Spécifie la version minimale du Common Language Runtime (CLR) du Microsoft .NET Framework requis par le module.

Remarque

Ce paramètre est valide pour l’édition PowerShell Desktop uniquement, comme Windows PowerShell 5.1, et s’applique uniquement aux versions de .NET Framework inférieures à 4.5. Cette exigence n’a aucun effet sur les versions plus récentes de PowerShell ou de .NET Framework.

Type:Version
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CmdletsToExport

Spécifie les applets de commande que le module exporte. Les caractères génériques sont autorisés.

Utilisez ce paramètre pour restreindre les applets de commande exportées par le module. CmdletsToExport peut supprimer des applets de commande de la liste des applets de commande exportées, mais elle ne peut pas ajouter d’applets de commande à la liste.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:True

-CompanyName

Spécifie l’entreprise ou le fournisseur qui a créé le module.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CompatiblePSEditions

Spécifie la compatible psEditions du module. Pour plus d’informations sur PSEdition, consultez Modules avec des éditions PowerShell compatibles.

Type:String[]
Valeurs acceptées:Desktop, Core
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Confirm

Vous invite à confirmer avant d’exécuter Update-ModuleManifest.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Copyright

Spécifie une instruction de copyright pour le module.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultCommandPrefix

Spécifie le préfixe de commande par défaut.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Description

Spécifie une description du module.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DotNetFrameworkVersion

Spécifie la version minimale de Microsoft .NET Framework requise par le module.

Remarque

Ce paramètre est valide pour l’édition PowerShell Desktop uniquement, comme Windows PowerShell 5.1, et s’applique uniquement aux versions de .NET Framework inférieures à 4.5. Cette exigence n’a aucun effet sur les versions plus récentes de PowerShell ou de .NET Framework.

Type:Version
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DscResourcesToExport

Spécifie les ressources DSC (Desired State Configuration) que le module exporte. Les caractères génériques sont autorisés.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ExternalModuleDependencies

Spécifie un tableau de dépendances de module externe.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-FileList

Spécifie tous les éléments inclus dans le module.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-FormatsToProcess

Spécifie les fichiers de mise en forme (.ps1xml) qui s’exécutent lorsque le module est importé.

Lorsque vous importez un module, PowerShell exécute l’applet de commande Update-FormatData avec les fichiers spécifiés. Étant donné que les fichiers de mise en forme ne sont pas délimités, ils affectent tous les états de la session.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-FunctionsToExport

Spécifie les fonctions que le module exporte. Les caractères génériques sont autorisés.

Utilisez ce paramètre pour restreindre les fonctions exportées par le module. FunctionsToExport peut supprimer des fonctions de la liste des alias exportés, mais elle ne peut pas ajouter de fonctions à la liste.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:True

-Guid

Spécifie un identificateur unique pour le module. Le GUID peut être utilisé pour distinguer les modules du même nom.

Type:Guid
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-HelpInfoUri

Spécifie l’adresse Internet du fichier XML HelpInfo du module. Entrez un URI (Uniform Resource Identifier) commençant par http ou https.

Le fichier XML HelpInfo prend en charge la fonctionnalité d’aide pouvant être mise à jour qui a été introduite dans PowerShell version 3.0. Il contient des informations sur l’emplacement des fichiers d’aide téléchargeables du module et les numéros de version des fichiers d’aide les plus récents pour chaque paramètre régional pris en charge.

Pour plus d’informations sur Updatable Help, consultez about_Updatable_Help. Pour plus d’informations sur le fichier XML HelpInfo , consultez Prise en charge de l’aide pouvant être mise à jour.

Type:Uri
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-IconUri

Spécifie l’URL d’une icône pour le module. L’icône spécifiée s’affiche sur la page web de la galerie pour le module.

Type:Uri
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-LicenseUri

Spécifie l’URL des termes de licence pour le module.

Type:Uri
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ModuleList

Spécifie un tableau de modules inclus dans le module.

Entrez chaque nom de module sous forme de chaîne ou de table de hachage avec les clés ModuleName et ModuleVersion. La table de hachage peut également avoir une clé GUID facultative. Vous pouvez combiner des chaînes et des tables de hachage dans la valeur du paramètre.

Cette clé est conçue pour servir d’inventaire de module. Les modules répertoriés dans la valeur de cette clé ne sont pas traités automatiquement.

Type:Object[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ModuleVersion

Spécifie la version du module.

Type:Version
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-NestedModules

Spécifie les modules de script (.psm1) et les modules binaires (.dll) importés dans l’état de session du module. Les fichiers de la clé NestedModules s’exécutent dans l’ordre dans lequel ils sont répertoriés dans la valeur.

Entrez chaque nom de module sous forme de chaîne ou de table de hachage avec les clés ModuleName et ModuleVersion. La table de hachage peut également avoir une clé GUID facultative. Vous pouvez combiner des chaînes et des tables de hachage dans la valeur du paramètre.

Type:Object[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PackageManagementProviders

Spécifie un tableau de fournisseurs de gestion de package.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PassThru

Retourne un objet représentant l’élément avec lequel vous travaillez. Par défaut, Update-ModuleManifest ne génère aucune sortie.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Path

Spécifie le chemin d’accès et le nom de fichier du manifeste du module. Entrez un chemin d’accès et un nom de fichier avec une extension de nom de fichier .psd1, par exemple $PSHOME\Modules\MyModule\MyModule.psd1.

Si vous spécifiez le chemin d’accès à un fichier existant, Update-ModuleManifest remplace le fichier sans avertissement, sauf si le fichier a l’attribut en lecture seule.

Le manifeste doit se trouver dans le répertoire du module, et le nom du fichier manifeste doit être identique au nom du répertoire du module, mais avec une .psd1 extension.

Vous ne pouvez pas utiliser de variables, telles que $PSHOME ou $HOME, en réponse à une invite pour une valeur de paramètre Path . Pour utiliser une variable, incluez le paramètre path dans la commande.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-PowerShellHostName

Spécifie le nom du programme hôte PowerShell requis par le module. Entrez le nom du programme hôte, tel que l’hôte PowerShell ISE ou ConsoleHost. Les caractères génériques ne sont pas autorisés.

Pour trouver le nom d’un programme hôte, dans le programme, tapez $Host.Name.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PowerShellHostVersion

Spécifie la version minimale du programme hôte PowerShell qui fonctionne avec le module. Entrez un numéro de version, tel que 1.1.

Type:Version
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PowerShellVersion

Spécifie la version minimale de PowerShell qui fonctionnera avec ce module. Par exemple, vous pouvez spécifier 3.0, 4.0 ou 5.0 comme valeur de ce paramètre.

Type:Version
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Prerelease

Indique que le module est préversion.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PrivateData

Spécifie les données transmises au module lorsqu’elles sont importées.

Type:Hashtable
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ProcessorArchitecture

Spécifie l’architecture du processeur requise par le module.

Les valeurs acceptables pour ce paramètre sont les suivantes :

  • Amd64
  • Bras
  • IA64
  • MSIL
  • Aucun (inconnu ou non spécifié)
  • X86
Type:ProcessorArchitecture
Valeurs acceptées:None, MSIL, X86, IA64, Amd64, Arm
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ProjectUri

Spécifie l’URL d’une page web sur ce projet.

Type:Uri
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ReleaseNotes

Spécifie un tableau de chaînes qui contient des notes de publication ou des commentaires que vous souhaitez mettre à disposition pour cette version du script.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RequiredAssemblies

Spécifie les fichiers d’assembly (.dll) requis par le module. Entrez les noms des fichiers d’assembly. PowerShell charge les assemblys spécifiés avant de mettre à jour des types ou des formats, d’importer des modules imbriqués ou d’importer le fichier de module spécifié dans la valeur de la clé de RootModule.

Utilisez ce paramètre pour spécifier tous les assemblys requis par le module, y compris les assemblys qui doivent être chargés pour mettre à jour les fichiers de mise en forme ou de type répertoriés dans les clés FormatsToProcess ou TypesToProcess , même si ces assemblys sont également répertoriés en tant que modules binaires dans la clé NestedModules .

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RequiredModules

Spécifie les modules qui doivent être dans l’état de session globale. Si les modules requis ne sont pas dans l’état de session global, PowerShell les importe. Si les modules requis ne sont pas disponibles, la commande Import-Module échoue.

Type:Object[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RequireLicenseAcceptance

Spécifie qu’une acceptation de licence est requise pour le module.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RootModule

Spécifie le fichier principal ou racine du module. Entrez le nom de fichier d’un script (), un module de.ps1 script (.psm1), un manifeste de module (.psd1), un assembly (.dll), un fichier XML de définition d’applet de commande (.cdxml) ou un workflow (.xaml). Lorsque le module est importé, les membres exportés à partir du fichier de module racine sont importés dans l’état de session de l’appelant.

Si un module a un fichier manifeste et qu’aucun fichier racine n’a été spécifié dans la clé RootModule , le manifeste devient le fichier principal du module. Et, le module devient un module manifeste (ModuleType = Manifeste).

Pour exporter les membres des fichiers .psm1 ou .dll dans un module doté d’un manifeste, les noms de ces fichiers doivent être spécifiés dans les valeurs des clés RootModule ou NestedModules dans le manifeste. Sinon, leurs membres ne sont pas exportés.

Dans PowerShell 2.0, cette clé a été appelée ModuleToProcess.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ScriptsToProcess

Spécifie les fichiers de script (.ps1) qui s’exécutent dans l’état de session de l’appelant lorsque le module est importé. Vous pouvez utiliser ces scripts pour préparer un environnement, tout comme vous pouvez utiliser un script de connexion.

Pour spécifier des scripts qui s’exécutent dans l’état de session du module, utilisez la clé NestedModules.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Tags

Spécifie un tableau de balises.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-TypesToProcess

Spécifie les fichiers de type (.ps1xml) qui s’exécutent lorsque le module est importé.

Lorsque vous importez le module, PowerShell exécute l’applet de commande Update-TypeData avec les fichiers spécifiés. Étant donné que les fichiers de type ne sont pas délimités, ils affectent tous les états de session de la session.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-VariablesToExport

Spécifie les variables que le module exporte. Les caractères génériques sont autorisés.

Utilisez ce paramètre pour restreindre les variables exportées par le module. VariablesToExport peut supprimer des variables de la liste des variables exportées, mais elle ne peut pas ajouter de variables à la liste.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:True

-WhatIf

Montre ce qui se passerait si Update-ModuleManifest s’exécute. L’applet de commande n’est pas exécutée.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

String

Sorties

Object