Update-ModuleManifest

Référence

Module:: PowerShellGet

Met à jour un fichier manifeste de module.

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

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

Il s’agit d’une applet de commande de 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. L’platissement est utilisé pour passer des valeurs de paramètre à Update-ModuleManifest. Pour plus d’informations, consultez 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 est une plateforme qui stocke les valeurs de paramètre pour Path, Author, CompanyName et Copyright. Update-ModuleManifest obtient les valeurs de paramètre à partir de @Params et met à jour le manifeste du module, TestManifest.psd1.

Paramètres

-AliasesToExport

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

Utilisez ce paramètre pour restreindre les alias qui sont 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
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Author

Spécifie l'auteur du module.

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

-ClrVersion

Spécifie la version minimale du Common Language Runtime (CLR) de Microsoft .NET Framework dont le module a besoin.

Notes

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

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

-CmdletsToExport

Spécifie les applets de commande exportées par le module. 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 il ne peut pas ajouter d’applets de commande à la liste.

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

-CompanyName

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

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

-CompatiblePSEditions

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

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

-Confirm

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

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

-Copyright

Spécifie une déclaration de copyright pour le module.

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

-DefaultCommandPrefix

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

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

-Description

Spécifie une description du module.

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

-DotNetFrameworkVersion

Spécifie la version minimale de Microsoft .NET Framework dont le module a besoin.

Notes

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

-DscResourcesToExport

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

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

-ExternalModuleDependencies

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

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

-FileList

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

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

-FormatsToProcess

Spécifie les fichiers de mise en forme (.ps1xml) qui s’exécutent lors de l’importation du module.

Lorsque vous importez un module, PowerShell exécute l’applet de Update-FormatData commande 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 session de la session.

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

-FunctionsToExport

Spécifie les fonctions exportées par le module. 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 il ne peut pas ajouter de fonctions à la liste.

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

-Guid

Spécifie un identificateur unique pour le module. Le GUID peut servir à distinguer les modules portant le même nom.

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

-HelpInfoUri

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

Le fichier XML HelpInfo prend en charge la fonctionnalité d’aide pouvant être mise à jour 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 l’aide pouvant être mise à jour, 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
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LicenseUri

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

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

-ModuleList

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

Entrez le nom de chaque module sous la forme d'une chaîne ou d'une 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 agir en tant qu'inventaire de module. Les modules répertoriés dans la valeur de cette clé ne sont pas traités automatiquement.

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

-ModuleVersion

Spécifie la version du module.

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

-NestedModules

Spécifie les modules de script (.psm1) et les modules binaires (.dll) qui sont 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.

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

-PackageManagementProviders

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

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

-PassThru

Renvoie 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
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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 .psd1 extension de nom de fichier, 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 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 des 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
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PowerShellHostName

Spécifie le nom du programme hôte PowerShell requis par le module. Entrez le nom du programme hôte, par exemple 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
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PowerShellHostVersion

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

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Prerelease

Indique que le module est une préversion.

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

-PrivateData

Spécifie les données passées au module lors de son importation.

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

-ProcessorArchitecture

Spécifie l'architecture de processeur dont le module a besoin.

Les valeurs valides pour ce paramètre sont :

Amd64
Arm
IA64
MSIL
Aucun (inconnu ou non spécifié)
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

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

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequiredAssemblies

Spécifie les fichiers d’assembly (.dll) requis par le module. Entrez les noms de 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é 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 tous 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
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequiredModules

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

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

-RequireLicenseAcceptance

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

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

-RootModule

Spécifie le fichier principal ou racine du module. Entrez le nom de fichier d’un script (.ps1), d’un module de script (.psm1), d’un manifeste de module (.psd1), d’un assembly (.dll), d’un fichier XML de définition d’applet de commande (.cdxml) ou d’un workflow (.xaml). Quand 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. De plus, le module devient un module manifeste (ModuleType = Manifeste).

Pour exporter des membres à partir de ou .dll des .psm1 fichiers d’un module qui a 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é était appelée ModuleToProcess.

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

-ScriptsToProcess

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

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

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

-Tags

Spécifie un tableau de balises.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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 Update-TypeData commande 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
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VariablesToExport

Spécifie les variables exportées par le module. 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 il ne peut pas ajouter de variables à la liste.

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

-WhatIf

Affiche ce qui se produirait en cas Update-ModuleManifest d’exécution. L’applet de commande n’est pas exécutée.

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

Entrées

String

Sorties

Object

Partager via