Manifestwaarden verpakken die van invloed zijn op PowerShell Gallery gebruikersinterface

  • Artikel
  • 8 minuten om te lezen

Dit onderwerp biedt uitgevers overzichtsinformatie over het wijzigen van het manifest voor hun PowerShell Gallery-publicaties, zodat de functies van PowerShellGet-cmdlets en de PowerShell Gallery-gebruikersinterface worden beïnvloed. Deze inhoud is ingedeeld op basis van de plaats waar de wijziging wordt weergegeven, te beginnen met de middelste sectie en vervolgens het navigatiegebied aan de linkerkant. Er is een detailsectie over tags, die belangrijke tags identificeren, evenals enkele van de meest gebruikte tags. Er zijn twee onderwerpen met manifestvoorbeelden:

In de onderstaande tabel ziet u de elementen van de PowerShell Gallery de gebruikersinterface van de pakketpagina die worden beheerd door de uitgever. Elk item geeft aan of het kan worden beheerd door de module of het scriptmanifest.

Ui-element Beschrijving Module Script
Titel Dit is de naam van het pakket dat is gepubliceerd naar de galerie Nee Nee
Versie De versie die wordt weergegeven, is de versiereeks in de metagegevens en een voorlopige versie als is opgegeven. Het primaire gedeelte van de versie in een Modulemanifest is moduleversie. Voor een script wordt dit geïdentificeerd als . VERSIE. Als een voorlopige versiereeks is opgegeven, wordt deze toegevoegd aan de ModuleVersion voor modules of opgegeven als onderdeel van . VERSIE voor scripts. Er is documentatie voor het opgeven van voorlopige tekenreeksen in modulesen in scripts Ja Ja
Beschrijving Dit is de Beschrijving in het modulemanifest en in een scriptbestandsmanifest is dit . BESCHRIJVING Ja Ja
Acceptatie van licentie vereisen Een module kan vereisen dat de gebruiker een licentie accepteert door het modulemanifest te wijzigen met RequireLicenseAcceptance = $true, een LicenseURI op te geven en een license.txt-bestand op te geven in de hoofdmap van de modulemap. Meer informatie is beschikbaar in het onderwerp Acceptatie van licentie vereisen. Ja Nee
Releaseopmerkingen Voor modules wordt deze informatie uit de sectie ReleaseNotes onder PSData\PrivateData getrokken. In scriptmanifests is dit de . Het element RELEASENOTES. Ja Ja
Eigenaren Eigenaren zijn de lijst met gebruikers in de PowerShell Gallery die een pakket kunnen bijwerken. De lijst met eigenaren is niet opgenomen in het pakketmanifest. In aanvullende documentatie wordt beschreven hoe u itemeigenaren beheert. Nee Nee
Auteur Dit is opgenomen in het modulemanifest als auteur en in een scriptmanifest als . AUTEUR. Het veld Auteur wordt vaak gebruikt om een bedrijf of organisatie op te geven die aan een pakket is gekoppeld. Ja Ja
Copyright Dit is het veld Copyright in het modulemanifest en . COPYRIGHT in een scriptmanifest. Ja Ja
Bestandenoverzicht De lijst met bestanden wordt uit het pakket getrokken wanneer deze naar de PowerShell Gallery. Het kan niet worden bestuurd door de manifestinformatie. Opmerking: er wordt een aanvullend .nuspec-bestand vermeld met elk pakket in de PowerShell Gallery dat niet aanwezig is na de installatie van het pakket op een systeem. Dit is het Nuget-pakketmanifest voor het pakket en kan worden genegeerd. Nee Nee
Tags Voor modules zijn tags opgenomen onder PSData\PrivateData. Voor scripts wordt de sectie gelabeld. TAGS. Tags mogen geen spaties bevatten, zelfs niet wanneer ze tussen aanhalingstekens staan. Tags hebben aanvullende vereisten en betekenis, die later in dit onderwerp worden beschreven in de sectie Tagdetails. Ja Ja
Cmdlets Dit is beschikbaar in het modulemanifest met behulp van CmdletsToExport. Houd er rekening mee dat best practice is om de items expliciet weer te geven in plaats van het jokerteken '*' te gebruiken, omdat hierdoor de prestaties van de load-module voor gebruikers worden verbeterd. Ja Nee
Functies Dit is beschikbaar in het modulemanifest met behulp van FunctionsToExport. Houd er rekening mee dat best practice is om de items expliciet weer te geven in plaats van het jokerteken '*' te gebruiken, omdat hierdoor de prestaties van de load-module voor gebruikers worden verbeterd. Ja Nee
DSC-resources Voor modules die worden gebruikt in PowerShell versie 5.0 en hoger, wordt dit opgegeven in het manifest met behulp van DscResourcesToExport. Als de module moet worden gebruikt in PowerShell 4, mag de DSCResourcesToExport niet worden gebruikt, omdat het geen ondersteunde manifestsleutel is. (DSC was niet beschikbaar vóór PowerShell 4.) Ja Nee
Werkstromen Werkstromen worden als scripts PowerShell Gallery gepubliceerd naar de PowerShell Gallery en geïdentificeerd als werkstromen (zie Verbinding maken-AzureVM voor een voorbeeld) in de code. Dit wordt niet beheerd door het manifest. Nee Nee
Rolmogelijkheden Dit wordt weergegeven wanneer de module die is gepubliceerd naar de PowerShell Gallery een of meer .psrc-bestanden (role capability) bevat die worden gebruikt door JEA. Zie de JEA-documentatie voor meer informatie over rolmogelijkheden. Ja Nee
PowerShell-edities Dit wordt opgegeven in een script of modulemanifest. Voor modules die zijn ontworpen voor gebruik met PowerShell 5.0 en lager, wordt dit beheerd met tags. Gebruik voor Desktop de tag PSEdition_Desktop en gebruik voor de kern de tag PSEdition_Core. Voor modules die alleen worden gebruikt in PowerShell 5.1 en hoger, is er een sleutel CompatiblePSEditions in het hoofdmanifest. Bekijk de functie PS Edition in de PowerShell Get-documentatie voor meer informatie. Ja Ja
Afhankelijkheden Afhankelijkheden zijn de modules in de PowerShell Gallery die in de module zijn gedeclareerd als RequiredModules of in het scriptmanifest als #Requires –Module (naam). Ja Ja
Minimale PowerShell-versie Dit kan in een modulemanifest worden opgegeven als PowerShellVersion Ja Nee
Versiegeschiedenis De versiegeschiedenis weerspiegelt de updates die zijn aangebracht aan een module in de PowerShell Gallery. Als een versie van een pakket wordt verborgen met behulp van de functie Verwijderen, wordt deze niet weergegeven in de versiegeschiedenis, met uitzondering van de pakketeigenaren. Nee Nee
Project Site De projectsite is beschikbaar voor modules in de sectie Privatedata\PSData van het modulemanifest door een ProjectURI op te geven. In het scriptmanifest wordt dit beheerd door op te geven. PROJECTURI. Ja Ja
Licentie Er is een licentiekoppeling beschikbaar voor modules in de sectie Privatedata\PSData van het modulemanifest door een LicenseURI op te geven. In het scriptmanifest wordt dit beheerd door op te geven. LICENSEURI. Het is belangrijk te weten dat als een licentie niet wordt geleverd via de LicenseURI of binnen een module, de gebruiksvoorwaarden voor de PowerShell Gallery de gebruiksvoorwaarden voor het pakket specificeren. Zie de gebruiksvoorwaarden voor meer informatie. Ja Ja
Pictogram Een pictogram kan worden opgegeven voor elk pakket in de PowerShell Gallery door de vlag IconURI op te voeren in het scriptmanifest of in de sectie Privatedata-PSData van het modulemanifest. De IconURI moet wijzen op een 85x85-afbeelding met transparantieachtergrond. De URI moet een directe afbeeldings-URL zijn en mag niet naar een webpagina met de afbeelding of een bestand in het PowerShell Gallery gaan. Ja Ja

