Valori dei metadati del pacchetto che influisce sull'interfaccia utente di PowerShell Gallery

  • Articolo

Questo articolo illustra come i metadati nei pacchetti vengono usati dal PowerShell Gallery. Per i moduli, i metadati vengono archiviati nel manifesto del modulo. Per gli script, i metadati vengono archiviati usando parole chiave basate su commenti. I cmdlet seguenti vengono usati per creare o aggiornare questi metadati:

L'elenco seguente mostra gli elementi dell'interfaccia utente della pagina del pacchetto PowerShell Gallery controllata dal manifesto del modulo.

  • Title : nome del pacchetto pubblicato nella raccolta.

  • Versione : la versione visualizzata è la stringa di versione nei metadati e un'etichetta di versione preliminare, se specificato. La stringa di versione non definitiva specificata viene aggiunta a ModuleVersion. Per informazioni sulle stringhe non definitive nei moduli, vedere Versioni dei moduli non definitive.

  • Descrizione : Descrizione nel manifesto del modulo.

  • Richiedi accettazione della licenza : un modulo può richiedere che l'utente accetti una licenza, impostando RequireLicenseAcceptance = $true, fornendo un URI licenza e fornendo un license.txt file nella radice della cartella del modulo. Per altre informazioni, vedere Richiedere l'accettazione della licenza.

  • Note sulla versione : queste informazioni provengono dalla sezione ReleaseNotes , in PSData\PrivateData.

  • Proprietari: i proprietari sono l'elenco di utenti nel PowerShell Gallery che possono aggiornare un pacchetto. L'elenco dei proprietari non è incluso nel manifesto del pacchetto. È disponibile documentazione aggiuntiva che descrive come gestire i proprietari degli elementi.

  • Autore : incluso nel manifesto del modulo come Autore. Il campo Author viene spesso usato per specificare una società o un'organizzazione associata a un pacchetto.

  • Copyright : questo è il campo Copyright nel manifesto del modulo.

  • FileList: l'elenco di file viene creato quando il pacchetto viene pubblicato nel PowerShell Gallery. Non è controllabile dalle informazioni sul manifesto. Il PowerShell Gallery crea .nuspec il file visualizzato nell'elenco di file di ogni pacchetto. Questo file non è installato con il pacchetto in un sistema. Si tratta del manifesto del pacchetto NuGet per il pacchetto e può essere ignorato.

  • Tag - I tag sono inclusi PrivateData\PSData nel manifesto del modulo. I tag hanno requisiti e significati specifici descritti nella sezione Dettagli tag .

  • Cmdlet: viene fornito nel manifesto del modulo usando CmdletsToExport. È consigliabile elencare in modo esplicito i nomi dei cmdlet anziché usare il carattere jolly *. La presenza di un elenco migliora le prestazioni del modulo di caricamento.

  • Funzioni : disponibile nel manifesto del modulo tramite FunctionsToExport. È consigliabile elencare in modo esplicito i nomi dei cmdlet anziché usare il carattere jolly *. La presenza di un elenco migliora le prestazioni del modulo di caricamento.

  • Risorse DSC : viene fornito nel manifesto usando DscResourcesToExport. Questo valore è supportato solo per i moduli in PowerShell 5.0 e versioni successive.

  • Funzionalità del ruolo : i ruoli vengono elencati quando il modulo ha uno o più file di funzionalità del ruolo (.psrc). Questi file vengono usati da JEA. Per altre informazioni, vedere Funzionalità del ruolo.

  • Edizioni di PowerShell : per i moduli progettati per PowerShell 5.0 e versioni precedenti, questo controllo viene controllato usando i tag. Per l'edizione Desktop usare il tag PSEdition_Desktop e per l'edizione Core usare il tag PSEdition_Core. Per i moduli progettati per PowerShell 5.1 e versioni successive, è presente una chiave CompatiblePSEditions nel manifesto. Per altre informazioni, vedere Supporto di PSEdition per i moduli.

  • Dipendenze : viene fornito nel manifesto usando RequiredModules.

  • Versione minima di PowerShell : disponibile nel manifesto usando PowerShellVersion.

  • Cronologia versioni : mostra un elenco di versioni del modulo pubblicate nella raccolta. I pacchetti nascosti tramite la funzionalità Elimina non vengono visualizzati nella cronologia delle versioni, a meno che non si sia un proprietario del pacchetto.

  • Sito di progetto: il sito di progetto viene fornito per i PrivateData\PSData moduli nella sezione del manifesto del modulo specificando un ProjectURI.

  • Licenza: viene fornito un collegamento di licenza per i PrivateData\PSData moduli nella sezione del manifesto del modulo specificando un URI licenza.

    Importante

    Se una licenza non viene fornita tramite l'URI licenza o all'interno del pacchetto, le condizioni per l'utilizzo per il PowerShell Gallery si applicano al pacchetto. Per altre informazioni, vedere le Condizioni per l'utilizzo.

  • Icona : viene fornito un collegamento per i PrivateData\PSData moduli nella sezione del manifesto del modulo specificando un IconURI. L'URI deve puntare a un'immagine 85x85 con sfondo trasparente. L'URI deve essere un collegamento diretto al file di immagine e non deve passare a una pagina Web o a un file nel pacchetto PowerShell Gallery.

