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

  • Artikel

In dit artikel wordt uitgelegd hoe de metagegevens in uw pakketten worden gebruikt door de PowerShell Gallery. Voor modules worden 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:

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 is gepubliceerd in de galerie.

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

  • Beschrijving : dit is de beschrijving in het modulemanifest.

  • Acceptatie van licentie vereisen : voor een module kan worden vereist dat de gebruiker een licentie accepteert door in te stellen RequireLicenseAcceptance = $true, een licentie-URL op te geven en een license.txt bestand op te geven in de hoofdmap van de modulemap. Zie Acceptatie van licentie vereisen voor meer informatie.

  • Releaseopmerkingen : deze informatie is afkomstig uit de sectie ReleaseNotes onder PSData\PrivateData.

  • 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.

  • Auteur : dit is opgenomen in het modulemanifest als 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 lijst met bestanden wordt gemaakt wanneer het pakket wordt gepubliceerd naar de PowerShell Gallery. Dit kan niet worden bepaald door de manifestinformatie. De PowerShell Gallery maakt een .nuspec bestand dat wordt weergegeven in de bestandslijst van elk pakket. Dit bestand wordt niet met het pakket op een systeem geïnstalleerd. Dit is het NuGet-pakketmanifest voor het pakket en kan worden genegeerd.

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

  • Cmdlets : dit wordt opgegeven in het modulemanifest met cmdletsToExport. Het is een best practice om de cmdlet-namen expliciet weer te geven in plaats van het jokerteken *te gebruiken. Het hebben van een lijst verbetert de prestaties van de load-module.

  • Functions : dit wordt opgegeven in het modulemanifest met behulp van FunctionsToExport. Het is een best practice om de cmdlet-namen expliciet weer te geven in plaats van het jokerteken *te gebruiken. Het hebben van een lijst verbetert de prestaties van de load-module.

  • DSC-resources : dit is opgegeven 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 functiemogelijkheden 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 core 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 opgegeven in het manifest met behulp van RequiredModules.

  • Minimale PowerShell-versie : dit is opgegeven in het manifest met behulp van PowerShellVersion.

  • Versiegeschiedenis : toont een lijst met versies van de module die zijn gepubliceerd naar de galerie. Pakketten die zijn verborgen met de functie Verwijderen , worden niet weergegeven in de versiegeschiedenis, tenzij u een pakketeigenaar bent.

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

  • Licentie : er wordt een licentiekoppeling opgegeven voor modules in de PrivateData\PSData sectie van het modulemanifest door een Licentie-URI op te geven.

    Belangrijk

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

  • Pictogram : er wordt een koppeling opgegeven 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 doorzichtigheidsachtergrond. De URI moet een directe koppeling naar het afbeeldingsbestand zijn en mag niet naar een webpagina of een bestand in het PowerShell Gallery-pakket gaan.

De volgende lijst bevat de elementen van de gebruikersinterface van de PowerShell Gallery pakketpagina die worden beheerd door de op opmerkingen gebaseerde metagegevens in een scriptbestand.

  • Titel : dit is de naam van het pakket dat wordt gepubliceerd naar de galerie

  • Versie : de weergegeven versie is de versietekenreeks in de metagegevens en een prereleaselabel als is opgegeven. De waarde is afkomstig van het .VERSION trefwoord in het opmerkingenblok voor metagegevens. Wanneer u een prereleasescript publiceert, voegt u de prerelease-tekenreeks toe aan de versie. Zie Prerelease-versies van scripts voor meer 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.

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

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

  • 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. Zie Itemeigenaren beheren voor meer informatie.

  • Auteur : deze informatie is afkomstig van het .AUTHOR trefwoord in de op opmerkingen gebaseerde metagegevens 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 opmerkingen gebaseerde metagegevens van een scriptbestand.

  • FileList: de lijst met bestanden wordt gemaakt wanneer het pakket wordt gepubliceerd naar de PowerShell Gallery. Dit kan niet worden bepaald door de manifestinformatie. De PowerShell Gallery maakt een .nuspec bestand dat wordt weergegeven in de bestandslijst van elk pakket. Dit bestand wordt niet met het pakket op een systeem geïnstalleerd. Dit is het NuGet-pakketmanifest voor het pakket en kan worden genegeerd.

  • Tags : *Deze informatie is afkomstig van het .TAGS trefwoord in de op opmerkingen gebaseerde metagegevens 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 core 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 galerie. Pakketten die zijn verborgen met de functie Verwijderen , worden niet weergegeven in de versiegeschiedenis, tenzij u een pakketeigenaar 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 metagegevens van een scriptbestand.

    Belangrijk

    Als er geen licentie wordt verstrekt via het .LICENSEURI of in het pakket, zijn de gebruiksvoorwaarden voor de PowerShell Gallery 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 doorzichtigheidsachtergrond. De URI moet een directe koppeling naar het afbeeldingsbestand zijn en mag niet naar een webpagina of een bestand in het PowerShell Gallery-pakket gaan.