Pakketdetails bewerken

Op PowerShell Gallery pagina Pakket bewerken kunnen uitgevers verschillende velden wijzigen die voor een pakket worden weergegeven, met name:

  • Titel
  • Beschrijving
  • Samenvatting
  • Pictogram-URL
  • Project-URL van de startpagina
  • Auteurs
  • Copyright
  • Tags
  • Opmerkingen bij de release
  • Licentie vereisen

Deze aanpak wordt doorgaans niet aanbevolen, behalve wanneer dit nodig is om te corrigeren wat er wordt weergegeven voor een oudere versie van een module. Gebruikers die de module verkrijgen, zien dat de metagegevens niet overeenkomen met wat wordt weergegeven in de PowerShell Gallery, wat zorgen doet over het pakket. Dit leidt er vaak toe dat de eigenaren van het pakket vragen krijgen om de wijziging te bevestigen. Het wordt ten zeerste aangeraden om op elk moment dat deze benadering wordt gebruikt, een nieuwe versie van het pakket te publiceren met dezelfde wijzigingen.

Tagdetails

Tags zijn eenvoudige tekenreeksen die consumenten gebruiken om pakketten te vinden. Tags zijn het nuttigst wanneer ze consistent worden gebruikt in veel pakketten die betrekking hebben op hetzelfde onderwerp. Het gebruik van meerdere varianten van hetzelfde woord (bijvoorbeeld database en databases, of testen en testen) biedt doorgaans weinig voordelen. Tags zijn tekenreeksen die niet van één woord zijn en mogen geen lege tekst bevatten. Als er een zin is waar gebruikers naar zullen zoeken, voegt u deze toe aan de pakketbeschrijving en vindt u deze in de zoekresultaten. Gebruik het casing-, afbreekstreepings-, onderstrepingsteken of punt als u de leesbaarheid wilt verbeteren. Wees voorzichtig met het maken van lange, complexe en ongebruikelijke tags, omdat ze vaak verkeerd zijn gespeld.

