Metagegevenswaarden verpakken die van invloed zijn op de gebruikersinterface van PowerShell Gallery

In dit artikel wordt uitgelegd hoe de metagegevens in uw pakketten worden gebruikt door de PowerShell-galerie. Voor modules wordt de metagegevens opgeslagen in het modulemanifest. Voor scripts worden de metagegevens opgeslagen met behulp van trefwoorden op basis van opmerkingen. De volgende cmdlets worden gebruikt om deze metagegevens te maken of bij te werken:

• New-ModuleManifest-
• Update-ModuleManifest-
• Nieuw-ScriptFileInfo
• Update-ScriptFileInfo

PowerShell Gallery bevat elementen die worden beheerd door het modulemanifest

In de volgende lijst ziet u de elementen van de gebruikersinterface van de PowerShell Gallery-pakketpagina die worden beheerd door het modulemanifest.

• Titel : de naam van het pakket dat in de galerie is gepubliceerd.

• Versie : de weergegeven versie is de versietekenreeks in de metagegevens en een prerelease-label als dit is opgegeven. De opgegeven prerelease-tekenreeks wordt toegevoegd aan de ModuleVersion. Zie Prerelease-moduleversies voor informatie over prerelease-tekenreeksen in modules.

• Beschrijving - Dit is de beschrijving in het modulemanifest.

• Licentieacceptatie vereisen - Een module kan vereisen dat de gebruiker een licentie accepteert door een LicenseURI in te stellen RequireLicenseAcceptance = $trueen een license.txt bestand in de hoofdmap van de modulemap op te geven. Zie Licentieacceptatie vereisen voor meer informatie.

• Release notes - Deze informatie is afkomstig uit de sectie Releasenotes , onder PSData\PrivateData.

• Eigenaren : eigenaren zijn de lijst met gebruikers in de PowerShell-galerie die een pakket kunnen bijwerken. De lijst met eigenaren is niet opgenomen in het pakketmanifest. In aanvullende documentatie wordt beschreven hoe u artikeleigenaren kunt beheren.

• Auteur - Dit is opgenomen in het modulemanifest als de auteur. Het veld Auteur wordt vaak gebruikt om een bedrijf of organisatie op te geven die aan een pakket is gekoppeld.

• Copyright - Dit is het veld Copyright in het modulemanifest.

• FileList : de bestandslijst wordt gemaakt wanneer het pakket wordt gepubliceerd naar de PowerShell-galerie. Het is niet controleerbaar door de manifeste informatie. De PowerShell-galerie maakt .nuspec een bestand dat wordt weergegeven in de bestandenlijst van elk pakket. Dit bestand is niet met het pakket op een systeem geïnstalleerd. Dit is het NuGet-pakketmanifest voor het pakket en kan worden genegeerd.

• Tags - Tags zijn opgenomen onder PrivateData\PSData in het modulemanifest. Tags hebben specifieke vereisten en betekenissen die worden beschreven in de sectie Tagdetails .

• Cmdlets : dit wordt verstrekt in het modulemanifest met behulp van CmdletsToExport. Het is een goede gewoonte om de namen van de cmdlets expliciet weer te geven in plaats van het jokerteken *te gebruiken. Het hebben van een lijst verbetert de prestaties van de belastingsmodule.

• Functies : dit wordt verstrekt in het modulemanifest met behulp van FunctionsToExport. Het is een goede gewoonte om de namen van de cmdlets expliciet weer te geven in plaats van het jokerteken *te gebruiken. Het hebben van een lijst verbetert de prestaties van de belastingsmodule.

• DSC-bronnen : dit wordt verstrekt in het manifest met behulp van DscResourcesToExport. Deze waarde wordt alleen ondersteund voor modules in PowerShell 5.0 en hoger.

• Rolmogelijkheden : rollen worden weergegeven wanneer de module een of meer rolmogelijkheden (.psrc) bestanden heeft. Deze bestanden worden gebruikt door JEA. Zie Rolmogelijkheden voor meer informatie.

• PowerShell-edities : voor modules die zijn ontworpen voor PowerShell 5.0 en lager, wordt dit beheerd met behulp van tags. Gebruik voor desktop de tag PSEdition_Desktop en voor de kern de tag PSEdition_Core. Voor modules die zijn ontworpen voor PowerShell 5.1 en hoger, is er een CompatiblePSEditions-sleutel in het manifest. Zie PSEdition-ondersteuning voor modules voor meer informatie.

