Condividi tramite

Pacchetti di valori dei metadati che influiscono sull'interfaccia utente di PowerShell Gallery

Questo articolo illustra in che modo i metadati nei pacchetti vengono usati da PowerShell Gallery. Per i moduli, i metadati vengono archiviati nel manifesto del modulo. Per gli script, i metadati vengono memorizzati utilizzando parole chiave basate su commenti. Per creare o aggiornare questi metadati vengono utilizzati i cmdlet seguenti:

Nell'elenco seguente vengono illustrati gli elementi dell'interfaccia utente della pagina del pacchetto di PowerShell Gallery controllati dal manifesto del modulo.

  • Titolo : nome del pacchetto pubblicato nella Galleria.

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

  • Descrizione : questa è la descrizione nel manifesto del modulo.

  • Richiedi accettazione licenza : un modulo può richiedere che l'utente accetti una licenza, impostando RequireLicenseAcceptance = $true, fornendo un LicenseURI e fornendo un license.txt file nella radice della cartella del modulo. Per ulteriori 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 degli utenti nella raccolta di PowerShell che possono aggiornare un pacchetto. L'elenco dei proprietari non è incluso nel manifesto del pacchetto. Viene descritto come gestire i proprietari degli elementi.

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

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

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

  • Tag - I tag sono inclusi nel PrivateData\PSData 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é utilizzare il carattere *jolly . La presenza di un elenco migliora le prestazioni del modulo di caricamento.

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

  • Risorse DSC : vengono fornite 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 dispone di uno o più file di funzionalità del ruolo (.psrc). Questi file vengono utilizzati da JEA. Per ulteriori informazioni, vedere Funzionalità del ruolo.

  • Edizioni di PowerShell : per i moduli progettati per PowerShell 5.0 e versioni precedenti, questa operazione viene controllata tramite tag. Per Desktop, utilizza il tag PSEdition_Desktop e per Core, utilizza il tag PSEdition_Core. Per i moduli progettati per PowerShell 5.1 e versioni successive, nel manifesto è presente una chiave CompatiblePSEditions . Per altre informazioni, vedere Supporto PSEdition per i moduli.

  • Dipendenze : viene fornito nel manifesto usando RequiredModules.

  • Versione minima di PowerShell : viene fornita nel manifesto usando PowerShellVersion.

  • Cronologia versioni : mostra un elenco delle versioni del modulo che sono state pubblicate nella Galleria. I pacchetti nascosti utilizzando la funzione 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 alla licenza per i PrivateData\PSData moduli nella sezione del manifesto del modulo specificando un LicenseURI.

    Importante

    Se una licenza non viene fornita tramite LicenseURI o all'interno del pacchetto, al pacchetto si applicano le Condizioni per l'utilizzo di PowerShell Gallery. Per ulteriori informazioni, consultare le Condizioni d'uso.

  • Icon: 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 di PowerShell Gallery.

Nell'elenco seguente vengono illustrati gli elementi dell'interfaccia utente della pagina del pacchetto di PowerShell Gallery controllati dai metadati basati su commenti in un file di script.

  • Titolo : nome del pacchetto pubblicato nella Galleria

  • Versione : la versione visualizzata è la stringa della versione nei metadati e un'etichetta non definitiva, se specificata. Il valore deriva dalla .VERSION parola chiave nel blocco di commento dei metadati. Quando pubblichi uno script non definitivo, aggiungi la stringa 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 licenza : l'accettazione della licenza non è supportata per gli script. Tuttavia, lo scenario in cui uno script dipende da un modulo che richiede l'accettazione della licenza è supportato. Per ulteriori informazioni, vedere Richiesta di 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 degli utenti nella raccolta di PowerShell che possono aggiornare un pacchetto. L'elenco dei proprietari non è incluso nel manifesto del pacchetto. Per ulteriori 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 Autore viene spesso utilizzato per specificare una società o un'organizzazione associata a un pacchetto.

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

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

  • Tag - *Queste informazioni provengono dalla .TAGS parola chiave nei metadati basati sui 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, questa operazione viene controllata tramite tag. Per Desktop, utilizza il tag PSEdition_Desktop e per Core, utilizza il tag PSEdition_Core. Per i moduli progettati per PowerShell 5.1 e versioni successive, nel manifesto è presente una chiave CompatiblePSEditions . Per altre informazioni, vedere Supporto PSEdition per i moduli.

  • Cronologia versioni : mostra un elenco delle versioni del modulo che sono state pubblicate nella Galleria. I pacchetti nascosti utilizzando la funzione Elimina non vengono visualizzati nella cronologia delle versioni, a meno che non si sia un proprietario del pacchetto.

  • Sito del 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 o .LICENSEURI all'interno del pacchetto, al pacchetto si applicano le Condizioni per l'utilizzo di PowerShell Gallery. Per ulteriori informazioni, consultare le Condizioni d'uso.

  • 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 di PowerShell Gallery.

