L’applet de commande Publish-Module publie un module dans une galerie NuGet en ligne à l’aide d’une clé API, stockée dans le cadre du profil d’un utilisateur dans la galerie. Vous pouvez spécifier le module à publier par le nom du module ou par le chemin d’accès au dossier contenant le module.
Lorsque vous spécifiez un module par nom, Publish-Module publie le premier module trouvé en exécutant Get-Module -ListAvailable <Name>. Si vous spécifiez une version minimale d’un module à publier, Publish-Module publie le premier module avec une version supérieure ou égale à la version minimale que vous avez spécifiée.
La publication d’un module nécessite des métadonnées affichées sur la page de la galerie pour le module. Les métadonnées requises incluent le nom du module, la version, la description et l’auteur. Bien que la plupart des métadonnées soient extraites du manifeste du module, certaines métadonnées doivent être spécifiées dans Publish-Module des paramètres, tels que Tag, ReleaseNote, IconUri, ProjectUri et LicenseUri, car ces paramètres correspondent aux champs d’une galerie NuGet.
Exemples
Exemple 1 : Publier un module
Dans cet exemple, MyDscModule est publié dans la galerie en ligne à l’aide de la clé API pour indiquer le compte de galerie en ligne du propriétaire du module. Si MyDscModule n’est pas un module manifeste valide qui spécifie un nom, une version, une description et un auteur, une erreur se produit.
Exemple 2 : Publier un module avec des métadonnées de galerie
Dans cet exemple, MyDscModule est publié dans la galerie en ligne à l’aide de la clé API pour indiquer le compte de galerie du propriétaire du module. Les métadonnées supplémentaires fournies sont affichées sur la page web du module dans la galerie. Le propriétaire ajoute deux balises de recherche pour le module, en l’associant à Active Directory ; une brève note de publication est ajoutée. Si MyDscModule n’est pas un module manifeste valide qui spécifie un nom, une version, une description et un auteur, une erreur se produit.
Publish-Module -Name "MyDscModule" -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73" -LicenseUri "http://contoso.com/license" -Tag "Active Directory","DSC" -ReleaseNote "Updated the ActiveDirectory DSC Resources to support adding users."
Paramètres
-AllowPrerelease
Permet aux modules marqués comme préversions d’être publiés.
Spécifie la clé API que vous souhaitez utiliser pour publier un module dans la galerie en ligne. La clé API fait partie de votre profil dans la galerie en ligne et se trouve sur la page de votre compte d’utilisateur dans la galerie. La clé API est une fonctionnalité spécifique à NuGet.
Spécifie une chaîne contenant des notes de publication ou des commentaires que vous souhaitez mettre à la disposition des utilisateurs de cette version du module.
Spécifie le nom convivial d’un référentiel qui a été inscrit en exécutant Register-PSRepository. Le référentiel doit avoir un PublishLocation, qui est un URI NuGet valide.
Le PublishLocation peut être défini en exécutant Set-PSRepository.
Ajoute une ou plusieurs balises au module que vous publiez. Les exemples de balises incluent DesiredStateConfiguration, DSC, DSCResourceKit ou PSModule. Séparez plusieurs balises par des virgules.
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.
Publish-Module s’exécute sur PowerShell 3.0 ou versions ultérieures de PowerShell, sur Windows 7 ou Windows 2008 R2 et versions ultérieures de Windows.
Important
Depuis avril 2020, PowerShell Gallery ne prend plus en charge les versions TLS (Transport Layer Security) 1.0 et 1.1. Si vous n’utilisez pas TLS 1.2 ou version ultérieure, vous recevez une erreur lors de la tentative d’accès à PowerShell Gallery. Utilisez la commande suivante pour vous assurer que vous utilisez TLS 1.2 :
Pour plus d’informations, consultez l’annonce dans le blog PowerShell.
La publication d’un module nécessite des métadonnées affichées sur la page de la galerie pour le module. Les métadonnées requises incluent le nom du module, la version, la description et l’auteur. La plupart des métadonnées sont extraites du manifeste du module, mais certaines métadonnées peuvent être spécifiées dans des paramètres Publish-Module, tels que tag, ReleaseNote, IconUri, ProjectUriet LicenseUri. Pour plus d’informations, consultez Valeurs du manifeste de package qui ont un impact sur l’interface utilisateur de PowerShell Gallery.