PowerShell Galerisi kullanıcı arabirimini etkileyen paket meta veri değerleri

  • Makale

Bu makalede, paketlerinizdeki meta verilerin PowerShell Galerisi tarafından nasıl kullanıldığı açıklanmaktadır. Modüller için meta veriler modül bildiriminde depolanır. Betikler için meta veriler açıklama tabanlı anahtar sözcükler kullanılarak depolanır. Bu meta verileri oluşturmak veya güncelleştirmek için aşağıdaki cmdlet'ler kullanılır:

Aşağıdaki listede, modül bildirimi tarafından denetlenen PowerShell Galerisi paket sayfası kullanıcı arabiriminin öğeleri gösterilir.

  • Title - Galeri'de yayımlanan paketin adı.

  • Sürüm - Görüntülenen sürüm, meta verilerdeki sürüm dizesidir ve belirtilirse yayın öncesi etiketidir. Belirtilen ön sürüm dizesi ModuleVersion'a eklenir. Modüllerdeki yayın öncesi dizeler hakkında bilgi için bkz. Yayın Öncesi Modül Sürümleri.

  • Açıklama - Bu, modül bildirimindeki Açıklama'dır .

  • Lisans kabulü gerektir - Modül, ayarlayıp RequireLicenseAcceptance = $truebir LicenseURI sağlayarak ve modül klasörünün kökünde bir license.txt dosya sağlayarak kullanıcının lisans kabul etmesini gerektirebilir. Daha fazla bilgi için bkz . Lisans Kabulü Gerektirme.

  • Sürüm notları - Bu bilgiler, altındaki PSData\PrivateDataReleaseNotes bölümünden gelir.

  • Sahipler - Sahipler, PowerShell Galerisi bir paketi güncelleştirebilen kullanıcıların listesidir. Paket bildirimine sahip listesi dahil değildir. Ek belgeler , öğe sahiplerinin nasıl yönetileceğini açıklar.

  • Yazar - Bu, modül bildiriminde Yazar olarak yer alır. Yazar alanı genellikle bir paketle ilişkilendirilmiş bir şirketi veya kuruluşu belirtmek için kullanılır.

  • Telif Hakkı - Bu, modül bildirimindeki Telif Hakkı alanıdır.

  • FileList - Dosya listesi, paket PowerShell Galerisi yayımlandığında oluşturulur. Bildirim bilgileri tarafından denetlenemez. PowerShell Galerisi, her paketin dosya listesinde görünen bir dosya oluşturur.nuspec. Bu dosya bir sistemdeki paketle birlikte yüklenmez. Bu, paketin NuGet paket bildirimidir ve yoksayılabilir.

  • Etiketler - Etiketler modül bildiriminin altında PrivateData\PSData yer alır. Etiketlerin, Etiket Ayrıntıları bölümünde açıklanan belirli gereksinimleri ve anlamları vardır .

  • Cmdlet'ler - Bu, CmdletsToExport kullanılarak modül bildiriminde sağlanır. joker karakteri kullanmak yerine cmdlet adlarını açıkça listelemek en iyi yöntemdir *. Listenin olması, yük modülü performansını artırır.

  • İşlevler - Bu, FunctionsToExport kullanılarak modül bildiriminde sağlanır. joker karakteri kullanmak yerine cmdlet adlarını açıkça listelemek en iyi yöntemdir *. Listenin olması, yük modülü performansını artırır.

  • DSC Kaynakları - Bu, DscResourcesToExport kullanılarak bildirimde sağlanır. Bu değer yalnızca PowerShell 5.0 ve sonraki sürümlerdeki modüller için desteklenir.

  • Rol özellikleri - Modülde bir veya daha fazla rol özelliği (.psrc) dosyası olduğunda roller listelenir. Bu dosyalar JEA tarafından kullanılır. Daha fazla bilgi için bkz. rol özellikleri.

  • PowerShell Sürümleri - PowerShell 5.0 ve daha düşük sürümler için tasarlanmış modüller için bu, Etiketler kullanılarak denetlenmektedir. Masaüstü için PSEdition_Desktop etiketini kullanın ve çekirdek için PSEdition_Core etiketini kullanın. PowerShell 5.1 ve üzeri için tasarlanmış modüller için bildirimde CompatiblePSEditions anahtarı vardır. Daha fazla bilgi için bkz. Modüller için PSEdition desteği.

  • Bağımlılıklar - Bu bildirimde RequiredModules kullanılarak sağlanır.

  • En düşük PowerShell sürümü - Bu, Bildirimde PowerShellVersion kullanılarak sağlanır.

  • Sürüm Geçmişi - Modülün Galeri'de yayımlanmış sürümlerinin listesini gösterir. Sil özelliği kullanılarak gizlenen paketler, paket sahibi olmadığınız sürece sürüm geçmişinde görüntülenmez.

  • Proje Sitesi - Proje sitesi, bir ProjectURI belirterek modül bildiriminin bölümündeki modüller PrivateData\PSData için sağlanır.

  • Lisans - Bir LisansURI'si belirterek modül bildiriminin bölümündeki modüller PrivateData\PSData için bir lisans bağlantısı sağlanır.

    Önemli

    Lisans, LicenseURI aracılığıyla veya paket içinde sağlanmazsa, PowerShell Galerisi kullanım koşulları paket için geçerlidir. Daha fazla bilgi için bkz . Kullanım Koşulları.

  • Icon - Bir IconURI belirterek modül bildiriminin PrivateData\PSData bölümündeki modüller için bir bağlantı sağlanır. URI, saydamlık arka planına sahip bir 85x85 görüntüsüne işaret etmelidir. URI, görüntü dosyasının doğrudan bağlantısı olmalıdır ve web sayfasına veya PowerShell Galerisi paketindeki bir dosyaya gitmemelidir.

