Item manifest waarden die invloed van de gebruikersinterface van de PowerShell-galerieItem manifest values that impact the PowerShell Gallery UI

In dit onderwerp biedt uitgevers met samenvattingsinformatie over het wijzigen van het manifest voor PowerShell Gallery publicaties zodat functies PowerShellGet-cmdlets en de gebruikersinterface van de PowerShell-galerie worden beïnvloed.This topic provides publishers with summary information on how to modify the manifest for their PowerShell Gallery publications so that features of PowerShellGet cmdlets and the PowerShell Gallery UI will be affected. Deze inhoud is geordend op waar de wijziging wordt weergegeven, vanaf het midden en klik op het navigatiegebied aan de linkerkant.This content is organized by where the change will appear, starting with the center section, then the navigation area on the left. Er is een sectie meer informatie over tags dekking biedt, waarin belangrijke veelgebruikte tags labels, evenals enkele van de meer.There is a detail section covering tags, which identifies important tags, as well as some of the more commonly used tags. Er zijn twee onderwerpen vindt u voorbeelden van manifest:There are two topics that provide manifest examples:

De onderstaande tabel bevat de elementen van de PowerShell-galerie-item pagina gebruikersinterface die worden beheerd door de uitgever.The table below shows the elements of the PowerShell Gallery item page UI that are controlled by the publisher. Elk item geeft aan of kan worden beheerd door het manifest module of script.Each item indicates if it may be controlled by the module or script manifest.

