Update-PSModuleManifest
Met à jour un fichier manifeste de module.
Syntaxe
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
Cette applet de commande met à jour les données stockées dans un fichier manifeste de module. Les paramètres vous permettent de spécifier les propriétés mises à jour.
Update-PSModuleManifest
Remplace toutes les valeurs existantes dans le manifeste du module.
L’applet de commande ne retourne pas d’objet.
Exemples
Exemple 1
Cet exemple montre comment modifier la propriété Author dans le manifeste du module en New Author
.
Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Author 'New Author'
Exemple 2
Cet exemple montre comment modifier la propriété Prerelease en beta2
.
Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Prerelease 'beta2'
Exemple 3
Cet exemple met à jour plusieurs propriétés.
$parameters = @{
Path = 'C:\MyModules\TestModule'
Tags = 'Windows', 'Linux'
Description = 'A module for managing packages.'
}
Update-PSModuleManifest
Paramètres
-AliasesToExport
Spécifie les alias exportés par le module. 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: | 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.
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 exportées par le module. 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: | 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 les PSEditions compatibles 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 |
-Copyright
Spécifie une déclaration 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.
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 Desired State Configuration (DSC) 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: | True |
-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 qui sont 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 sont traités lorsque le module est importé.
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 |
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 exportées par le module. 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: | True |
-Guid
Spécifie un identificateur unique pour le module. Le GUID est utilisé pour faire la distinction entre les modules portant le 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) qui commence http:
par ou https:
.
Pour plus d’informations, consultez 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’URI 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 agir en tant qu'inventaire de module.
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
) 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.
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 |
-Path
Spécifie le chemin d’accès et le nom de fichier du manifeste du module. Entrez le nom de fichier avec une .psd1
extension de fichier.
Type: | String |
Position: | 0 |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
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 PowerShell ISE Host ou ConsoleHost. Les caractères génériques ne sont pas autorisés.
Le nom d’un programme hôte est stocké dans $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, par exemple 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 fonctionne avec ce module. Par exemple, vous pouvez spécifier des versions telles que 5.1
ou 7.2
.
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
Spécifie la valeur de la préversion ajoutée à la version du module. Par exemple, si la prérelease est preview
et que ModuleVersion est 1.0.0
, la version du module est 1.0.0-preview
.
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 lors de son importation. Il peut s’agir de valeurs arbitraires stockées dans une table de hachage.
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 de processeur dont le module a besoin.
Les valeurs valides pour ce paramètre sont :
Amd64
Arm
IA64
MSIL
-
None
(inconnu ou non spécifié) X86
Type: | ProcessorArchitecture |
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’URI d’une page web concernant 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 une chaîne qui contient des notes de publication ou des commentaires 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 |
-RequiredAssemblies
Spécifie les fichiers d’assembly (.dll
) requis par le module. 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 clé RootModule .
Utilisez RequiredAssemblies pour les assemblys qui doivent être chargés afin de 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 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 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.
La valeur peut être un tableau contenant des noms de modules ou des spécifications de module. Une spécification de module est une table de hachage qui possède les clés suivantes.
-
ModuleName
- Obligatoire Spécifie le nom du module. -
GUID
- Optionnel Spécifie le GUID du module. - Il est également nécessaire de spécifier au moins l’une des trois clés ci-dessous.
-
ModuleVersion
- Spécifie une version minimale acceptable du module. -
MaximumVersion
- Spécifie la version maximale acceptable du module. -
RequiredVersion
- Spécifie une version exacte et obligatoire du module. Il ne peut pas être utilisé avec les autres clés de version.
-
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: | False |
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 (.ps1
), d’un module de script (.psm1
), d’un manifeste de module (.psd1
), d’un assembly (.dll
) ou d’un fichier XML de définition d’applet de commande (.cdxml
). Lorsque le module est importé, les membres exportés à partir du module racine sont importés dans l’état de session de l’appelant.
Si un module a un fichier manifeste et qu’aucun fichier n’est spécifié dans la clé RootModule , le manifeste devient le fichier principal du module. Le module est appelé module manifeste (ModuleType =
Manifest
).
Pour exporter des membres à partir de .psm1
fichiers ou .dll
, les noms de ces fichiers doivent être spécifiés dans les valeurs des clés RootModule ou NestedModules du manifeste.
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 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 |
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[] |
Alias: | Tag |
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 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 |
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 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.
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 |
Entrées
None
Sorties
Notes
Pour obtenir une description complète du fichier manifeste du module, consultez about_Module_Manifests.