Partilhar via

Valores de metadados do pacote que afetam a IU do Galeria do PowerShell

  • Artigo

Este artigo explica como os metadados nos pacotes são utilizados pelo Galeria do PowerShell. Para módulos, os metadados são armazenados no manifesto do módulo. Para scripts, os metadados são armazenados com palavras-chave baseadas em comentários. Os seguintes cmdlets são utilizados para criar ou atualizar estes metadados:

A lista seguinte mostra os elementos da IU da página do pacote Galeria do PowerShell que são controlados pelo manifesto do módulo.

  • Título – o nome do pacote publicado na Galeria.

  • Versão – a versão apresentada é a cadeia de versão nos metadados e uma etiqueta de pré-lançamento, se for especificada. A cadeia de pré-lançamento especificada é anexada à ModuleVersion. Para obter informações sobre cadeias de pré-lançamento em módulos, veja Versões do Módulo de Pré-lançamento.

  • Descrição – esta é a Descrição no manifesto do módulo.

  • Exigir a aceitação da licença – um módulo pode exigir que o utilizador aceite uma licença, definindo RequireLicenseAcceptance = $true, fornecendo um LicenseURI e fornecendo um license.txt ficheiro na raiz da pasta do módulo. Para obter mais informações, veja Exigir a Aceitação da Licença.

  • Notas de versão – estas informações são provenientes da secção ReleaseNotes , em PSData\PrivateData.

  • Proprietários – os proprietários são a lista de utilizadores na Galeria do PowerShell que podem atualizar um pacote. A lista de proprietários não está incluída no manifesto do pacote. Documentação adicional descreve como gerir proprietários de itens.

  • Autor – está incluído no manifesto do módulo como Autor. O campo Autor é frequentemente utilizado para especificar uma empresa ou organização associada a um pacote.

  • Copyright – este é o campo Copyright no manifesto do módulo.

  • FileList – a lista de ficheiros é criada quando o pacote é publicado no Galeria do PowerShell. Não é controlável pelas informações do manifesto. O Galeria do PowerShell cria .nuspec um ficheiro que aparece na lista de ficheiros de cada pacote. Este ficheiro não está instalado com o pacote num sistema. Este é o manifesto do pacote NuGet para o pacote e pode ser ignorado.

  • Etiquetas - As etiquetas estão incluídas PrivateData\PSData no manifesto do módulo. As etiquetas têm requisitos e significados específicos descritos na secção Detalhes da Etiqueta .

  • Cmdlets – é fornecido no manifesto do módulo com CmdletsToExport. É uma melhor prática listar explicitamente os nomes dos cmdlets em vez de utilizar o caráter universal *. Ter uma lista melhora o desempenho do módulo de carga.

  • Funções – isto é fornecido no manifesto do módulo com FunctionsToExport. É uma melhor prática listar explicitamente os nomes dos cmdlets em vez de utilizar o caráter universal *. Ter uma lista melhora o desempenho do módulo de carga.

  • Recursos do DSC – é fornecido no manifesto com DscResourcesToExport. Este valor só é suportado para módulos no PowerShell 5.0 e superior.

  • Capacidades de função – as funções são listadas quando o módulo tem um ou mais ficheiros de capacidade de função (.psrc). Estes ficheiros são utilizados pela JEA. Para obter mais informações, veja capacidades de função.

  • Edições do PowerShell – para módulos concebidos para o PowerShell 5.0 e inferiores, isto é controlado com Etiquetas. Para Ambiente de Trabalho, utilize a etiqueta PSEdition_Desktop e, para núcleo, utilize a etiqueta PSEdition_Core. Para módulos concebidos para o PowerShell 5.1 e superior, existe uma chave CompatiblePSEditions no manifesto. Para obter mais informações, veja Suporte do PSEdition para módulos.

  • Dependências – isto é fornecido no manifesto com RequiredModules.

  • Versão mínima do PowerShell – é fornecida no manifesto com o PowerShellVersion.

  • Histórico de Versões – mostra uma lista de versões do módulo que foram publicadas na Galeria. Os pacotes ocultos com a funcionalidade Eliminar não são apresentados no histórico de versões, a menos que seja proprietário de um pacote.

  • Site do Projeto – o site do projeto é fornecido para módulos na PrivateData\PSData secção do manifesto do módulo ao especificar um ProjectURI.

  • Licença – é fornecida uma ligação de licença para módulos na PrivateData\PSData secção do manifesto do módulo ao especificar um LicenseURI.

    Importante

    Se uma licença não for fornecida através do LicenseURI ou do pacote, os Termos de Utilização do Galeria do PowerShell aplicam-se ao pacote. Para obter mais informações, veja os Termos de Utilização.

  • Ícone – é fornecida uma ligação para módulos na PrivateData\PSData secção do manifesto do módulo ao especificar um IconURI. O URI deve apontar para uma imagem de 85x85 com fundo de transparência. O URI tem de ser uma ligação direta para o ficheiro de imagem e não pode aceder a uma página Web ou a um ficheiro no pacote de Galeria do PowerShell.