UI-ElementUI Element BeschrijvingDescription ModuleModule ScriptScript
TitelTitle Dit is de naam van het item dat is gepubliceerd naar de galerieThis is the name of the item that is published to the Gallery NeeNo NeeNo
VersieVersion De versie die wordt weergegeven is de tekenreeks in de metagegevens en een prerelease als is opgegeven.The version displayed is the version string in the metadata, and a prerelease if is specified. Het primaire gedeelte van de versie in een Module-manifest is de ModuleVersion.The primary portion of the version in a Module manifest is the ModuleVersion. Voor een script wordt vastgesteld als. Versie.For a script, it is identified as .VERSION. Als de tekenreeks van een prerelease-versie is opgegeven, worden deze toegevoegd aan de ModuleVersion voor modules of opgegeven als onderdeel van. De versie voor scripts.If a prerelease version string is specified, it will be appended to the ModuleVersion for modules, or specified as part of .VERSION for scripts. Er is voor het opgeven van prerelease tekenreeksen in de documentatie bij modules, en in scriptsThere is documentation for specifying prerelease strings in modules, and in scripts JaYes JaYes
BeschrijvingDescription Dit is de beschrijving in het manifest van de module en in de bestandenlijst voor een script is. BESCHRIJVINGThis is the Description in the module manifest, and in a script file manifest it is .DESCRIPTION JaYes JaYes
Vereisen dat gebruikers met licentieRequire license acceptance Een module kunt u vereisen dat de gebruiker een licentie accepteren door het wijzigen van de module-manifest met RequireLicenseAcceptance = $true, levert een LicenseURI en voorzien in een bestand license.txt in de hoofdmap van de modulemap.A module can require that the user accept a license, by modifying the module manifest with RequireLicenseAcceptance = $true, supplying a LicenseURI, and providing a license.txt file in the root of the module folder. Aanvullende informatie is beschikbaar in de vereisen licentie acceptatie onderwerp.Additional information is available in the Require License Acceptance topic. JaYes NeeNo
Opmerkingen bij de releaseRelease notes Voor modules, wordt deze informatie uit de sectie ReleaseNotes onder PSData\PrivateData getekend.For modules, this information is drawn from the ReleaseNotes section, under PSData\PrivateData. In de manifesten script, is de. RELEASENOTES-element.In script manifests, it is the .RELEASENOTES element. JaYes JaYes
EigenaarsOwners Eigenaars zijn de lijst met gebruikers in de PowerShell-galerie die een artikel kunt bijwerken.Owners are the list of users in the PowerShell Gallery who can update an item. De lijst eigenaar is niet opgenomen in het manifest item.The owner list is not included in the item manifest. Aanvullende documentatie wordt beschreven hoe u eigenaren van item beheren.Additional documentation describes how to manage item owners. NeeNo NeeNo
AuteurAuthor Dit is opgenomen in het manifest van de module als de auteur en in een script manifest als. AUTEUR.This is included in the module manifest as the Author, and in a script manifest as .AUTHOR. Het veld auteur wordt vaak gebruikt om op te geven van een bedrijf of organisatie die zijn gekoppeld aan een item.The Author field is often used to specify a company or organization associated with an item. JaYes JaYes
CopyrightCopyright Dit is het veld Copyright in het manifest van de module en. COPYRIGHT in het manifest van een script.This is the Copyright field in the module manifest, and .COPYRIGHT in a script manifest. JaYes JaYes
FileListFileList De lijst met bestanden is afkomstig van het pakket wanneer het wordt gepubliceerd naar de PowerShell-galerie.The file list is drawn from the package when it is published to the PowerShell Gallery. Het is geen instelbare door de manifest-gegevens.It is not controllable by the manifest information. Opmerking: Er is een extra .nuspec-bestand worden weergegeven met elk item in de PowerShell-galerie is niet aanwezig zijn na de installatie van het item op een systeem.Note: there is an additional .nuspec file listed with each item in the PowerShell Gallery that is not present after installing the item on a system. Dit is het manifest van de Nuget-pakket voor het item en kan worden genegeerd.This is the Nuget package manifest for the item, and may be ignored. NeeNo NeeNo
TagsTags Voor modules, Tags opgenomen onder PSData\PrivateData.For modules, Tags are included under PSData\PrivateData. Voor scripts, de sectie is met het label. LABELS.For scripts, the section is labelled .TAGS. Houd er rekening mee dat labels kunnen niet spaties, zelfs wanneer ze tussen aanhalingstekens.Note that tags cannot contain spaces, even when they are in quotes. Labels hebben aanvullende vereisten en betekenis zoals verderop in dit onderwerp in het gedeelte Details van de Tag wordt beschreven.Tags have additional requirements and meanings, which are described later in this topic in the Tag Details section. JaYes JaYes
CmdletsCmdlets Dit is opgegeven in de module-manifest met CmdletsToExport.This is provided in the module manifest using CmdletsToExport. Houd er rekening mee dat de aanbevolen procedure wordt expliciet lijstitems in plaats van met behulp van het jokerteken ' * ', zoals die de prestaties van de load-module voor gebruikers verbeteren.Note that the best practice is to explicitly list the items, rather than using the wildcard “*”, as that will improve the load-module performance for users. JaYes NeeNo
FunctiesFunctions Dit is opgegeven in de module-manifest met FunctionsToExport.This is provided in the module manifest using FunctionsToExport. Houd er rekening mee dat de aanbevolen procedure wordt expliciet lijstitems in plaats van met behulp van het jokerteken ' * ', zoals die de prestaties van de load-module voor gebruikers verbeteren.Note that the best practice is to explicitly list the items, rather than using the wildcard “*”, as that will improve the load-module performance for users. JaYes NeeNo
DSC-ResourcesDSC Resources Dit is opgegeven voor modules die worden gebruikt op PowerShell versie 5.0 en hoger, in het manifest met DscResourcesToExport.For modules that will be used on PowerShell version 5.0 and above, this is provided in the manifest using DscResourcesToExport. Als de module moet worden gebruikt in PowerShell 4 is, moet de DSCResourcesToExport niet worden gebruikt als het is geen ondersteunde manifest sleutel.If the module is to be used in PowerShell 4, the DSCResourcesToExport should not be used as it is not a supported manifest key. (DSC is niet beschikbaar voor PowerShell 4.)(DSC was not available prior to PowerShell 4.) JaYes NeeNo
WerkstromenWorkflows Werkstromen worden gepubliceerd naar de PowerShell-galerie als scripts en werkstromen aangemerkt (Zie Connect-AzureVM voor een voorbeeld) in de code.Workflows are published to the PowerShell Gallery as scripts, and identified as workflows (see Connect-AzureVM for an example) in the code. Dit wordt niet gecontroleerd door het manifest.This is not controlled by the manifest. NeeNo NeeNo
Mogelijkheden van de rolRole capabilities Dit wordt weergegeven wanneer de module die is gepubliceerd naar de PowerShell-galerie bevat een of meer rollen capability (.psrc)-bestanden, die door JEA worden gebruikt.This will be listed when the module published to the PowerShell Gallery contains one or more role capability (.psrc) files, which are used by JEA. Zie de JEA-documentatie voor meer informatie over rol mogelijkheden.See the JEA documentation for more details on role capabilities. JaYes NeeNo
PowerShell-editiesPowerShell Editions Dit is opgegeven in een script of module-manifest.This is specified in a script or module manifest. Modules die zijn ontworpen om te worden gebruikt met PowerShell 5.0 en onder dit wordt geregeld met Tags.For modules designed to be used with PowerShell 5.0 and below, this is controlled using Tags. Gebruik de tag PSEdition_Desktop voor bureaublad, en voor core, gebruikt u de tag PSEdition_Core.For Desktop, use the tag PSEdition_Desktop, and for core, use the tag PSEdition_Core. Voor modules die alleen op PowerShell 5.1 en hoger worden gebruikt, moet u er een sleutel CompatiblePSEditions is in het manifest van de belangrijkste.For modules that will be used only on PowerShell 5.1 and above, there is a CompatiblePSEditions key in the main manifest. Raadpleeg voor aanvullende details over de PS-editie-functie in de PowerShell-Get-documentatie.For additional detail, review the PS Edition feature in the PowerShell Get documentation. JaYes JaYes
AfhankelijkhedenDependencies Afhankelijkheden zijn de modules die zijn gedeclareerd in module als RequiredModules of in het manifest script als in de PowerShell-galerie #Requires-Module (naam).Dependencies are the modules in the PowerShell Gallery that are declared in either the module as RequiredModules, or in the script manifest as #Requires –Module (name). JaYes JaYes
Minimale versie van PowershellMinimum Powershell version Dit kan worden opgegeven in een module-manifest als PowerShellVersionThis can be specified in a module manifest as PowerShellVersion JaYes NeeNo
VersiegeschiedenisVersion History De versiegeschiedenis weerspiegelt de updates die zijn aangebracht in een module in de PowerShell-galerie.The version history reflects the updates made to a module in the PowerShell Gallery. Als een versie van een item wordt weergegeven met de functie verwijderen, wordt deze niet weergegeven in de geschiedenis, behalve voor de eigenaren van item.If a version of an item is hidden using the Delete feature, it will not be displayed in the version history, except to the item owners. NeeNo NeeNo
Project SiteProject Site De project-site is opgegeven voor modules in de sectie Privatedata\PSData van het manifest van de module door te geven van een ProjectURI.The project site is provided for modules in the Privatedata\PSData section of the module manifest by specifying a ProjectURI. In het manifest script wordt het geregeld door te geven. PROJECTURI.In the script manifest, it is controlled by specifying .PROJECTURI. JaYes JaYes
LicenseLicense Een licentie-koppeling is opgegeven voor modules in de sectie Privatedata\PSData van het manifest van de module door te geven van een LicenseURI.A license link is provided for modules in the Privatedata\PSData section of the module manifest by specifying a LicenseURI. In het manifest script wordt het geregeld door te geven. LICENSEURI.In the script manifest, it is controlled by specifying .LICENSEURI. Het is belangrijk te weten dat als een licentie niet via de LicenseURI opgegeven is of binnen een module, de gebruiksvoorwaarden voor de PowerShell-galerie geeft u de gebruiksvoorwaarden voor het item.It is important to note that if a license is not provided via the LicenseURI, or within a module, then the terms of use for the PowerShell Gallery specify the terms of use for the item. Zie de gebruiksvoorwaarden voor meer informatie.See the terms of use for details. JaYes JaYes