Pakketdetails bewerken

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

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

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

Tagdetails

Tags zijn eenvoudige tekenreeksen die consumenten gebruiken om pakketten 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, biedt weinig voordeel. Tags zijn hoofdlettergevoelige tekenreeksen van één woord en kunnen geen lege tekens bevatten. Als er een woordgroep is waarnaar gebruikers volgens u zullen zoeken, voegt u deze toe aan de beschrijving van het pakket, zodat deze in de zoekresultaten kan worden gevonden. Gebruik Pascal-hoofdletters, afbreekstreepjes, onderstrepingstekens of punten om de leesbaarheid te verbeteren. Wees voorzichtig met het maken van lange, complexe en ongebruikelijke tags die gemakkelijk verkeerd zijn gespeld.

De cmdlets PowerShell Gallery en PowerShellGet hebben speciale betekenissen voor de PSEdition_Desktop tags enPSEdition_Core. Zie de voorgaande discussie over PowerShell-edities.

Zoals eerder vermeld, bieden tags de meeste waarde wanneer ze specifiek zijn en consistent worden gebruikt in veel pakketten. Als uitgever die de beste tags probeert te vinden, is de eenvoudigste aanpak om in de PowerShell Gallery te zoeken naar tags die u overweegt. Idealiter zijn de geretourneerde pakketten afgestemd op uw gebruik van dat trefwoord.

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

Voorkeurstag Alternatieven en notities
Active Directory AD wordt momenteel niet door zichzelf gebruikt
Appveyor
Automation
AWS
Azure
AzureAD
AzureAutomation
AzureRm Voornamelijk gebruikt voor de AzureRM-modules
Backup
Build
ChatOps
Cloud
Kleur
Configuratie
CrescendoBuilt Deze tag wordt automatisch toegevoegd door Crescendo wanneer u de module exporteert
Database Databases (meervoud) is minder wenselijk
DBA
Implementatie Implementeren wordt iets minder vaak gebruikt
DevOps
DNS
Docker
DSC DesiredStateConfiguration is minder wenselijk, het is te lang
DSCResource
DSCResourceKit
Excel
Exchange
Firewall
GIT
GitHub
Gitlab
Google
HTML
Hyper-V HyperV komt minder vaak voor als tag
IaaS
IIS
Json
Linux
Logboek Voorkeursgebruik van Logboek als een ding
Logboekregistratie Voorkeursgebruik van logboekregistratie als actie
MacOS
Bewaking
MSI
Netwerk Netwerken zijn vergelijkbaar, minder vaak gebruikt
Office365 Office is beter gespeld. O365 wordt minder vaak gebruikt, hoewel korter
PackageManagement
Pester
PoshBot
Rapport Rapport is een ding
Rapporten Rapporteren is een actie, rapport is een ding
ResourceManager 'Arm' wordt gebruikt om een groep processors te beschrijven en mag niet worden gebruikt voor Azure Resource Manager
REST
Beveiliging De verdediging is minder nauwkeurig
SharePoint
SQL
Sqlserver
Storage
Testen Testen is minder wenselijk
Versioncontrol De versie is minder nauwkeurig, hoewel deze vaker wordt gebruikt
VSTS
Windows
WinRM
WMI
Zip