Modifica dei dettagli del pacchetto

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

  • Titolo
  • Description
  • Riassunto
  • URL dell'icona
  • URL della home page del progetto
  • Autori
  • Diritto d’autore
  • Etichette
  • Note di rilascio
  • Richiedi licenza

È consigliabile modificare queste informazioni nella Galleria solo per correggere ciò che viene visualizzato per una versione precedente di un modulo. Gli utenti che scaricano il pacchetto noteranno che i metadati non corrispondono a PowerShell Gallery. Ogni volta che si modificano le informazioni nella Galleria, è necessario pubblicare una nuova versione del pacchetto con le stesse modifiche.

Dettagli del tag

I tag sono semplici stringhe che i consumatori utilizzano per trovare i pacchetti. I tag sono più utili quando vengono utilizzati in modo coerente in pacchetti correlati. L'uso di varianti della stessa parola, ad esempio database e database o test e test, offre pochi vantaggi. I tag sono stringhe di una sola parola senza distinzione tra maiuscole e minuscole e non possono includere spazi vuoti. Se si ritiene che gli utenti cercheranno una frase, aggiungerla alla descrizione del pacchetto in modo che possa essere trovata nei risultati della ricerca. Usa maiuscole/minuscole, trattini, trattini bassi o punti Pascal per migliorare la leggibilità. Fai attenzione alla creazione di tag lunghi, complessi e insoliti che possono essere facilmente scritti in modo errato.

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

Come indicato in precedenza, i tag offrono il massimo valore quando sono specifici e vengono utilizzati in modo coerente in molti pacchetti. In qualità di editore che cerca di individuare i tag migliori da usare, l'approccio più semplice consiste nel cercare i tag che si stanno prendendo in considerazione in PowerShell Gallery. Idealmente, i pacchetti restituiti sono in linea con l'uso di tale parola chiave.

Nella tabella seguente vengono illustrati alcuni dei tag più utilizzati. Il tag preferito dovrebbe restituire i migliori risultati di ricerca.

Tag preferito Alternative e note
Istanza di ActiveDirectory AD non è attualmente usato da solo
Appveyor
Automazione
AWS
Azzurro
Azure AD
AzureAutomation
AzureRm Usato principalmente per i moduli AzureRM
Backup
Costruire
ChatOps
Cloud
Colore
Configurazione
CrescendoCostruito Questo tag viene aggiunto automaticamente da Crescendo quando esporti il modulo
Banca dati Database (plurale) è meno desiderabile
DBA
Distribuzione Deploy viene utilizzato un po' meno spesso
DevOps
DNS
Docker
DSC DesiredStateConfiguration è meno desiderabile, è troppo lungo
DSCResource
Kit DSCResourceKit
Excel
Scambio
Firewall
GIT
GitHub
Gitlab
Google
HTML
Hyper-V HyperV è meno comune come tag
IaaS
IIS
Json
Linux
Log Uso preferito di Log come cosa
Registrazione Uso preferito della registrazione come azione
MacOS
Monitoraggio
MSI
Rete Il networking è simile, meno utilizzato
Office365 È preferibile scrivere Office. O365 è meno comunemente usato, anche se più corto
Gestione dei pacchetti
Assillare
PoshBot
Rapporto Il rapporto è una cosa
Rendicontazione La segnalazione è un'azione, la segnalazione è una cosa
ResourceManager "Arm" viene usato per descrivere il gruppo di processori e non deve essere usato per Azure Resource Manager
REST
Security La difesa è meno precisa
SharePoint
SQL
SQLServer
Storage
Test I test sono meno desiderabili
Controllo delle Versioni La versione è meno precisa, anche se usata più frequentemente
VSTS
Windows
WinRM - Gestione remota di Windows
WMI
Compressione ZIP
  • Last updated on