Poznámka:
Přístup k této stránce vyžaduje autorizaci. Můžete se zkusit přihlásit nebo změnit adresáře.
Přístup k této stránce vyžaduje autorizaci. Můžete zkusit změnit adresáře.
Tento článek vysvětluje, jak Galerie prostředí PowerShell používá metadata ve vašich balíčcích. U modulů jsou metadata uložena v manifestu modulu. U skriptů se metadata ukládají pomocí klíčových slov založených na komentářích. K vytvoření nebo aktualizaci těchto metadat se používají následující rutiny:
Prvky funkcí Galerie prostředí PowerShell řízené manifestem modulu
Následující seznam ukazuje prvky uživatelského rozhraní stránky balíčku Galerie prostředí PowerShell, které jsou řízeny manifestem modulu.
Název – Název balíčku publikovaného v Galerii.
Verze – Zobrazená verze je řetězec verze v metadatech a popisek předběžné verze, pokud je zadaný. Zadaný řetězec předběžné verze je připojen k ModuleVersion. Informace o předběžných verzích řetězců v modulech naleznete v tématu Předběžné verze modulů.
Popis – Toto je Popis v manifestu modulu.
Vyžadovat přijetí licence – Modul může vyžadovat, aby uživatel přijal licenci, a to nastavením
RequireLicenseAcceptance = $true, zadáním identifikátoru LicenseURI a poskytnutímlicense.txtsouboru v kořenovém adresáři složky modulu. Další informace naleznete v části Vyžadování přijetí licence.Poznámky k verzi – Tyto informace pocházejí z části ReleaseNotes v části
PSData\PrivateData.Vlastníci – Vlastníci jsou seznam uživatelů v Galerii prostředí PowerShell, kteří mohou aktualizovat balíček. Seznam vlastníků není součástí manifestu balíčku. Další dokumentace popisuje, jak spravovat vlastníky položek.
Autor – Je zahrnut v manifestu modulu jako Autor. Pole Autor se často používá k určení společnosti nebo organizace spojené s balíčkem.
Copyright – Jedná se o pole Copyright v manifestu modulu.
FileList – Seznam souborů se vytvoří při publikování balíčku do Galerie prostředí PowerShell. Není kontrolovatelný informacemi manifestu. Galerie prostředí PowerShell vytvoří
.nuspecsoubor, který se zobrazí v seznamu souborů každého balíčku. Tento soubor není nainstalován s balíčkem v systému. Toto je manifest balíčku NuGet pro balíček a lze jej ignorovat.Visačky - Značky jsou zahrnuty v
PrivateData\PSDatamanifestu modulu. Značky mají specifické požadavky a významy, které jsou popsány v části Podrobnosti značky .Rutiny – K dispozici je v manifestu modulu pomocí rutinyToExport. Osvědčeným postupem je explicitně vypsat názvy rutin místo použití zástupného znaku
*. Seznam zlepšuje výkon modulu zatížení.Funkce – To je k dispozici v manifestu modulu pomocí FunctionsToExport. Osvědčeným postupem je explicitně vypsat názvy rutin místo použití zástupného znaku
*. Seznam zlepšuje výkon modulu zatížení.Prostředky DSC – Jsou k dispozici v manifestu pomocí DscResourcesToExport. Tato hodnota je podporována pouze pro moduly v PowerShellu 5.0 a novějším.
Možnosti rolí – Role jsou uvedeny, pokud má modul jeden nebo více souborů schopností rolí (
.psrc). Tyto soubory používá společnost JEA. Další informace naleznete v tématu Možnosti rolí.Edice PowerShellu – U modulů navržených pro PowerShell 5.0 a nižší se toto ovládá pomocí značek. Pro stolní počítače použijte značku PSEdition_Desktop a pro jádro použijte značku PSEdition_Core. U modulů navržených pro PowerShell 5.1 a novější je v manifestu klíč CompatiblePSEditions . Další informace najdete v tématu Podpora PSEdition pro moduly.
Závislosti – To je k dispozici v manifestu pomocí RequiredModules.
Minimální verze PowerShellu – Ta je k dispozici v manifestu pomocí PowerShellVersion.
Historie verzí – Zobrazuje seznam verzí modulu, které byly publikovány v Galerii. Balíčky skryté pomocí funkce Odstranit se v historii verzí nezobrazují, pokud nejste vlastníkem balíčku.
Web projektu – Web projektu je k dispozici pro moduly v
PrivateData\PSDatačásti manifestu modulu zadáním identifikátoru ProjectURI.Licence – Odkaz na licenci je k dispozici pro moduly v
PrivateData\PSDatačásti manifestu modulu zadáním identifikátoru LicenseURI.Důležité
Pokud licence není poskytována prostřednictvím identifikátoru LicenseURI nebo v rámci balíčku, vztahují se na balíček podmínky použití pro Galerie prostředí PowerShell. Další informace naleznete v Podmínkách použití.
Ikona – Odkaz je k dispozici pro moduly v
PrivateData\PSDatačásti manifestu modulu zadáním identifikátoru IconURI. Identifikátor URI by měl odkazovat na obrázek 85 × 85 s pozadím průhlednosti. Identifikátor URI musí být přímým odkazem na soubor obrázku a nesmí směřovat na webovou stránku nebo soubor v balíčku Galerie prostředí PowerShell.
Prvky funkce Galerie prostředí PowerShell řízené metadaty skriptu
Následující seznam ukazuje prvky uživatelského rozhraní stránky balíčku Galerie prostředí PowerShell, které jsou řízeny metadaty založenými na komentářích v souboru skriptu.
Název – Toto je název balíčku, který je publikován v Galerii
Verze – Zobrazená verze je řetězec verze v metadatech a popisek předběžné verze, pokud je zadaný. Hodnota pochází z klíčového
.VERSIONslova v bloku komentáře metadat. Při publikování skriptu předběžné verze připojte k verzi řetězec předběžné verze. Informace o zadávání předběžných verzí řetězců v modulech naleznete v tématu Předběžné verze skriptů.Popis – Tyto informace pocházejí z klíčového
.DESCRIPTIONslova v nápovědě k souboru skriptu založené na komentářích.Vyžadovat přijetí licence – Přijetí licence není podporováno pro skripty. Scénář, kdy skript závisí na modulu, který vyžaduje přijetí licence, je však podporován. Další informace naleznete v části Vyžadování přijetí licence pro skripty.
Poznámky k verzi – Tyto informace pocházejí z klíčového
.RELEASENOTESslova v metadatech souboru skriptu založených na komentářích.Vlastníci – Vlastníci jsou seznam uživatelů v Galerii prostředí PowerShell, kteří mohou aktualizovat balíček. Seznam vlastníků není součástí manifestu balíčku. Další informace naleznete v tématu Správa vlastníků položek.
Autor – Tyto informace pocházejí z klíčového
.AUTHORslova v metadatech souboru skriptu založených na komentářích. Pole Autor se často používá k určení společnosti nebo organizace spojené s balíčkem.Autorská práva – Tyto informace pocházejí z klíčového
.COPYRIGHTslova v metadatech souboru skriptu založených na komentářích.FileList – Seznam souborů se vytvoří při publikování balíčku do Galerie prostředí PowerShell. Není kontrolovatelný informacemi manifestu. Galerie prostředí PowerShell vytvoří
.nuspecsoubor, který se zobrazí v seznamu souborů každého balíčku. Tento soubor není nainstalován s balíčkem v systému. Toto je manifest balíčku NuGet pro balíček a lze jej ignorovat.Tagy - * Tyto informace pocházejí z klíčového
.TAGSslova v komentářích na základě metadat souboru skriptu. Značky mají specifické požadavky a významy, které jsou popsány v části Podrobnosti značky .Edice PowerShellu – U modulů navržených pro PowerShell 5.0 a nižší se toto ovládá pomocí značek. Pro stolní počítače použijte značku PSEdition_Desktop a pro jádro použijte značku PSEdition_Core. U modulů navržených pro PowerShell 5.1 a novější je v manifestu klíč CompatiblePSEditions . Další informace najdete v tématu Podpora PSEdition pro moduly.
Historie verzí – Zobrazuje seznam verzí modulu, které byly publikovány v Galerii. Balíčky skryté pomocí funkce Odstranit se v historii verzí nezobrazují, pokud nejste vlastníkem balíčku.
Web projektu – Tyto informace pocházejí z klíčového
.PROJECTURIslova v metadatech souboru skriptu založených na komentářích.Licence – Tyto informace pocházejí z klíčového
.LICENSEURIslova v metadatech souboru skriptu založených na komentářích.Důležité
Pokud licence není poskytována prostřednictvím balíčku nebo
.LICENSEURIv rámci balíčku, vztahují se na něj podmínky použití pro Galerie prostředí PowerShell. Další informace naleznete v Podmínkách použití.Ikona – Tyto informace pocházejí z klíčového
.ICONURIslova v metadatech souboru skriptu založených na komentářích. Identifikátor URI by měl odkazovat na obrázek 85 × 85 s pozadím průhlednosti. Identifikátor URI musí být přímým odkazem na soubor obrázku a nesmí směřovat na webovou stránku nebo soubor v balíčku Galerie prostředí PowerShell.
Úprava podrobností balíčku
Stránka Galerie prostředí PowerShell Upravit balíček umožňuje vydavatelům změnit několik polí zobrazených pro balíček, konkrétně:
- Title
- Description
- Shrnutí
- Adresa URL ikony
- Adresa URL domovské stránky projektu
- Autoři
- Autorské právo
- Štítky
- Poznámky k vydání
- Vyžadovat licenci
Tyto informace v Galerii byste měli upravovat pouze za účelem opravy toho, co se zobrazuje u starších verzí modulu. Uživatelé, kteří si balíček stáhnou, uvidí, že metadata neodpovídají Galerie prostředí PowerShell. Pokaždé, když změníte informace v galerii, měli byste publikovat novou verzi balíčku se stejnými změnami.
Podrobnosti o značce
Tagy jsou jednoduché řetězce, které spotřebitelé používají k nalezení balíčků. Značky jsou nejcennější, pokud jsou používány konzistentně v souvisejících balíčcích. Použití variant stejného slova, například databáze a databáze nebo test a testování, poskytuje jen malý užitek. Tagy jsou řetězce, které nerozlišují velká a malá písmena a nemohou obsahovat mezery. Pokud existuje fráze, o které se domníváte, že ji uživatelé budou hledat, přidejte ji do popisu balíčku, aby ji bylo možné najít ve výsledcích hledání. Pro zlepšení čitelnosti používejte velká a malá písmena, pomlčky, podtržítka nebo tečky. Dávejte pozor na vytváření dlouhých, složitých a neobvyklých značek, které se snadno píší s pravopisnými chybami.
Galerie prostředí PowerShell a rutiny PowerShellGet mají zvláštní význam pro PSEdition_Desktop značky a PSEdition_Core . Podívejte se na předchozí diskuzi o edicích PowerShellu.
Jak již bylo zmíněno dříve, značky poskytují největší hodnotu, pokud jsou specifické a používají se konzistentně v mnoha balíčcích. Jako vydavatel, který se snaží najít nejlepší značky, které chcete použít, je nejjednodušším přístupem vyhledat v Galerie prostředí PowerShell značky, které zvažujete. V ideálním případě jsou vrácené balíčky v souladu s použitím daného klíčového slova.
V následující tabulce jsou uvedeny některé z nejčastěji používaných značek. Preferovaná značka by měla vracet nejlepší výsledky vyhledávání.
| Preferovaná značka | Alternativy a poznámky |
|---|---|
| Active Directory | Služba AD se v současné době sama o sobě nepoužívá |
| Appveyor | |
| Automation | |
| AWS | |
| Azure | |
| Využití služby AzureAD | |
| AzureAutomation | |
| AzureRm | Používá se především pro moduly AzureRM |
| Backup | |
| Build | |
| ChatOps | |
| Cloud | |
| Barva | |
| Konfigurace | |
| CrescendoBuilt | Tato značka je automaticky přidána nástrojem Crescendo při exportu modulu |
| Databáze | Databáze (množné číslo) jsou méně žádoucí |
| DBA | |
| Nasazení | Nasazení se používá o něco méně často |
| DevOps | |
| DNS | |
| Docker | |
| DSC | DesiredStateConfiguration je méně žádoucí, je příliš dlouhá |
| DSCResource | |
| Sada DSCResourceKit | |
| Excel | |
| Výměna | |
| Firewall | |
| LOTR | |
| GitHub | |
| Gitlab | |
| jazyk HTML | |
| Hyper-V | HyperV je méně častý jako tag |
| IaaS | |
| služba IIS | |
| Json | |
| Operační systém Linux | |
| Log | Preferované použití logu jako věci |
| Logování | Upřednostňované použití protokolování jako akce |
| MacOS | |
| Monitorování | |
| MSI | |
| Síť | Networking je na tom podobně, ale méně často se používá |
| Office365 | Vhodnější je hláskovat Office. O365 se používá méně často, i když kratší |
| Správa balíčků | |
| Otravovat | |
| PoshBot | |
| Zpráva | Zpráva je věc |
| Reportování | Reporting je akce, report je věc |
| ResourceManager | "Arm" se používá k popisu skupiny procesorů a neměl by se používat pro Azure Resource Manager |
| REST | |
| Zabezpečení | Obrana je méně přesná |
| Služba SharePoint | |
| SQL | |
| SQLServer | |
| Storage | |
| Test | Testování je méně žádoucí |
| Správa verzí | Verze je méně přesná, i když se používá častěji |
| VSTS | |
| Windows | |
| WinRM | |
| rozhraní WMI | |
| ZIP |
Spolupracujte s námi na GitHubu
Zdroj tohoto obsahu najdete na GitHubu, kde můžete také vytvářet a kontrolovat problémy a žádosti o přijetí změn. Další informace najdete v našem průvodci pro přispěvatele.
PowerShell Gallery