Share via

A PowerShell-galéria felhasználói felületére hatással lévő metaadat-értékek csomagolása

  • Cikk

Ez a cikk azt ismerteti, hogy a csomagok metaadatait hogyan használja a PowerShell-galéria. A modulok esetében a metaadatok a moduljegyzékben tárolódnak. Szkriptek esetén a metaadatok megjegyzésalapú kulcsszavak használatával tárolódnak. A metaadatok létrehozásához vagy frissítéséhez a következő parancsmagok használhatók:

Az alábbi lista a PowerShell-galéria csomagoldal felhasználói felületének azon elemeit mutatja be, amelyeket a modul jegyzékfájlja vezérel.

  • Cím – A katalógusban közzétett csomag neve.

  • Verzió – A megjelenített verzió a metaadatokban szereplő verziósztring, ha meg van adva egy előzetes címke. A megadott prerelease sztring hozzá lesz fűzve a ModuleVersion elemhez. További információ a modulok előzetes sztringjeiről: Előzetes modulverziók.

  • Leírás – Ez a moduljegyzékben szereplő leírás .

  • Licenc elfogadásának megkövetelése – Egy modul megkövetelheti, hogy a felhasználó elfogadjon egy licencet a beállítással RequireLicenseAcceptance = $true, adjon meg egy LicenseURI-t, és adjon meg egy license.txt fájlt a modulmappa gyökerében. További információ: A licenc elfogadásának megkövetelése.

  • Kibocsátási megjegyzések – Ezek az információk a ReleaseNotes szakaszból származnak, a alatt PSData\PrivateData.

  • Tulajdonosok – A tulajdonosok azon felhasználók listája a PowerShell-galéria, akik frissíthetik a csomagokat. A tulajdonoslista nem szerepel a csomagjegyzékben. További dokumentáció ismerteti az elemtulajdonosok kezelését.

  • Szerző – Ez a moduljegyzékben Szerzőként szerepel. A Szerző mezőt gyakran használják egy csomaghoz társított vállalat vagy szervezet megadására.

  • Copyright – Ez a moduljegyzék Szerzői jogi mezője.

  • FileList – A fájllista akkor jön létre, amikor a csomagot közzéteszik a PowerShell-galéria. A jegyzékadatok nem szabályozhatják. A PowerShell-galéria létrehoz egy .nuspec fájlt, amely megjelenik az egyes csomagok fájllistájában. Ez a fájl nincs telepítve a csomaggal egy rendszeren. Ez a csomag NuGet-csomagjegyzéke, amely figyelmen kívül hagyható.

  • Címkék - A címkéket a moduljegyzék tartalmazza PrivateData\PSData . A címkék a Címke részletei szakaszban leírt követelményekkel és jelentésekkel rendelkeznek.

  • Parancsmagok – Ezt a parancsmagokToExport parancsmagok használatával adja meg a moduljegyzékben. Ajánlott a parancsmagok neveit explicit módon listázni, nem pedig helyettesítő karaktert *használni. A lista használata javítja a terhelésmodul teljesítményét.

  • Functions – Ezt a moduljegyzék tartalmazza a FunctionsToExport használatával. Ajánlott a parancsmagok neveit explicit módon listázni, nem pedig helyettesítő karaktert *használni. A lista használata javítja a terhelésmodul teljesítményét.

  • DSC-erőforrások – Ez a jegyzékfájlban található a DscResourcesToExport használatával. Ez az érték csak a PowerShell 5.0-s és újabb verzióiban támogatott.

  • Szerepkör-képességek – A szerepkörök akkor jelennek meg, ha a modul egy vagy több szerepkörképességi fájllal (.psrc) rendelkezik. Ezeket a fájlokat a JEA használja. További információkért lásd a szerepkörök képességeit ismertető cikket.

  • PowerShell-kiadások – A PowerShell 5.0-s és újabb verziójához tervezett modulok esetében ez címkékkel vezérelhető. Asztali verzió esetén használja az PSEdition_Desktop címkét, a core esetében pedig használja a PSEdition_Core címkét. A PowerShell 5.1-hez és újabb verziókhoz tervezett modulok esetében a jegyzékfájlban található egy CompatiblePSEditions kulcs. További információ: PSEdition-támogatás modulokhoz.

  • Függőségek – Ezt a jegyzékfájl a RequiredModules használatával adja meg.

  • A PowerShell minimális verziója – Ezt a PowerShellVersion használatával adja meg a jegyzékfájl.

  • Verzióelőzmények – A modul katalógusban közzétett verzióinak listáját jeleníti meg. A Törlés funkcióval rejtett csomagok csak akkor jelennek meg a verzióelőzményekben, ha Ön csomagtulajdonos.

  • Projektwebhely – A projektwebhely a moduljegyzék szakaszában PrivateData\PSData található modulokhoz van megadva egy ProjectURI megadásával.

  • Licenc – A moduljegyzék szakaszában PrivateData\PSData licenchivatkozás található a modulokhoz egy LicenseURI megadásával.

    Fontos

    Ha a licenc nem a LicenseURI-on vagy a csomagon belül van megadva, akkor a PowerShell-galéria használati feltételei érvényesek a csomagra. További információkért lásd a használati feltételeket.

  • Icon – A moduljegyzék szakaszában PrivateData\PSData található modulokra mutató hivatkozás egy IconURI megadásával érhető el. Az URI-nak egy átlátszó háttérrel rendelkező, 85x85-ös képre kell mutatnia. Az URI-nak a képfájlra mutató közvetlen hivatkozásnak kell lennie, és nem szabad weblapra vagy fájlra lépnie a PowerShell-galéria csomagban.

