Wartości manifestu pakietu, które mają wpływ na interfejs użytkownika galerii programu PowerShellPackage manifest values that impact the PowerShell Gallery UI

Ten temat zawiera wydawców podsumowanie informacji na temat sposobu zmodyfikować manifest w swoich publikacjach galerii programu PowerShell, dzięki czemu będzie mieć wpływ na funkcje polecenia cmdlet PowerShellGet i interfejs użytkownika galerii programu PowerShell.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. Ta zawartość jest posortowana według której zmiana zostanie zastosowana, zaczynając od w górnej części, a następnie w obszarze nawigacyjnym po lewej stronie.This content is organized by where the change will appear, starting with the center section, then the navigation area on the left. Ma sekcji szczegółów obejmujący znaczników, który identyfikuje istotne, tagi, a także niektórych najczęściej używanych tagów.There is a detail section covering tags, which identifies important tags, as well as some of the more commonly used tags. Istnieją dwa tematy, które zawierają przykłady manifestu:There are two topics that provide manifest examples:

W poniższej tabeli przedstawiono elementy strony pakietu galerii programu PowerShell, interfejsu użytkownika, które są kontrolowane przez wydawcę.The table below shows the elements of the PowerShell Gallery package page UI that are controlled by the publisher. Każdy element wskazuje, czy może kontrolowane przez w manifeście modułu lub skryptu.Each item indicates if it may be controlled by the module or script manifest.