Details van item bewerkenEditing item details

De pagina bewerken van de PowerShell-galerie-item kunt uitgevers wijzigen aantal velden specifiek voor een item, weergegeven:The PowerShell Gallery Edit item page allows publishers to change several of the fields displayed for an item, specifically:

  • TitleTitle
  • BeschrijvingDescription
  • SamenvattingSummary
  • Pictogram-URLIcon URL
  • URL van de startpagina van projectProject home page URL
  • AuteursAuthors
  • CopyrightCopyright
  • LabelsTags
  • Opmerkingen bij de releaseRelease notes
  • Licentie nodigRequire license

Deze aanpak is algemeen niet aanbevolen, behalve wanneer nodig om op te lossen wat wordt weergegeven voor een oudere versie van een module.This approach is not generally recommended, except when needed to correct what is displayed for an older version of a module. Gebruikers die de module verkrijgen ziet de metagegevens komt niet overeen met wat in de PowerShell-galerie, waardoor problemen met het item wordt weergegeven.Users who acquire the module will see the metadata does not match what is displayed in the PowerShell Gallery, which raises concerns about the item. Dit leidt vaak in query's naar de item eigenaren van de wijziging te bevestigen.This will frequently result in inquiries going to to the item owners to confirm the change. Het is raadzaam dat elk gewenst moment dat deze aanpak wordt gebruikt, een nieuwe versie van het item moet worden gepubliceerd met de dezelfde wijzigingen.It is strongly recommended that any time this approach is used, a new version of the item should be published with the same changes.

