Waarden voor pakketmetagegevens die van invloed zijn op de gebruikersinterface van de PowerShell Gallery

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 deze is opgegeven. De opgegeven prereleasetekenreeks wordt toegevoegd aan de ModuleVersion. Zie prereleasemoduleversies voor meer informatie over prereleasereeksen in modules.

  • Beschrijving : dit is de beschrijving in het modulemanifest.

  • Acceptatie van licenties vereisen: een module kan vereisen dat de gebruiker een licentie accepteert, door een licentie-URI in te stellen RequireLicenseAcceptance = $trueen 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 dat is gekoppeld aan een pakket.

  • Copyright : dit is het veld Copyright in het modulemanifest.

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

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

  • Cmdlets : dit wordt opgegeven in het modulemanifest met behulp van CmdletsToExport. Het is een best practice om expliciet de namen van de cmdlets weer te geven in plaats van het jokerteken *te gebruiken. Als u een lijst hebt, worden de prestaties van de load-module verbeterd.

  • Functions : dit wordt geleverd in het modulemanifest met behulp van FunctionsToExport. Het is een best practice om expliciet de namen van de cmdlets weer te geven in plaats van het jokerteken *te gebruiken. Als u een lijst hebt, worden de prestaties van de load-module verbeterd.

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

  • Functiemogelijkheden : 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. Voor Desktop gebruikt u de tag PSEdition_Desktop en voor core gebruikt u 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 beschikbaar in het manifest met behulp van PowerShellVersion.

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

  • Projectsite : de projectsite is beschikbaar 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 een licentie niet 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 voor modules in de PrivateData\PSData sectie van het modulemanifest opgegeven door een IconURI op te geven. De URI moet verwijzen naar een afbeelding van 85x85 met transparantieachtergrond. 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 metagegevens op basis van opmerkingen in een scriptbestand.

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

  • Versie : de weergegeven versie is de versietekenreeks in de metagegevens en een prereleaselabel als deze is opgegeven. De waarde is afkomstig van het .VERSION trefwoord in het opmerkingenblok voor metagegevens. Wanneer u een prereleasescript publiceert, voegt u de prereleasetekenreeks toe aan de versie. Zie Prerelease-versies van scripts voor meer informatie over het opgeven van prereleasetekenreeksen in modules.

  • Beschrijving : deze informatie is afkomstig van het .DESCRIPTION trefwoord in de hulp op basis van opmerkingen van een scriptbestand.

  • Licentieacceptatie vereisen : een script kan vereisen dat de gebruiker een licentie accepteert door het trefwoord in te stellen .LICENSEURI in het blok met metagegevenscommentatie. Zie Acceptatie van licenties vereisen voor scripts voor meer informatie.

  • Releaseopmerkingen : deze informatie is afkomstig van het .RELEASENOTES trefwoord in de metagegevens op basis van opmerkingen 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 De eigenaren van items beheren voor meer informatie.

  • Auteur : deze informatie is afkomstig van het .AUTHOR trefwoord in de metagegevens op basis van opmerkingen van een scriptbestand. Het veld Auteur wordt vaak gebruikt om een bedrijf of organisatie op te geven dat is gekoppeld aan een pakket.

  • Copyright : deze informatie is afkomstig van het .COPYRIGHT trefwoord in de metagegevens op basis van opmerkingen van een scriptbestand.

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

  • Tags - *Deze informatie is afkomstig van het .TAGS trefwoord in de metagegevens op basis van opmerkingen 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. Voor Desktop gebruikt u de tag PSEdition_Desktop en voor core gebruikt u 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 in 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 .LICENSEURI trefwoord in de metagegevens op basis van opmerkingen van een scriptbestand.

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

    Belangrijk

    Als een licentie niet wordt verstrekt via het .LICENSEURI of binnen 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 metagegevens op basis van opmerkingen van een scriptbestand. De URI moet verwijzen naar een afbeelding van 85x85 met transparantieachtergrond. 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

Met 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 informatie wijzigt in de galerie, moet u een nieuwe versie van het pakket publiceren met dezelfde wijzigingen.

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

De cmdlets PowerShell Gallery en PowerShellGet hebben speciale betekenissen voor de PSEdition_Desktop en PSEdition_Core tags. 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 die u wilt gebruiken, is de eenvoudigste manier om te zoeken naar de PowerShell Gallery voor tags die u overweegt. In het ideale voorbeeld komen de 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 retourneren.

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 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 is minder gebruikelijk als tag
IaaS
IIS
Json
Linux
Logboek Voorkeursgebruik van Logboek als ding
Logboekregistratie Voorkeursgebruik van logboekregistratie als een actie
MacOS
Bewaking
MSI
Netwerk Netwerken zijn vergelijkbaar, minder vaak gebruikt
Office365 Office wordt beter gespeld. O365 wordt minder vaak gebruikt, hoewel korter
PackageManagement
Pester
PoshBot
Rapport Rapport is een ding
Rapporten Rapportage 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 Verdediging is minder nauwkeurig
SharePoint
SQL
Sqlserver
Storage
Testen Testen is minder wenselijk
Versioncontrol Versie is minder nauwkeurig, hoewel deze vaker wordt gebruikt
VSTS
Windows
WinRM
WMI
Zip