Element interfejsu użytkownikaUI Element OpisDescription ModułModule SkryptScript
TytułTitle Jest to nazwa pakietu, który jest opublikowany w galeriiThis is the name of the package that is published to the Gallery NieNo NieNo
WersjaVersion Wyświetlana jest wersja ciąg wersji metadanych i wstępnej Jeśli jest określony.The version displayed is the version string in the metadata, and a prerelease if is specified. Część podstawowej wersji w manifeście modułu jest ModuleVersion.The primary portion of the version in a Module manifest is the ModuleVersion. Aby uzyskać skrypt jest identyfikowany jako. Wersja.For a script, it is identified as .VERSION. Jeśli zostanie określony ciąg wersji wstępnej, on dołączany do ModuleVersion dla modułów, lub określony jako część. WERSJA dla skryptów.If a prerelease version string is specified, it will be appended to the ModuleVersion for modules, or specified as part of .VERSION for scripts. Brak dokumentacji do określania ciągów wersji wstępnej w modułów, a następnie w skryptówThere is documentation for specifying prerelease strings in modules, and in scripts TakYes TakYes
OpisDescription Jest to opis w manifeście modułu, a w manifest pliku skryptu. OPIS ELEMENTUThis is the Description in the module manifest, and in a script file manifest it is .DESCRIPTION TakYes TakYes
Wymaganie akceptacji licencjiRequire license acceptance Moduł może wymagać, że użytkownik akceptuje licencji, modyfikując manifestu modułu RequireLicenseAcceptance = $true, podając LicenseURI i podając pliku license.txt w katalogu głównym folderu modułu.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. Dodatkowe informacje są dostępne w wymaga zaakceptowania licencji tematu.Additional information is available in the Require License Acceptance topic. TakYes NieNo
Informacje o wersjiRelease notes Dla modułów te informacje są pobierane z sekcji ReleaseNotes w obszarze PSData\PrivateData.For modules, this information is drawn from the ReleaseNotes section, under PSData\PrivateData. W manifestach skryptu jest. RELEASENOTES element.In script manifests, it is the .RELEASENOTES element. TakYes TakYes
WłaścicieleOwners Właściciele są listy użytkowników w galerii programu PowerShell, który może zaktualizować pakiet.Owners are the list of users in the PowerShell Gallery who can update a package. Listy właścicieli jest niedostępna w manifeście pakietu.The owner list is not included in the package manifest. Dodatkowa dokumentacja zawiera opis sposobu Zarządzanie właścicielami elementów.Additional documentation describes how to manage item owners. NieNo NieNo
AutorAuthor Jest to zawarte w manifeście modułu autor oraz w manifeście jako skrypt. AUTOR.This is included in the module manifest as the Author, and in a script manifest as .AUTHOR. Pola Autor jest często używany do określenia firmy lub organizacji skojarzony z pakietem.The Author field is often used to specify a company or organization associated with a package. TakYes TakYes
CopyrightCopyright Jest to w polu Copyright w manifeście modułu i. COPYRIGHT w manifeście skryptu.This is the Copyright field in the module manifest, and .COPYRIGHT in a script manifest. TakYes TakYes
FileListFileList Lista plików jest rysowana od pakietu, gdy zostanie opublikowany w galerii programu PowerShell.The file list is drawn from the package when it is published to the PowerShell Gallery. Nie jest kontrolowane przez informacje manifestu.It is not controllable by the manifest information. Uwaga: jest plik dodatkowe .nuspec z każdego pakietu w galerii programu PowerShell, który nie jest obecny, po zainstalowaniu pakietu w systemie.Note: there is an additional .nuspec file listed with each package in the PowerShell Gallery that is not present after installing the package on a system. To jest manifest pakietu Nuget dla pakietu i mogą być ignorowane.This is the Nuget package manifest for the package, and may be ignored. NieNo NieNo
TagiTags Dla modułów tagi znajdują się w obszarze PSData\PrivateData.For modules, Tags are included under PSData\PrivateData. W przypadku skryptów jest oznaczona sekcji. TAGI.For scripts, the section is labelled .TAGS. Należy pamiętać, że tagi nie może zawierać spacji, nawet wtedy, gdy są one w cudzysłowie.Note that tags cannot contain spaces, even when they are in quotes. Tagi mają dodatkowe wymagania i znaczenie, które są opisane w dalszej części tego tematu w sekcji szczegółów tagu.Tags have additional requirements and meanings, which are described later in this topic in the Tag Details section. TakYes TakYes
Polecenia cmdletCmdlets To jest dostępna w manifeście modułu przy użyciu CmdletsToExport.This is provided in the module manifest using CmdletsToExport. Należy pamiętać, że najlepszym rozwiązaniem jest jawnie listę elementów, a nie za pomocą symbolu wieloznacznego "*", ponieważ moduł ładowania usprawnić dla użytkowników.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. TakYes NieNo
FunkcjeFunctions To jest dostępna w manifeście modułu przy użyciu FunctionsToExport.This is provided in the module manifest using FunctionsToExport. Należy pamiętać, że najlepszym rozwiązaniem jest jawnie listę elementów, a nie za pomocą symbolu wieloznacznego "*", ponieważ moduł ładowania usprawnić dla użytkowników.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. TakYes NieNo
Zasoby DSCDSC Resources Dla modułów, które będą używane w programie PowerShell w wersji 5.0 lub nowszym to jest podawany jako manifest za pomocą DscResourcesToExport.For modules that will be used on PowerShell version 5.0 and above, this is provided in the manifest using DscResourcesToExport. Jeśli moduł jest ma być używany w programie PowerShell 4, DSCResourcesToExport nie należy użyć, ponieważ nie jest obsługiwane klucza manifestu.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 nie była dostępna przed 4 programu PowerShell).(DSC was not available prior to PowerShell 4.) TakYes NieNo
Przepływy pracyWorkflows Przepływy pracy są publikowane w galerii programu PowerShell jako skrypty i zidentyfikowane jako przepływy pracy (zobacz Connect-AzureVM przykład) w kodzie.Workflows are published to the PowerShell Gallery as scripts, and identified as workflows (see Connect-AzureVM for an example) in the code. To nie są kontrolowane przez manifestu.This is not controlled by the manifest. NieNo NieNo
Możliwości roliRole capabilities To będzie wyświetlane, gdy moduł, który został opublikowany w galerii programu PowerShell plikami przynajmniej jednej roli możliwości (.psrc), które są używane przez usługi JEA.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. Znajdują się w dokumentacji usługi JEA, aby uzyskać więcej informacji na możliwości roli.See the JEA documentation for more details on role capabilities. TakYes NieNo
Wersje programu PowerShellPowerShell Editions To jest określona w manifeście skryptu lub modułu.This is specified in a script or module manifest. Dla modułów, przeznaczony do użycia przy użyciu programu PowerShell w wersji 5.0, a poniżej, jest kontrolowany przy użyciu tagów.For modules designed to be used with PowerShell 5.0 and below, this is controlled using Tags. Dla komputerów Użyj tagu PSEdition_Desktop i core, można użyć w tagu PSEdition_Core.For Desktop, use the tag PSEdition_Desktop, and for core, use the tag PSEdition_Core. Dla modułów, które będą używane tylko w programie PowerShell 5.1 i nowszych istnieje klucz CompatiblePSEditions w manifeście głównego.For modules that will be used only on PowerShell 5.1 and above, there is a CompatiblePSEditions key in the main manifest. Aby uzyskać dodatkowe szczegóły, zapoznaj się z funkcji wersji PS w dokumentacji programu PowerShell Get.For additional detail, review the PS Edition feature in the PowerShell Get documentation. TakYes TakYes
ZależnościDependencies Zależności są moduły w galerii programu PowerShell, które są zadeklarowane w module jako RequiredModules lub w manifeście skryptu jako #Requires — moduł (nazwa).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). TakYes TakYes
Minimalna wersja programu PowershellMinimum Powershell version To może być określona w manifeście modułu jako PowerShellVersionThis can be specified in a module manifest as PowerShellVersion TakYes NieNo
Historia wersjiVersion History Historia wersji odzwierciedla aktualizacje wprowadzone w module w galerii programu PowerShell.The version history reflects the updates made to a module in the PowerShell Gallery. Jeśli wersja pakietu jest ukryty za pomocą funkcji usuwania, go nie pojawi się w historii wersji, z wyjątkiem do właścicieli pakietu.If a version of a package is hidden using the Delete feature, it will not be displayed in the version history, except to the package owners. NieNo NieNo
Witryny projektuProject Site Moduły w sekcji Privatedata\PSData manifestu modułu umowy witryny projektu, określając ProjectURI.The project site is provided for modules in the Privatedata\PSData section of the module manifest by specifying a ProjectURI. W manifeście skryptu jest kontrolowana przez określenie. PROJECTURI.In the script manifest, it is controlled by specifying .PROJECTURI. TakYes TakYes
LicencjaLicense Link licencji umowy modułów w sekcji Privatedata\PSData manifestu modułu, określając LicenseURI.A license link is provided for modules in the Privatedata\PSData section of the module manifest by specifying a LicenseURI. W manifeście skryptu jest kontrolowana przez określenie. LICENSEURI.In the script manifest, it is controlled by specifying .LICENSEURI. Należy zauważyć, że jeśli licencji nie jest oferowana w ramach LicenseURI lub w module warunków użytkowania dla galerii programu PowerShell Określ warunki użytkowania dla pakietu.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 package. Zobacz warunki użytkowania, aby uzyskać szczegółowe informacje.See the terms of use for details. TakYes TakYes
IkonaIcon Ikona można określić dla dowolnego pakietu w galerii programu PowerShell, podając wartość IconURI Flaga w manifeście skryptów lub w sekcji Privatedata PSData manifestu modułu.An icon can be specified for any package in the PowerShell Gallery by supplying the IconURI flag in the script manifest, or in the Privatedata-PSData section of the module manifest. Wartość IconURI powinien wskazywać obraz 32 x 32, przezroczystość tła.The IconURI should point to a 32x32 image with transparency background. Identyfikator URI musi być adresem URL obrazu bezpośrednie i nie przejdź do strony sieci web zawierającej obraz lub plików w pakiecie galerii programu PowerShell.The URI must be a direct image URL and must not go to a web page containing the image, or a file in the PowerShell Gallery package. TakYes TakYes