Er zijn tags die belangrijk zijn, omdat de cmdlets PowerShell Gallery en PowerShellGet ze uniek behandelen. PSEdition_Desktop en PSEdition_Core zijn de specifieke voorbeelden en worden hierboven beschreven.

Zoals hierboven vermeld, bieden tags de meeste waarde wanneer ze specifiek zijn en consistent worden gebruikt in veel pakketten. Als uitgever die probeert de beste tags te vinden om te gebruiken, is de eenvoudigste manier om in de PowerShell Gallery te zoeken naar tags die u overweegt. In het ideale moment worden er veel pakketten geretourneerd en worden de pakketbeschrijvingen afgestemd op uw gebruik van dat sleutelwoord.

Hier zijn enkele veelgebruikte tags vanaf 14-12-2017. In sommige gevallen zijn er vergelijkbare, maar mogelijk minder ideale opties naast de tag. Het is een best practice voorkeurstag te gebruiken, omdat dit leidt tot minder ruis en betere zoekresultaten voor consumenten.

Voorkeurstag Alternatieven en opmerkingen
Azure
DSC DesiredStateConfiguration is minder wenselijk, het is te lang
ResourceManager Arm wordt gebruikt om een groep processors te beschrijven en mag niet worden gebruikt voor Azure Resource Manager
DSCResourceKit
SQL
AWS
DSCResource
Automation
REST
Active Directory AD wordt momenteel niet zelf gebruikt
Sqlserver
DBA
Beveiliging Verdediging is minder nauwkeurig
Database Databases (meervoud) zijn minder wenselijk
DevOps
Windows
Ontwikkelen
Implementatie Implementeren wordt iets minder vaak gebruikt
Cloud
GIT
Testen Testen is minder wenselijk
Versioncontrol Versie is minder nauwkeurig, hoewel vaker wordt gebruikt
Logboekregistratie Voorkeursgebruik van logboekregistratie als actie
Logboek Voorkeursgebruik van Log as a Thing
Backup
IaaS
Linux
IIS
AzureAutomation
Storage
GitHub
Json
Exchange
Netwerk Netwerken zijn vergelijkbaar, minder vaak gebruikt
SharePoint
Rapportage Rapportage is een actie, een rapport is een ding
Rapport Rapport is een ding
WinRM
Bewaking
VSTS
Excel
Google
Kleur
DNS
Office365 Spelling van Office is beter. O365 wordt minder vaak gebruikt, maar is korter
Gitlab
Pester
AzureAD
HTML
Hyper-V HyperV komt minder vaak voor als een tag
Configuratie
ChatOps
PackageManagement
WMI
Firewall
Docker
Appveyor
AzureRm Voornamelijk gebruikt voor de AzureRM-modules
Zip
MSI
MacOS
PoshBot