A lista seguinte mostra os elementos da IU da página do pacote Galeria do PowerShell que são controlados pelos metadados baseados em comentários num ficheiro de script.

  • Título – este é o nome do pacote publicado na Galeria

  • Versão – a versão apresentada é a cadeia de versão nos metadados e uma etiqueta de pré-lançamento, se for especificada. O valor provém da .VERSION palavra-chave no bloco de comentários de metadados. Ao publicar o script de pré-lançamento, acrescente a cadeia de pré-lançamento à versão. Para obter informações sobre como especificar cadeias de pré-lançamento em módulos, veja Versões de pré-lançamento de scripts.

  • Descrição – estas informações provêm da .DESCRIPTION palavra-chave na ajuda baseada em comentários de um ficheiro de script.

  • Exigir a aceitação da licença – a Aceitação da Licença não é suportada para scripts. No entanto, o cenário em que um script depende de um módulo que requer a aceitação da licença é suportado. Para obter mais informações, veja Exigir a aceitação da licença para scripts.

  • Notas de versão – estas informações provêm da .RELEASENOTES palavra-chave nos metadados baseados em comentários de um ficheiro de script.

  • Proprietários – os proprietários são a lista de utilizadores na Galeria do PowerShell que podem atualizar um pacote. A lista de proprietários não está incluída no manifesto do pacote. Para obter mais informações, veja Gerir proprietários de itens.

  • Autor – estas informações provêm da .AUTHOR palavra-chave nos metadados baseados em comentários de um ficheiro de script. O campo Autor é frequentemente utilizado para especificar uma empresa ou organização associada a um pacote.

  • Copyright – estas informações provêm da .COPYRIGHT palavra-chave nos metadados baseados em comentários de um ficheiro de script.

  • FileList – a lista de ficheiros é criada quando o pacote é publicado no Galeria do PowerShell. Não é controlável pelas informações do manifesto. O Galeria do PowerShell cria .nuspec um ficheiro que aparece na lista de ficheiros de cada pacote. Este ficheiro não está instalado com o pacote num sistema. Este é o manifesto do pacote NuGet para o pacote e pode ser ignorado.

  • Etiquetas - *Estas informações provêm da .TAGS palavra-chave nos metadados baseados em comentários de um ficheiro de script. As etiquetas têm requisitos e significados específicos descritos na secção Detalhes da Etiqueta .

  • Edições do PowerShell – para módulos concebidos para o PowerShell 5.0 e inferiores, isto é controlado com Etiquetas. Para Ambiente de Trabalho, utilize a etiqueta PSEdition_Desktop e, para núcleo, utilize a etiqueta PSEdition_Core. Para módulos concebidos para o PowerShell 5.1 e superior, existe uma chave CompatiblePSEditions no manifesto. Para obter mais informações, veja Suporte do PSEdition para módulos.

  • Histórico de Versões – mostra uma lista de versões do módulo que foram publicadas na Galeria. Os pacotes ocultos com a funcionalidade Eliminar não são apresentados no histórico de versões, a menos que seja proprietário de um pacote.

  • Site do Projeto – estas informações provêm da .PROJECTURI palavra-chave nos metadados baseados em comentários de um ficheiro de script.

  • Licença – estas informações provêm da .LICENSEURI palavra-chave nos metadados baseados em comentários de um ficheiro de script.

    Importante

    Se não for fornecida uma licença através do .LICENSEURI pacote ou no pacote, os Termos de Utilização do Galeria do PowerShell aplicam-se ao pacote. Para obter mais informações, veja os Termos de Utilização.

  • Ícone – estas informações provêm da .ICONURI palavra-chave nos metadados baseados em comentários de um ficheiro de script. O URI deve apontar para uma imagem de 85x85 com fundo de transparência. O URI tem de ser uma ligação direta para o ficheiro de imagem e não pode aceder a uma página Web ou a um ficheiro no pacote de Galeria do PowerShell.