Edytowanie szczegółów pakietuEditing package details

Strona pakietu edytować galerii programu PowerShell umożliwia wydawcy zmienić kilka pól wyświetlanych dla pakietu, w szczególności:The PowerShell Gallery Edit package page allows publishers to change several of the fields displayed for a package, specifically:

  • TytułTitle
  • OpisDescription
  • PodsumowanieSummary
  • Adres URL ikonyIcon URL
  • Adres URL strony głównej projektuProject home page URL
  • AutorzyAuthors
  • Prawa autorskieCopyright
  • TagiTags
  • Informacje o wersjiRelease notes
  • Wymaga licencjiRequire license

To podejście jest zwykle niezalecane, z wyjątkiem sytuacji, gdy konieczne Popraw wyświetlanych dla starszej wersji modułu.This approach is not generally recommended, except when needed to correct what is displayed for an older version of a module. Użytkownicy, którzy zakupili moduł zobaczą metadanych nie być zgodny z wyświetlanych w galerii programu PowerShell, który wywołuje wątpliwości dotyczące pakietu.Users who acquire the module will see the metadata does not match what is displayed in the PowerShell Gallery, which raises concerns about the package. Spowoduje to często zapytania, przechodząc do właścicieli pakietu, aby potwierdzić zmiany.This will frequently result in inquiries going to the package owners to confirm the change. Zdecydowanie zaleca się, że każdym razem, gdy ta metoda jest stosowana, nową wersję pakietu powinny być publikowane z tej samej zmiany.It is strongly recommended that any time this approach is used, a new version of the package should be published with the same changes.

