Partager via


Update-PSModuleManifest

Met à jour un fichier manifeste de module.

Syntaxe

Default (Par défaut)

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é préversion 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 que le module exporte. Les caractères génériques sont autorisés.

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:True
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Author

Spécifie l’auteur du module.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ClrVersion

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

Propriétés des paramètres

Type:Version
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CmdletsToExport

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

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:True
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CompanyName

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

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CompatiblePSEditions

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

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Valeurs acceptées:Desktop, Core
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

Spécifie une instruction de copyright pour le module.

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DefaultCommandPrefix

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

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Description

Spécifie une description du module.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DotNetFrameworkVersion

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

Propriétés des paramètres

Type:Version
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-DscResourcesToExport

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

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:True
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ExternalModuleDependencies

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

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-FileList

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

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-FormatsToProcess

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

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.

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-FunctionsToExport

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

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:True
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Guid

Spécifie un identificateur unique pour le module. L'GUID est utilisé pour faire la distinction entre les modules portant le même nom.

Propriétés des paramètres

Type:Guid
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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:.

Pour plus d’informations, consultez 'aide pouvant être mise à jour.

Propriétés des paramètres

Type:Uri
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés des paramètres

Type:Uri
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-LicenseUri

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

Propriétés des paramètres

Type:Uri
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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 ModuleName et clés 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.

Propriétés des paramètres

Type:

Object[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ModuleVersion

Spécifie la version du module.

Propriétés des paramètres

Type:Version
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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 l'NestedModules clé s’exécutent dans l’ordre dans lequel elles sont répertoriées.

Entrez chaque nom de module sous forme de chaîne ou de table de hachage avec ModuleName et clés 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.

Propriétés des paramètres

Type:

Object[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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 extension de fichier .psd1.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Le nom d’un programme hôte est stocké dans $Host.Name.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés des paramètres

Type:Version
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés des paramètres

Type:Version
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Prerelease

Spécifie la valeur de préversion ajoutée à la version du module. Par exemple, si préversion est preview et que le ModuleVersion est 1.0.0, la version du module est 1.0.0-preview.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-PrivateData

Spécifie les données transmises au module lorsqu’elles sont importées. Il peut s’agir de toutes les valeurs arbitraires stockées dans une table de hachage.

Propriétés des paramètres

Type:Hashtable
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ProcessorArchitecture

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

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

  • Amd64
  • Arm
  • IA64
  • MSIL
  • None (inconnu ou non spécifié)
  • X86

Propriétés des paramètres

Type:ProcessorArchitecture
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ProjectUri

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

Propriétés des paramètres

Type:Uri
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ReleaseNotes

Spécifie une chaîne qui contient des notes de publication ou des commentaires pour le module.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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 pour mettre à jour les fichiers de mise en forme ou de type répertoriés dans les FormatsToProcess ou clés TypesToProcess, même si ces assemblys sont également répertoriés dans la clé NestedModules.

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

La valeur peut être un tableau contenant des noms de module ou des spécifications de module. Une spécification de module est une table de hachage qui a les clés suivantes.

  • ModuleName - Obligatoire Spécifie le nom du module.
  • GUID - facultatif spécifie le GUID du module.
  • Il est également obligatoire pour 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 requise du module. Cela ne peut pas être utilisé avec les autres clés de version.

Propriétés des paramètres

Type:

Object[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-RequireLicenseAcceptance

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

Propriétés des paramètres

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-RootModule

Spécifie le fichier principal ou racine du module. Entrez le nom de fichier d’un script (.ps1), un module de script (.psm1), un manifeste de module (.psd1), un assembly (.dll) ou 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 ou de fichiers .dll, les noms de ces fichiers doivent être spécifiés dans les valeurs des RootModule ou clés imbriquéesModules dans le manifeste.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Tags

Spécifie un tableau de balises.

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Tag

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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.

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:True
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

None

Sorties

Object

Notes

Pour obtenir une description complète du fichier manifeste du module, consultez about_Module_Manifests.