Az alábbi lista a PowerShell-galéria csomagoldal felhasználói felületének azon elemeit mutatja be, amelyeket egy szkriptfájl megjegyzésalapú metaadatai vezérelnek.

  • Cím – Ez a katalógusban közzétett csomag neve

  • Verzió – A megjelenített verzió a metaadatokban szereplő verziósztring, ha meg van adva egy előzetes címke. Az érték a .VERSION metaadat-megjegyzés blokkban található kulcsszóból származik. A prerelease szkript közzétételekor fűzze hozzá a prerelease sztringet a verzióhoz. További információ a modulok előzetes sztringjeinek megadásáról: Szkriptek előzetes verziói.

  • Leírás – Ez az információ egy .DESCRIPTION szkriptfájl megjegyzésalapú súgójában található kulcsszóból származik.

  • Licenc elfogadásának megkövetelése – A szkriptek nem támogatják a licenc elfogadását. Támogatott azonban az a forgatókönyv, amelyben egy szkript egy licencelfogadást igénylő modultól függ. További információ: A szkriptek licencelfogadásának megkövetelése.

  • Kibocsátási megjegyzések – Ezek az információk egy .RELEASENOTES szkriptfájl megjegyzésalapú metaadataiban szereplő kulcsszóból származnak.

  • Tulajdonosok – A tulajdonosok azon felhasználók listája a PowerShell-galéria, akik frissíthetik a csomagokat. A tulajdonoslista nem szerepel a csomagjegyzékben. További információ: Az elemtulajdonosok kezelése.

  • Szerző – Ez az információ egy .AUTHOR szkriptfájl megjegyzésalapú metaadatainak kulcsszójából származik. A Szerző mezőt gyakran használják egy csomaghoz társított vállalat vagy szervezet megadására.

  • Copyright – Ez az információ egy .COPYRIGHT szkriptfájl megjegyzésalapú metaadataiban szereplő kulcsszóból származik.

  • FileList – A fájllista akkor jön létre, amikor a csomagot közzéteszik a PowerShell-galéria. A jegyzékadatok nem szabályozhatják. A PowerShell-galéria létrehoz egy .nuspec fájlt, amely megjelenik az egyes csomagok fájllistájában. Ez a fájl nincs telepítve a csomaggal egy rendszeren. Ez a csomag NuGet-csomagjegyzéke, amely figyelmen kívül hagyható.

  • Címkék – *Ez az információ egy .TAGS szkriptfájl megjegyzésalapú metaadatainak kulcsszójából származik. A címkék a Címke részletei szakaszban leírt követelményekkel és jelentésekkel rendelkeznek.

  • PowerShell-kiadások – A PowerShell 5.0-s és újabb verziójához tervezett modulok esetében ez címkékkel vezérelhető. Asztali verzió esetén használja az PSEdition_Desktop címkét, a core esetében pedig használja a PSEdition_Core címkét. A PowerShell 5.1-hez és újabb verziókhoz tervezett modulok esetében a jegyzékfájlban található egy CompatiblePSEditions kulcs. További információ: PSEdition-támogatás modulokhoz.

  • Verzióelőzmények – A modul katalógusban közzétett verzióinak listáját jeleníti meg. A Törlés funkcióval rejtett csomagok csak akkor jelennek meg a verzióelőzményekben, ha Ön csomagtulajdonos.

  • Projektwebhely – Ez az információ egy .PROJECTURI szkriptfájl megjegyzésalapú metaadataiban szereplő kulcsszóból származik.

  • Licenc – Ez az információ egy .LICENSEURI szkriptfájl megjegyzésalapú metaadataiban szereplő kulcsszóból származik.

    Fontos

    Ha a licenc nem a .LICENSEURI csomagon vagy a csomagon belül van megadva, akkor a PowerShell-galéria használati feltételei érvényesek a csomagra. További információkért lásd a használati feltételeket.

  • Ikon – Ez az információ egy .ICONURI szkriptfájl megjegyzésalapú metaadataiban szereplő kulcsszóból származik. Az URI-nak egy átlátszó háttérrel rendelkező, 85x85-ös képre kell mutatnia. Az URI-nak a képfájlra mutató közvetlen hivatkozásnak kell lennie, és nem szabad weblapra vagy fájlra lépnie a PowerShell-galéria csomagban.