Szczegóły taguTag Details

Tagi są zwykłe ciągi odbiorcy Użyj, aby wyszukiwać pakiety.Tags are simple strings consumers use to find packages. Tagi są najbardziej przydatne, gdy są stosowane konsekwentnie w wielu pakietach związane z tym samym temacie.Tags are most valuable when they are used consistently across many packages related to the same topic. Za pomocą wiele wersji tego samego programu word (na przykład bazy danych i baz danych, lub testów i testowania) zwykle zapewnia niewielkie korzyści.Using multiple flavors of the same word (for example database and databases, or test and testing) typically provides little benefit. Tagi są jednowyrazowej ciągów bez uwzględniania wielkości liter i nie może zawierać spacji.Tags are single-word case-insensitive strings and cannot include blanks. W przypadku frazy, które uważasz, że użytkownicy będą wyszukiwać, dodaj ją do opisu pakietu i będzie można znaleźć w wynikach wyszukiwania.If there is a phrase you believe users will search for, add that to the package description and it will be found in the search results. Użyj Pascal wielkość liter w wyrazie, łącznik, podkreślenie lub okres, jeśli próbujesz w celu poprawienia czytelności.Use Pascal casing, hyphen, underscore, or period if you are trying to improve readability. Należy zachować ostrożność w przypadku tworzenia tagów długie, złożone i nietypowe, ponieważ są one często błędna.Be cautious about creating long, complex, and unusual tags, as they are often misspelled.

Istnieją znaczniki, które są pamiętać, galerii programu PowerShell oraz PowerShellGet poleceń cmdlet je traktować unikatowo.There are tags that are important to note, as the PowerShell Gallery and PowerShellGet cmdlets treat them uniquely. PSEdition_Desktop PSEdition_Core są konkretne przykłady i opisanych powyżej.PSEdition_Desktop and PSEdition_Core are the specific examples, and are described above.

Jak wspomniano powyżej, tagi zapewniają najbardziej wartości, gdy są określone i używany konsekwentnie w wielu pakietach.As noted above, tags provide the most value when they are specific, and used consistently across many packages. Jako wydawca próbuje zlokalizować najlepsze tagów do użycia to najłatwiejsza metoda jest wyszukiwanie w galerii programu PowerShell dla tagów, które zamierzasz.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. W idealnym przypadku będzie istnieć wiele pakietów zwracane i opisy pakietu zostaną wyrównane z użyciem tego słowa kluczowego.Ideally, there will be many packages returned, and the package descriptions will align with your use of that key word.