L'elenco seguente mostra gli elementi dell'interfaccia utente della pagina del pacchetto PowerShell Gallery controllata dai metadati basati su commenti in un file di script.

  • Titolo : nome del pacchetto pubblicato nella raccolta

  • Versione : la versione visualizzata è la stringa di versione nei metadati e un'etichetta di versione preliminare, se specificato. Il valore deriva dalla .VERSION parola chiave nel blocco di commenti dei metadati. Quando si pubblica lo script non definitiva, aggiungere la stringa di versione non definitiva alla versione. Per informazioni sulla specifica delle stringhe non definitive nei moduli, vedere Versioni non definitive degli script.

  • Descrizione : queste informazioni provengono dalla .DESCRIPTION parola chiave nella Guida basata su commenti di un file di script.

  • Richiedi accettazione della licenza: l'accettazione della licenza non è supportata per gli script. Tuttavia, è supportato lo scenario in cui uno script dipende da un modulo che richiede l'accettazione della licenza. Per altre informazioni, vedere Richiedere l'accettazione della licenza per gli script.

  • Note sulla versione : queste informazioni provengono dalla .RELEASENOTES parola chiave nei metadati basati su commenti di un file di script.

  • Proprietari: i proprietari sono l'elenco di utenti nel PowerShell Gallery che possono aggiornare un pacchetto. L'elenco dei proprietari non è incluso nel manifesto del pacchetto. Per altre informazioni, vedere Gestire i proprietari degli elementi.

  • Autore : queste informazioni provengono dalla .AUTHOR parola chiave nei metadati basati su commenti di un file di script. Il campo Author viene spesso usato per specificare una società o un'organizzazione associata a un pacchetto.

  • Copyright : queste informazioni provengono dalla .COPYRIGHT parola chiave nei metadati basati su commenti di un file di script.

  • FileList: l'elenco di file viene creato quando il pacchetto viene pubblicato nel PowerShell Gallery. Non è controllabile dalle informazioni sul manifesto. Il PowerShell Gallery crea .nuspec il file visualizzato nell'elenco di file di ogni pacchetto. Questo file non è installato con il pacchetto in un sistema. Si tratta del manifesto del pacchetto NuGet per il pacchetto e può essere ignorato.

  • Tags : *Queste informazioni provengono dalla .TAGS parola chiave nei metadati basati su commenti di un file di script. I tag hanno requisiti e significati specifici descritti nella sezione Dettagli tag .

  • Edizioni di PowerShell : per i moduli progettati per PowerShell 5.0 e versioni precedenti, questo controllo viene controllato usando i tag. Per l'edizione Desktop usare il tag PSEdition_Desktop e per l'edizione Core usare il tag PSEdition_Core. Per i moduli progettati per PowerShell 5.1 e versioni successive, è presente una chiave CompatiblePSEditions nel manifesto. Per altre informazioni, vedere Supporto di PSEdition per i moduli.

  • Cronologia versioni : mostra un elenco di versioni del modulo pubblicate nella raccolta. I pacchetti nascosti tramite la funzionalità Elimina non vengono visualizzati nella cronologia delle versioni, a meno che non si sia un proprietario del pacchetto.

  • Sito di progetto : queste informazioni provengono dalla .PROJECTURI parola chiave nei metadati basati su commenti di un file di script.

  • Licenza: queste informazioni provengono dalla .LICENSEURI parola chiave nei metadati basati su commenti di un file di script.

    Importante

    Se una licenza non viene fornita tramite .LICENSEURI o all'interno del pacchetto, le Condizioni per l'utilizzo per il PowerShell Gallery si applicano al pacchetto. Per altre informazioni, vedere le Condizioni per l'utilizzo.

  • Icona : queste informazioni provengono dalla .ICONURI parola chiave nei metadati basati su commenti di un file di script. L'URI deve puntare a un'immagine 85x85 con sfondo trasparente. L'URI deve essere un collegamento diretto al file di immagine e non deve passare a una pagina Web o a un file nel pacchetto PowerShell Gallery.