Details van labelTag Details

Labels zijn eenvoudige tekenreeksen consumers gebruikt om items te vinden.Tags are simple strings consumers use to find items. Labels zijn het nuttigst wanneer deze consistent worden gebruikt voor veel items die betrekking hebben op hetzelfde onderwerp.Tags are most valuable when they are used consistently across many items related to the same topic. Met behulp van meerdere versies van dezelfde biedt word (bijvoorbeeld database en databases, of test en testen) gewoonlijk weinig voordeel.Using multiple flavors of the same word (for example database and databases, or test and testing) typically provides little benefit. Tags zijn niet hoofdlettergevoelig tekenreeksen van één woord en mag geen lege waarden bevatten.Tags are single-word case-insensitive strings and cannot include blanks. Als er een wachtwoordzin die u denkt gebruikers wordt gezocht dat naar, voegt u toe dat het item beschrijving en het in de zoekresultaten worden gevonden.If there is a phrase you believe users will search for, add that to the item description and it will be found in the search results. Gebruik Pascal hoofdlettergebruik, afbreekstreepje, onderstrepingsteken of punt als u probeert om leesbaarheid te verbeteren.Use Pascal casing, hyphen, underscore, or period if you are trying to improve readability. Lange, complexe en ongebruikelijke-labels maken voorzichtig zijn als ze vaak worden getypt.Be cautious about creating long, complex, and unusual tags, as they are often misspelled.

Er zijn labels die belangrijk zijn te weten, als de PowerShell-galerie en PowerShellGet cmdlets ze behandelen uniek.There are tags that are important to note, as the PowerShell Gallery and PowerShellGet cmdlets treat them uniquely. PSEdition_Desktop PSEdition_Core zijn de specifieke voorbeelden en hierboven zijn beschreven.PSEdition_Desktop and PSEdition_Core are the specific examples, and are described above.