Odwołanie poniżej przedstawiono niektóre najczęściej używanych tagi, począwszy od 12/14/2017.For reference, here are some most commonly used tags as of 12/14/2017. W niektórych przypadkach są podobne, ale może być mniej idealne opcje wymienione na liście obok znacznikiem.In some cases, there are similar but perhaps less ideal options listed beside the tag. Jest najlepszym rozwiązaniem jest używany Tag preferowane jako skutkować mniejszą hałasu i lepsze wyniki wyszukiwania dla konsumentów.It is a best practice to use the Preferred Tag, as that will result in less noise, and better search results for consumers.

Preferowany taguPreferred tag Alternatywy i uwagiAlternatives and notes
AzureAzure
DSCDSC DesiredStateConfiguration jest mniej pożądana, jest za długaDesiredStateConfiguration is less desirable, it’s too long
Menedżer zasobówResourceManager Służy do opisywania grupy procesorów ARM i nie powinny być używane dla usługi Azure Resource ManagerARM is used to describe group of processors, and should not be used for Azure Resource Manager
DSCResourceKitDSCResourceKit
SQLSQL
AWSAWS
DSCResourceDSCResource
AutomatyzacjaAutomation
RESTREST
Polecenie cmdletActiveDirectory Usługi AD nie jest obecnie używany przez siebieAD is not currently used by itself
SQLServerSQLServer
DBADBA
BezpieczeństwoSecurity Ochrona jest mniej dokładnyDefense is less precise
Baza danychDatabase Bazy danych (liczba mnoga) jest mniej pożądanaDatabases (plural) is less desirable
Metodyka DevOpsDevOps
WindowsWindows
KompilacjaBuild
WdrażanieDeployment Wdrażanie jest nieco mniej często używaneDeploy is used somewhat less often
ChmuraCloud
USŁUGI GITGIT
TestTest Testowanie jest mniej pożądanaTesting is less desirable
Kontrola wersjiVersionControl Wersja jest mniej dokładne, mimo że częściej używaneVersion is less precise, although used more frequently
RejestrowanieLogging Użyj preferowanych rejestrowania akcjiPreferred use of logging as an action
DziennikLog Preferowany korzystanie z dziennika jako rzeczyPreferred use of Log as a thing
ZapasowyBackup
IaaSIaaS
LinuxLinux
IISIIS
AzureAutomationAzureAutomation
MagazynStorage
GitHubGitHub
JSONJson
ExchangeExchange
SiećNetwork Sieć jest podobny, rzadziej używaneNetworking is similar, less often used
Program SharePointSharePoint
RaportowanieReporting Raportowanie jest akcja, jest to raportReporting is an action, report is a thing
RaportReport Jest to raportReport is a thing
Usługa WinRMWinRM
MonitorowanieMonitoring
USŁUGA VSTSVSTS
ExcelExcel
GoogleGoogle
KolorColor
DNSDNS
Usługi Office 365Office365 Preferowane jest pisownia się pakietu Office.Spelling out Office is preferable. Usługi Office 365 jest rzadko używane, ale krótszyO365 is less commonly used, although shorter
GitlabGitlab
PesterPester
Usługi Azure ADAzureAD
HTMLHTML
Funkcja Hyper-VHyper-V Funkcji Hyper-v jest mniej typowe jako tagHyperV is less common as a tag
KonfiguracjaConfiguration
ChatOpsChatOps
Funkcja PackageManagementPackageManagement
WMIWMI
ZaporaFirewall
Platformy dockerDocker
AppveyorAppveyor
AzureRmAzureRm Zazwyczaj używany do modułów AzureRMUsed primarily for the AzureRM modules
ZIPZip
TOŻSAMOŚCI USŁUGI ZARZĄDZANEJMSI
MacMac
PoshBotPoshBot