Aşağıdaki listede, bir betik dosyasındaki açıklama tabanlı meta veriler tarafından denetlenen PowerShell Galerisi paket sayfası kullanıcı arabiriminin öğeleri gösterilir.

  • Başlık - Bu, Galeri'de yayımlanan paketin adıdır

  • Sürüm - Görüntülenen sürüm, meta verilerdeki sürüm dizesidir ve belirtilirse yayın öncesi etiketidir. Değer, meta veri açıklama bloğundaki anahtar sözcüğünden .VERSION gelir. Yayın öncesi betiği yayımlarken sürüme yayın öncesi dizesini ekleyin. Modüllerde yayın öncesi dizeleri belirtme hakkında bilgi için bkz. Betiklerin yayın öncesi sürümleri.

  • Açıklama - Bu bilgiler, bir betik dosyasının açıklama tabanlı yardımındaki anahtar sözcüğünden .DESCRIPTION gelir.

  • Lisans kabulü gerektir - Betikler için Lisans Kabulü desteklenmez. Ancak, bir betiğin lisans kabulü gerektiren bir modüle bağımlı olduğu senaryo desteklenir. Daha fazla bilgi için bkz . Betikler için lisans kabulü gerektirme.

  • Sürüm notları - Bu bilgiler, bir betik dosyasının açıklama tabanlı meta verilerindeki anahtar sözcüğünden .RELEASENOTES gelir.

  • Sahipler - Sahipler, PowerShell Galerisi bir paketi güncelleştirebilen kullanıcıların listesidir. Paket bildirimine sahip listesi dahil değildir. Daha fazla bilgi için bkz . Öğe sahiplerini yönetme.

  • Author - Bu bilgiler, bir betik dosyasının açıklama tabanlı meta verilerindeki anahtar sözcüğünden .AUTHOR gelir. Yazar alanı genellikle bir paketle ilişkilendirilmiş bir şirketi veya kuruluşu belirtmek için kullanılır.

  • Telif Hakkı - Bu bilgiler, bir betik dosyasının .COPYRIGHT açıklama tabanlı meta verilerindeki anahtar sözcüğünden gelir.

  • FileList - Dosya listesi, paket PowerShell Galerisi yayımlandığında oluşturulur. Bildirim bilgileri tarafından denetlenemez. PowerShell Galerisi, her paketin dosya listesinde görünen bir dosya oluşturur.nuspec. Bu dosya bir sistemdeki paketle birlikte yüklenmez. Bu, paketin NuGet paket bildirimidir ve yoksayılabilir.

  • Etiketler - *Bu bilgiler, bir betik dosyasının .TAGS açıklama tabanlı meta verilerindeki anahtar sözcüğünden gelir. Etiketlerin, Etiket Ayrıntıları bölümünde açıklanan belirli gereksinimleri ve anlamları vardır .

  • PowerShell Sürümleri - PowerShell 5.0 ve daha düşük sürümler için tasarlanmış modüller için bu, Etiketler kullanılarak denetlenmektedir. Masaüstü için PSEdition_Desktop etiketini kullanın ve çekirdek için PSEdition_Core etiketini kullanın. PowerShell 5.1 ve üzeri için tasarlanmış modüller için bildirimde CompatiblePSEditions anahtarı vardır. Daha fazla bilgi için bkz. Modüller için PSEdition desteği.

  • Sürüm Geçmişi - Modülün Galeri'de yayımlanmış sürümlerinin listesini gösterir. Sil özelliği kullanılarak gizlenen paketler, paket sahibi olmadığınız sürece sürüm geçmişinde görüntülenmez.

  • Proje Sitesi - Bu bilgiler, bir betik dosyasının açıklama tabanlı meta verilerindeki anahtar sözcüğünden .PROJECTURI gelir.

  • Lisans - Bu bilgiler, bir betik dosyasının açıklama tabanlı meta verilerindeki anahtar sözcüğünden .LICENSEURI gelir.

    Önemli

    Lisans veya paketin .LICENSEURI içinde sağlanmazsa, PowerShell Galerisi için Kullanım Koşulları pakete uygulanır. Daha fazla bilgi için bkz . Kullanım Koşulları.

  • Icon - Bu bilgiler, bir betik dosyasının açıklama tabanlı meta verilerindeki anahtar sözcüğünden .ICONURI gelir. URI, saydamlık arka planına sahip bir 85x85 görüntüsüne işaret etmelidir. URI, görüntü dosyasının doğrudan bağlantısı olmalıdır ve web sayfasına veya PowerShell Galerisi paketindeki bir dosyaya gitmemelidir.