Zoals eerder vermeld, worden de meeste waarde door tags bieden wanneer ze specifiek en gebruikte consistent voor veel items zijn.As noted above, tags provide the most value when they are specific, and used consistently across many items. Als een publisher bij het vinden van de beste labels te gebruiken, is de eenvoudigste manier om te zoeken van de PowerShell-galerie voor labels die u overweegt.As a publisher trying to locate the best tags to use, the easiest approach is to search the PowerShell Gallery for tags you are considering. In het ideale geval zal er veel items geretourneerd en beschrijvingen van de objecten worden uitgelijnd met uw gebruik van die sleutel woord.Ideally, there will be many items returned, and the item descriptions will align with your use of that key word.

Hier volgen enkele veelgebruikte codes vanaf 14-12/2017 ter referentie.For reference, here are some most commonly used tags as of 12/14/2017. In sommige gevallen zijn vergelijkbaar, maar mogelijk minder ideaal opties weergegeven naast het label.In some cases, there are similar but perhaps less ideal options listed beside the tag. Het is een best practice om te gebruiken van de Tag voorkeur als die leiden tot minder ruis en beter zoekresultaten voor consumenten.It is a best practice to use the Preferred Tag, as that will result in less noise, and better search results for consumers.

Voorkeur labelPreferred tag Alternatieven en -opmerkingenAlternatives and notes
AzureAzure
DSCDSC DesiredStateConfiguration minder wenselijk is, is te langDesiredStateConfiguration is less desirable, it’s too long
ResourceManagerResourceManager ARM wordt gebruikt om te beschrijven van het aantal processors en mag niet worden gebruikt voor Azure Resource ManagerARM is used to describe group of processors, and should not be used for Azure Resource Manager
SQLSQL
AWSAWS
DSCResourceDSCResource
AutomationAutomation
RESTREST
ActiveDirectoryActiveDirectory AD wordt momenteel niet gebruikt door zichzelfAD is not currently used by itself
SQLServerSQLServer
DBADBA
BeveiligingSecurity Defense is minder nauwkeurigDefense is less precise
DatabaseDatabase Database (meervoud) minder wenselijk isDatabases (plural) is less desirable
DevOpsDevOps
WindowsWindows
BuildBuild
ImplementatieDeployment Implementeer wat minder vaak wordt gebruiktDeploy is used somewhat less often
CloudCloud
GITGIT
TestTest Testen is minder wenselijkTesting is less desirable
VersionControlVersionControl Versie is minder nauwkeurig, hoewel er vaker gebruiktVersion is less precise, although used more frequently
LoggingLogging Voorkeur gebruik van logboekregistratie als een actiePreferred use of logging as an action
LogLog Voorkeur logboek worden gebruikt als een dingPreferred use of Log as a thing
Back-upBackup
IaaSIaaS
LinuxLinux
IISIIS
AzureAutomationAzureAutomation
StorageStorage
GitHubGitHub
JsonJson
ExchangeExchange
NetwerkNetwork Netwerken lijkt, zijn minder vaak worden gebruiktNetworking is similar, less often used
SharePointSharePoint
RapportageReporting Reporting is een actie, het rapport is een dingReporting is an action, report is a thing
RapportReport Rapport is een dingReport is a thing
WinRMWinRM
MonitoringMonitoring
VSTSVSTS
ExcelExcel
GoogleGoogle
ColorColor
DNSDNS
Office365Office365 Office spellen verdient de voorkeur.Spelling out Office is preferable. O365 wordt minder vaak gebruikt, hoewel korterO365 is less commonly used, although shorter
PesterPester
AzureADAzureAD
HTMLHTML
Hyper-VHyper-V Hyper-v is niet zo vaak als een tagHyperV is less common as a tag
ConfiguratieConfiguration
ChatOpsChatOps
PackageManagementPackageManagement
WMIWMI
FirewallFirewall
DockerDocker
AppveyorAppveyor
AzureRmAzureRm Primair gebruikt voor de AzureRM-modulesUsed primarily for the AzureRM modules
ZipZip
MSIMSI
MacMac
PoshBotPoshBot