• Afhankelijkheden: dit wordt verstrekt in het manifest met behulp van RequiredModules.

• Minimale PowerShell-versie : dit wordt verstrekt in het manifest met behulp van PowerShellVersion.

• Versiegeschiedenis - Toont een lijst met versies van de module die zijn gepubliceerd naar de Galerij. Pakketten die zijn verborgen met de functie Verwijderen , worden niet weergegeven in de versiegeschiedenis, tenzij u de eigenaar van een pakket bent.

• Projectsite : de projectsite wordt verstrekt voor modules in de PrivateData\PSData sectie van het modulemanifest door een ProjectURI op te geven.

• Licentie - Er wordt een licentiekoppeling verstrekt voor modules in de PrivateData\PSData sectie van het modulemanifest door een LicenseURI op te geven.

  Belangrijk

  Als er geen licentie wordt verstrekt via de LicenseURI of in het pakket, zijn de gebruiksvoorwaarden voor de PowerShell-galerie van toepassing op het pakket. Zie de gebruiksvoorwaarden voor meer informatie.

• Pictogram : er wordt een koppeling gegeven voor modules in de PrivateData\PSData sectie van het modulemanifest door een IconURI op te geven. De URI moet verwijzen naar een afbeelding van 85x85 met een transparante achtergrond. De URI moet een directe koppeling zijn naar het afbeeldingsbestand en mag niet naar een webpagina of een bestand in het PowerShell Gallery-pakket gaan.

PowerShell Gallery-elementen bevatten die worden beheerd door de metagegevens van het script

In de volgende lijst ziet u de elementen van de gebruikersinterface van de PowerShell Gallery-pakketpagina die worden beheerd door de metagegevens op basis van opmerkingen in een scriptbestand.

• Titel - Dit is de naam van het pakket dat in de galerij wordt gepubliceerd

• Versie : de weergegeven versie is de versietekenreeks in de metagegevens en een prerelease-label als dit is opgegeven. De waarde komt van het .VERSION trefwoord in het opmerkingenblok voor metagegevens. Wanneer u een prerelease-script publiceert, voegt u de prerelease-tekenreeks toe aan de versie. Zie Prerelease-versies van scripts voor informatie over het opgeven van Prerelease-tekenreeksen in modules.

• Beschrijving - Deze informatie is afkomstig van het .DESCRIPTION trefwoord in de op opmerkingen gebaseerde Help van een scriptbestand.

• Licentieacceptatie vereisen : licentieacceptatie wordt niet ondersteund voor scripts. Het scenario waarin een script afhankelijk is van een module waarvoor licentieacceptatie is vereist, wordt echter ondersteund. Zie Licentieacceptatie voor scripts vereisen voor meer informatie.

• Release-opmerkingen : deze informatie is afkomstig van het .RELEASENOTES trefwoord in de op opmerkingen gebaseerde metadata van een scriptbestand.

• Eigenaren : eigenaren zijn de lijst met gebruikers in de PowerShell-galerie die een pakket kunnen bijwerken. De lijst met eigenaren is niet opgenomen in het pakketmanifest. Zie Itemeigenaren beheren voor meer informatie.

• Auteur - Deze informatie is afkomstig van het .AUTHOR trefwoord in de op opmerkingen gebaseerde metadata van een scriptbestand. Het veld Auteur wordt vaak gebruikt om een bedrijf of organisatie op te geven die aan een pakket is gekoppeld.

• Copyright - Deze informatie is afkomstig van het .COPYRIGHT trefwoord in de op commentaar gebaseerde metadata van een scriptbestand.

• FileList : de bestandslijst wordt gemaakt wanneer het pakket wordt gepubliceerd naar de PowerShell-galerie. Het is niet controleerbaar door de manifeste informatie. De PowerShell-galerie maakt .nuspec een bestand dat wordt weergegeven in de bestandenlijst van elk pakket. Dit bestand is niet met het pakket op een systeem geïnstalleerd. Dit is het NuGet-pakketmanifest voor het pakket en kan worden genegeerd.

• Tags - *Deze informatie komt van het .TAGS trefwoord in de op opmerkingen gebaseerde metadata van een scriptbestand. Tags hebben specifieke vereisten en betekenissen die worden beschreven in de sectie Tagdetails .