Paket ayrıntılarını düzenleme

PowerShell Galerisi Paketi düzenle sayfası, yayımcıların özellikle bir paket için görüntülenen alanlardan birkaçını değiştirmesine olanak tanır:

  • Başlık
  • Açıklama
  • Özet
  • Simge URL'si
  • Proje giriş sayfası URL'si
  • Yazarlar
  • Telif Hakkı
  • Etiketler
  • Sürüm notları
  • Lisans gerektir

Bu bilgileri yalnızca modülün eski bir sürümünde görüntülenenleri düzeltmek için Galeri'de düzenlemeniz gerekir. Paketi indiren kullanıcılar meta verilerin PowerShell Galerisi eşleşmediğini görür. Galerideki bilgileri her değiştirdiğinizde, aynı değişikliklerle paketin yeni bir sürümünü yayımlamanız gerekir.

Etiket ayrıntıları

Etiketler, tüketicilerin paketleri bulmak için kullandığı basit dizelerdir. Etiketler en çok ilgili paketler arasında tutarlı olarak kullanıldığında değerlidir. Veritabanı ve veritabanları ya da test ve test gibi aynı sözcüğün çeşitlemelerini kullanmak çok az avantaj sağlar. Etiketler tek sözcüklü büyük/küçük harfe duyarlı olmayan dizelerdir ve boşluk içeremez. Kullanıcıların arama yapacağına inandığınız bir tümcecik varsa, arama sonuçlarında bulunabilmesi için bunu paket açıklamasına ekleyin. Okunabilirliği geliştirmek için Pascal büyük/küçük harf, kısa çizgi, alt çizgi veya nokta kullanın. Kolayca yanlış yazılan uzun, karmaşık ve olağan dışı etiketler oluştururken dikkatli olun.

PowerShell Galerisi ve PowerShellGet cmdlet'leri ve PSEdition_Core etiketleri için PSEdition_Desktop özel anlamlara sahiptir. PowerShell Sürümleri'nin önceki tartışmalarına bakın.

Daha önce belirtildiği gibi etiketler belirli olduklarında en fazla değeri sağlar ve birçok pakette tutarlı olarak kullanılır. Kullanılacak en iyi etiketleri bulmaya çalışan bir yayımcı olarak en kolay yaklaşım, PowerShell Galerisi düşündüğünüz etiketleri aramaktır. İdeal olan, döndürülen paketlerin bu anahtar sözcüğü kullanımınızla uyumlu olmasıdır.

Aşağıdaki tabloda en yaygın kullanılan etiketlerden bazıları gösterilmektedir. Tercih edilen etiket en iyi arama sonuçlarını döndürmelidir.

Tercih edilen etiket Alternatifler ve notlar
ActiveDirectory AD şu anda tek başına kullanılmıyor
Appveyor
Otomasyon
AWS
Azure
AzureAD
AzureAutomation
AzureRm Öncelikli olarak AzureRM modülleri için kullanılır
Backup
Oluşturma
ChatOps
Bulut
Renk
Yapılandırma
CrescendoBuilt Bu etiket, modülü dışarı aktardığınızda Crescendo tarafından otomatik olarak eklenir
Veritabanı Veritabanları (çoğul) daha az tercih edilir
DBA
Dağıtım Dağıtım biraz daha az sıklıkla kullanılır
DevOps
DNS
Docker
DSC DesiredStateConfiguration daha az tercih edilir, çok uzun
DSCResource
DSCResourceKit
Excel
Exchange
Güvenlik Duvarı
GIT
GitHub
Gitlab
Google
HTML
Hyper-V HyperV etiket olarak daha az yaygındır
IaaS
IIS
Json
Linux
Günlük Log'un bir şey olarak tercih edilen kullanımı
Günlüğe Kaydetme Günlük kaydının eylem olarak tercih edilen kullanımı
macOS
İzleme
MSI
Ağ Ağ benzerdir, daha az kullanılır
Office365 Office'in yazımını yazma tercih edilir. O365 daha az yaygın olarak kullanılır, ancak daha kısadır
PackageManagement
Rahatsız
PoshBot
Rapor Rapor bir şeydir
Raporlama Raporlama bir eylemdir, rapor bir şeydir
Resourcemanager "Arm" işlemci grubunu açıklamak için kullanılır ve Azure Resource Manager için kullanılmamalıdır
REST
Güvenlik Savunma daha az kesindir
SharePoint
SQL
Sqlserver
Depolama
Test etme Test daha az tercih edilir
Versioncontrol Sürüm daha az kesindir ancak daha sık kullanılır
VSTS
Windows
WinRM
WMI
Zip