Csomag részleteinek szerkesztése

A PowerShell-galéria Csomag szerkesztése lapon a közzétevők módosíthatják a csomaghoz megjelenített mezőket, különösen a következőket:

  • Cím
  • Leírás
  • Összefoglalás
  • Ikon URL-címe
  • Projekt kezdőlapja URL-címe
  • Szerzők
  • Szerzői jog
  • Címkék
  • Kibocsátási megjegyzések
  • Licenc megkövetelése

Ezeket az információkat csak a katalógusban kell szerkesztenie, hogy kijavítsa a modul egy régebbi verziójának tartalmát. A csomagot letöltő felhasználók látni fogják, hogy a metaadatok nem egyeznek a PowerShell-galéria. A katalógusban lévő információk módosításakor mindig közzé kell tennie a csomag új verzióját ugyanazokkal a módosításokkal.

Címke részletei

A címkék egyszerű sztringek, amelyeket a fogyasztók a csomagok kereséséhez használnak. A címkék akkor a legértékesebbek, ha következetesen használják őket a kapcsolódó csomagokban. Ha ugyanazt a szót használja, például adatbázisokat és adatbázisokat, vagy teszteli és teszteli, kevés előnnyel jár. A címkék egyszavas kis- és nagybetűket nem megkülönböztető sztringek, és nem tartalmazhatnak üres elemet. Ha van olyan kifejezés, amelyet úgy gondol, hogy a felhasználók keresni fognak, adja hozzá a csomag leírásához, hogy az megtalálható legyen a keresési eredmények között. Pascal-burkolat, kötőjelek, aláhúzásjelek vagy pontok használatával javíthatja az olvashatóságot. Legyen óvatos, ha olyan hosszú, összetett és szokatlan címkéket hoz létre, amelyek könnyen elgépelhetők.

A PowerShell-galéria és a PowerShellGet-parancsmagok speciális jelentéssel rendelkeznek a és PSEdition_Core a PSEdition_Desktop címkéhez. Tekintse meg a PowerShell-kiadások előző ismertetését.

Ahogy korábban említettük, a címkék adják meg a legtöbb értéket, ha konkrétak, és következetesen használják őket számos csomagban. A legjobban használható címkéket kereső közzétevőként a legegyszerűbb módszer az, ha megkeresi a PowerShell-galéria a megfontolandó címkéket. Ideális esetben a visszaadott csomagok igazodnak az adott kulcsszó használatához.

Az alábbi táblázat a leggyakrabban használt címkék némelyikét mutatja be. Az előnyben részesített címkének a legjobb keresési eredményeket kell visszaadnia.

Előnyben részesített címke Alternatívák és megjegyzések
ActiveDirectory Az AD jelenleg nem önmagában van használatban
Appveyor
Automation
AWS
Azure
AzureAD
AzureAutomation
AzureRm Elsősorban az AzureRM-modulokhoz használatos
Backup
Build
ChatOps
Felhőbeli
Szín
Konfiguráció
CrescendoBuilt Ezt a címkét a Crescendo automatikusan hozzáadja a modul exportálásakor
Adatbázis Az adatbázisok (többes szám) kevésbé kívánatosak
DBA
Üzembe helyezés Az üzembe helyezést valamivel ritkábban használják
DevOps
DNS
Docker
DSC DesiredStateConfiguration kevésbé kívánatos, túl hosszú
DSCResource
DSCResourceKit
Excel
Exchange
Firewall
GIT
GitHub
Gitlab
Google
HTML
Hyper-V A HyperV ritkábban fordul elő címkeként
IaaS
IIS
JSON
Linux
Napló A Napló előnyben részesített használata dologként
Naplózás A naplózás előnyben részesített használata műveletként
MacOS
Figyelés
MSI
Network (Hálózat) A hálózatkezelés hasonló, ritkábban használják
Office365 Az Office helyesírása előnyösebb. Az O365-öt ritkábban használják, bár rövidebb
PackageManagement
Pester
PoshBot
Jelentés A jelentés egy dolog
Jelentéskészítés A jelentéskészítés művelet, a jelentés egy dolog
ResourceManager Az "Arm" a processzorok csoportjának leírására szolgál, és nem használható az Azure Resource Manager
REST
Biztonság A védelem kevésbé pontos
SharePoint
SQL
SQLServer
Tárolás
Teszt A tesztelés kevésbé kívánatos
VersionControl A verzió kevésbé pontos, bár gyakrabban használják
VSTS
Windows
WinRM
WMI
Irányítószám