• PowerShell-edities : voor modules die zijn ontworpen voor PowerShell 5.0 en lager, wordt dit beheerd met behulp van tags. Gebruik voor desktop de tag PSEdition_Desktop en voor de kern de tag PSEdition_Core. Voor modules die zijn ontworpen voor PowerShell 5.1 en hoger, is er een CompatiblePSEditions-sleutel in het manifest. Zie PSEdition-ondersteuning voor modules voor meer informatie.

• Versiegeschiedenis - Toont een lijst met versies van de module die zijn gepubliceerd naar de Galerij. Pakketten die zijn verborgen met de functie Verwijderen , worden niet weergegeven in de versiegeschiedenis, tenzij u de eigenaar van een pakket bent.

• Projectsite : deze informatie is afkomstig van het .PROJECTURI trefwoord in de op opmerkingen gebaseerde metagegevens van een scriptbestand.

• Licentie - Deze informatie is afkomstig van het .LICENSEURI trefwoord in de op opmerkingen gebaseerde metadata van een scriptbestand.

  Belangrijk

  Als er geen licentie wordt geleverd via het .LICENSEURI of binnen het pakket, zijn de gebruiksvoorwaarden voor de PowerShell-galerie van toepassing op het pakket. Zie de gebruiksvoorwaarden voor meer informatie.

• Pictogram : deze informatie is afkomstig van het .ICONURI trefwoord in de op opmerkingen gebaseerde metagegevens van een scriptbestand. De URI moet verwijzen naar een afbeelding van 85x85 met een transparante achtergrond. De URI moet een directe koppeling zijn naar het afbeeldingsbestand en mag niet naar een webpagina of een bestand in het PowerShell Gallery-pakket gaan.

Pakketdetails bewerken

Op de pakketpagina PowerShell Gallery Edit kunnen uitgevers verschillende velden wijzigen die voor een pakket worden weergegeven, met name:

• Title
• Description
• Samenvatting
• Icon-URL
• URL van de startpagina van het project
• Authors
• Auteursrecht
• Tags
• Opmerkingen bij de uitgave
• Licentie vereisen

U moet deze informatie in de galerij alleen bewerken om te corrigeren wat er wordt weergegeven voor een oudere versie van een module. Gebruikers die het pakket downloaden, zien dat de metagegevens niet overeenkomen met de PowerShell-galerie. Telkens wanneer u gegevens in de galerie wijzigt, moet u een nieuwe versie van het pakket publiceren met dezelfde wijzigingen.

Details van de tag

Tags zijn eenvoudige tekenreeksen die consumenten gebruiken om verpakkingen te vinden. Tags zijn het meest waardevol wanneer ze consistent worden gebruikt in gerelateerde pakketten. Het gebruik van variaties van hetzelfde woord, bijvoorbeeld database en databases of testen en testen, levert weinig voordeel op. Tags zijn tekenreeksen die niet hoofdlettergevoelig zijn voor één woord en mogen geen spaties bevatten. Als er een woordgroep is waarvan u denkt dat gebruikers ernaar zullen zoeken, voegt u die toe aan de pakketbeschrijving zodat deze kan worden gevonden in de zoekresultaten. Gebruik Pascal hoofdletters, koppeltekens, onderstrepingstekens of punten om de leesbaarheid te verbeteren. Wees voorzichtig met het maken van lange, complexe en ongebruikelijke tags die gemakkelijk verkeerd kunnen worden gespeld.

De cmdlets PowerShell Gallery en PowerShellGet hebben een speciale betekenis voor de PSEdition_Desktop tags and PSEdition_Core . Zie de voorgaande bespreking van PowerShell-edities.

Zoals eerder opgemerkt, bieden tags de meeste waarde wanneer ze specifiek zijn en consistent worden gebruikt in veel pakketten. Als uitgever die op zoek is naar de beste tags om te gebruiken, is de eenvoudigste aanpak om in de PowerShell-galerie te zoeken naar tags die u overweegt. Idealiter komen de geretourneerde pakketten overeen met uw gebruik van dat trefwoord.

In de volgende tabel ziet u enkele van de meest gebruikte tags. De voorkeurstag moet de beste zoekresultaten opleveren.