Modifica dei dettagli del pacchetto

La pagina Modifica pacchetto di PowerShell Gallery consente agli editori di modificare vari campi visualizzati per un pacchetto, in particolare:

  • Titolo
  • Descrizione
  • Summary
  • URL dell'icona
  • URL della pagina iniziale del progetto
  • Autori
  • Copyright
  • Tag
  • Note sulla versione
  • Richiesta della licenza

È consigliabile modificare queste informazioni solo nella raccolta per correggere gli elementi visualizzati per una versione precedente di un modulo. Gli utenti che scaricano il pacchetto vedranno che i metadati non corrispondono al PowerShell Gallery. Ogni volta che si modificano le informazioni nella raccolta, è necessario pubblicare una nuova versione del pacchetto con le stesse modifiche.

Dettagli tag

I tag sono semplici consumer di stringhe usati per trovare i pacchetti. I tag sono più utili quando vengono usati in modo coerente nei pacchetti correlati. L'uso di varianti della stessa parola, ad esempio database e database o test e test, offre un vantaggio minimo. I tag sono stringhe senza distinzione tra maiuscole e minuscole e non possono includere spazi vuoti. Se c'è una frase che si ritiene che gli utenti cercheranno, aggiungerlo alla descrizione del pacchetto in modo che possa essere trovato nei risultati della ricerca. Usare maiuscole e minuscole Pascal, trattini, caratteri di sottolineatura o punti per migliorare la leggibilità. Prestare attenzione alla creazione di tag lunghi, complessi e insoliti che sono facilmente digitati in modo errato.

I cmdlet PowerShell Gallery e PowerShellGet hanno significati speciali per i PSEdition_Desktop tag e PSEdition_Core . Vedere la discussione precedente sulle edizioni di PowerShell.

Come indicato in precedenza, i tag forniscono il maggior valore quando sono specifici e usati in modo coerente in molti pacchetti. Per un editore che cerca di individuare i tag migliori da usare, il modo più semplice consiste nel cercare i tag che si stanno valutando in PowerShell Gallery. Idealmente, i pacchetti restituiti sono allineati all'uso di tale parola chiave.

La tabella seguente illustra alcuni dei tag usati più di frequente. Il tag preferito deve restituire i risultati della ricerca migliori.

Tag preferito Alternative e note
ActiveDirectory Ad non è attualmente usato da solo
Appveyor
Automazione
AWS
Azure
AzureAD
AzureAutomation
AzureRm Usato principalmente per i moduli AzureRM
Backup
Compilazione
ChatOps
Cloud
Colore
Configurazione
CrescendoBuilt Questo tag viene aggiunto automaticamente da Crescendo quando si esporta il modulo
Database Il plurale inglese databases è meno consigliato
DBA
Distribuzione Il verbo deploy è usato meno frequentemente
DevOps
DNS
Docker
DSC DesiredStateConfiguration è meno consigliato perché troppo lungo
DSCResource
DSCResourceKit
Excel
Exchange
Firewall
GIT
GitHub
Gitlab
Google
HTML
Hyper-V HyperV è usato meno comunemente come tag
IaaS
IIS
Json
Linux
File di log Uso preferito come oggetto
Registrazione Uso preferito come azione
MacOS
Monitoraggio
Identità del servizio gestita
Rete Il tag networking è simile, ma meno usato
Office365 È preferibile indicare Office per intero. Il tag O365 è usato meno comunemente, sebbene più breve
Modulo PackageManagement
Pester
PoshBot
Report Report è un oggetto
Report Reporting è un'azione, report è un oggetto
ResourceManager "Arm" viene usato per descrivere il gruppo di processori e non deve essere usato per Azure Resource Manager
REST
Security Defense è meno preciso
SharePoint
SQL
SQLServer
Archiviazione
Test Testing è meno consigliato
VersionControl Version è meno preciso, anche se usato più frequentemente
VSTS
Windows
WinRM
WMI
Zip