Editar detalhes do pacote

A página Editar pacote Galeria do PowerShell permite que os publicadores alterem vários dos campos apresentados para um pacote, especificamente:

  • Título
  • Descrição
  • Resumo
  • URL do ícone
  • Project home page URL
  • Autores
  • Copyright
  • Etiquetas
  • Notas de versão
  • Exigir licença

Só deve editar estas informações na Galeria para corrigir o que é apresentado para uma versão mais antiga de um módulo. Os utilizadores que transferirem o pacote verão que os metadados não correspondem ao Galeria do PowerShell. Sempre que alterar as informações na Galeria, deverá publicar uma nova versão do pacote com as mesmas alterações.

Detalhes da etiqueta

As etiquetas são cadeias simples que os consumidores utilizam para encontrar pacotes. As etiquetas são mais valiosas quando são utilizadas de forma consistente em pacotes relacionados. A utilização de variações da mesma palavra, por exemplo bases de dados e bases de dados ou testes e testes, proporciona poucas vantagens. As etiquetas são cadeias não sensíveis a maiúsculas e minúsculas de palavra única e não podem incluir espaços em branco. Se existir uma expressão que acredita que os utilizadores irão procurar, adicione-a à descrição do pacote para que possa ser encontrada nos resultados da pesquisa. Utilize a caixa Pascal, hífenes, carateres de sublinhado ou períodos para melhorar a legibilidade. Tenha cuidado ao criar etiquetas longas, complexas e invulgares que são facilmente mal escritas.

Os cmdlets Galeria do PowerShell e PowerShellGet têm significados especiais para as PSEdition_Desktop etiquetas e PSEdition_Core . Veja o debate anterior das Edições do PowerShell.

Conforme indicado anteriormente, as etiquetas fornecem o maior valor quando são específicas e utilizadas de forma consistente em muitos pacotes. Enquanto publicador a tentar localizar as melhores etiquetas a utilizar, a abordagem mais fácil é procurar etiquetas no Galeria do PowerShell que está a considerar. Idealmente, os pacotes devolvidos alinham-se com a sua utilização dessa palavra-chave.

A tabela seguinte mostra algumas das etiquetas mais utilizadas. A etiqueta preferencial deve devolver os melhores resultados de pesquisa.

Etiqueta preferencial Alternativas e notas
ActiveDirectory O AD não é atualmente utilizado por si só
Fornecedor
Automatização
AWS
Azure
AzureAD
AzureAutomation
AzureRm Utilizado principalmente para os módulos do AzureRM
Backup
Compilação
ChatOps
Cloud
Cor
Configuração
CrescendoBuilt Esta etiqueta é adicionada automaticamente pelo Crescendo ao exportar o módulo
Base de Dados As bases de dados (plural) são menos desejáveis
DBA
Implementação A implementação é utilizada com menos frequência
DevOps
DNS
Docker
DSC DesiredStateConfiguration é menos desejável, é demasiado longo
DSCResource
DSCResourceKit
Excel
Troca
Firewall
GIT
GitHub
Gitlab
Google
HTML
Hyper-V O HyperV é menos comum como uma etiqueta
IaaS
IIS
Json
Linux
Registo Utilização preferencial do Log as a thing
Registo Utilização preferencial do registo como uma ação
MacOS
Monitorização
MSI
Rede A rede é semelhante, menos frequentemente utilizada
Office365 A ortografia do Office é preferível. O O365 é menos utilizado comumente, embora mais curto
PackageManagement
Pester
PoshBot
Relatório O relatório é uma coisa
Relatórios Os relatórios são uma ação, o relatório é uma coisa
ResourceManager "Arm" é utilizado para descrever o grupo de processadores e não deve ser utilizado para o Azure Resource Manager
REST
Segurança A defesa é menos precisa
SharePoint
SQL
SQLServer
Armazenamento
Teste Os testes são menos desejáveis
VersionControl A versão é menos precisa, embora seja utilizada com mais frequência
VSTS
Windows
WinRM
WMI
Zip