Значения метаданных пакетов, связанные с пользовательским интерфейсом коллекции PowerShell
В этой статье объясняется, как метаданные в пакетах используются коллекцией PowerShell. Для модулей метаданные хранятся в манифесте модуля. Для сценариев метаданные хранятся с помощью ключевых слов на основе комментариев. Для создания и обновления этих метаданных используются следующие командлеты:
Элементы компонентов в коллекции PowerShell, управляемые манифестом модуля
В списке ниже приведены управляемые манифестом модуля элементы пользовательского интерфейса страницы пакета для коллекции PowerShell.
Название — имя пакета, опубликованного в коллекции.
Версия — это строка версии в метаданных, а также строка метки предварительной версии, если она указана. Указанная строка метки предварительной версии добавляется к Версии модуля. Сведения о предварительных версиях строк в модулях см. в разделе Предварительные версии модуля.
Описание — это Описание в манифесте модуля.
Требовать принятия лицензии — для работы с модулем пользователю может требоваться принять условия лицензии. Для этого необходимо установить параметр
RequireLicenseAcceptance = $true, указать LicenseURI и разместить файлlicense.txtв корневой папке модуля. Дополнительные сведения см. в статье Требование принятия лицензии.Заметки о выпуске — эти сведения поступают из раздела Заметки о выпуске в
PSData\PrivateData.Владельцы — это список пользователей в коллекции PowerShell, которые могут обновить пакет. Список владельцев не содержится в манифесте пакета. Дополнительные сведения см. в документации по управлению владельцами элементов.
Автор — этот параметр включается в манифест модуля в поле Автор. Поле автора часто используется для указания компании или организации, связанной с пакетом.
Авторское право — это поле Авторское право в манифесте модуля.
Список файлов — список файлов создается при публикации пакета в коллекции PowerShell. Он не определяется данными манифеста. Коллекция PowerShell создает файл
.nuspec, который отображается в списке файлов каждого пакета. Этот файл не устанавливается вместе с пакетом в системе. Это манифест пакета NuGet для пакета. Этот манифест можно игнорировать.Теги - Теги включены в раздел
PrivateData\PSDataв манифесте модуля. Значения тегов и требования для них приведены в разделе Сведения о тегах.Командлеты — указываются в манифесте модуля с помощью параметра CmdletsToExport. Рекомендуется явно перечислить имена командлетов и не использовать подстановочные знаки
*. Наличие списка повышает производительность при загрузке модуля.Функции — указываются в манифесте модуля с помощью параметра FunctionsToExport. Рекомендуется явно перечислить имена командлетов и не использовать подстановочные знаки
*. Наличие списка повышает производительность при загрузке модуля.Ресурсы DSC — указываются в манифесте модуля с помощью параметра DscResourcesToExport. Это значение поддерживается только для модулей в PowerShell 5.0 и более поздних версий.
Возможности ролей — роли указываются, если модуль имеет один или несколько файлов возможностей ролей (
.psrc). Эти файлы используются JEA. Дополнительные сведения см. в разделе Возможности ролей.Выпуски PowerShell — для модулей, предназначенных для PowerShell 5.0 и более ранних версий, модули определяются Тегами. В версии для компьютеров используйте PSEdition_Desktop, а для версии Core используйте PSEdition_Core. Для модулей, предназначенных для PowerShell 5.1 и более поздних версий, в манифесте существует ключ CompatiblePSEditions. Дополнительные сведения см. в разделе Поддержка PSEdition для модулей.
Зависимости — указываются в манифесте с помощью параметра RequiredModules.
Минимальная версия PowerShell — указывается в манифесте с помощью параметра PowerShellVersion.
Журнал версий — отображает список версий модуля, опубликованных в коллекции. Пакеты, скрытые с помощью функции Удалить, не отображаются в журнале версий, если вы не являетесь владельцем пакета.
Сайт проекта — сайт проекта задается для модулей в разделе
PrivateData\PSDataманифеста модуля с помощью параметра ProjectURI.Лицензия — ссылка на лицензию задается для модулей в разделе
PrivateData\PSDataманифеста модуля с помощью параметра LicenseURI.Важно!
Если лицензия не указана в пакете или с помощью параметра LicenseURI, к пакету применяются Условия использования коллекции PowerShell. Дополнительные сведения см. в статье об условия использования.
Значок — ссылка на лицензию задается для модулей в разделе
PrivateData\PSDataманифеста модуля с помощью параметра IconURI. URI должен указывать на изображение размером 85 x 85 пикселей с прозрачным фоном. URI должен представлять собой прямую ссылку на файл изображения и не должен указывать на веб-страницу или на файл в пакете коллекции PowerShell.
Элементы компонентов в коллекции PowerShell, управляемые метаданными сценария
В списке ниже приведены элементы пользовательского интерфейса страницы пакета для коллекции PowerShell, управляемые метаданными на основе комментариев в файле сценария.
Название — имя пакета, опубликованного в коллекции.
Версия — это строка версии в метаданных, а также строка метки предварительной версии, если она указана. Значение поступает из ключевого слова
.VERSIONв блоке комментариев метаданных. При публикации сценария предварительной версии добавьте к версии строку предварительной версии. Сведения об указании строк предварительной версии в модулях см. в разделе Предварительные версии сценариев.Описание — эти сведения поступают из ключевого слова
.DESCRIPTIONв справке файла сценария на основе комментариев.Требовать принятия лицензии — принятие лицензии не поддерживается для сценариев. Но поддерживается вариант, при котором скрипт зависит от модуля, для использования которого требуется принять условия лицензионного соглашения. Дополнительные сведения см. в статье Требование принятия лицензии.
Заметки о выпуске — эти сведения поступают из ключевого слова
.RELEASENOTESв метаданных файла сценария на основе комментариев.Владельцы — это список пользователей в коллекции PowerShell, которые могут обновить пакет. Список владельцев не содержится в манифесте пакета. Дополнительные сведения см. в разделе Управление владельцами элементов.
Автор — эти сведения поступают из ключевого слова
.AUTHORв метаданных файла сценария на основе комментариев. Поле автора часто используется для указания компании или организации, связанной с пакетом.Авторское право — эти сведения поступают из ключевого слова
.COPYRIGHTв метаданных файла сценария на основе комментариев.Список файлов — список файлов создается при публикации пакета в коллекции PowerShell. Он не определяется данными манифеста. Коллекция PowerShell создает файл
.nuspec, который отображается в списке файлов каждого пакета. Этот файл не устанавливается вместе с пакетом в системе. Это манифест пакета NuGet для пакета. Этот манифест можно игнорировать.Теги — эти сведения поступают из ключевого слова
.TAGSв метаданных файла сценария на основе комментариев. Значения тегов и требования для них приведены в разделе Сведения о тегах.Выпуски PowerShell — для модулей, предназначенных для PowerShell 5.0 и более ранних версий, модули определяются Тегами. В версии для компьютеров используйте PSEdition_Desktop, а для версии Core используйте PSEdition_Core. Для модулей, предназначенных для PowerShell 5.1 и более поздних версий, в манифесте существует ключ CompatiblePSEditions. Дополнительные сведения см. в разделе Поддержка PSEdition для модулей.
Журнал версий — отображает список версий модуля, опубликованных в коллекции. Пакеты, скрытые с помощью функции Удалить, не отображаются в журнале версий, если вы не являетесь владельцем пакета.
Сайт проекта — эти сведения поступают из ключевого слова
.PROJECTURIв метаданных файла сценария на основе комментариев.Лицензия — эти сведения поступают из ключевого слова
.LICENSEURIв метаданных файла сценария на основе комментариев.Важно!
Если лицензия не указана в пакете или с помощью параметра
.LICENSEURI, к пакету применяются Условия использования коллекции PowerShell. Дополнительные сведения см. в статье об условия использования.Значок — эти сведения поступают из ключевого слова
.ICONURIв метаданных файла сценария на основе комментариев. URI должен указывать на изображение размером 85 x 85 пикселей с прозрачным фоном. URI должен представлять собой прямую ссылку на файл изображения и не должен указывать на веб-страницу или на файл в пакете коллекции PowerShell.
Изменение сведений о пакете
Страница изменения пакета в коллекции PowerShell позволяет издателям изменять несколько полей, отображаемых для пакета, в частности:
- Title
- Description
- Сводка
- URL-адрес значка;
- URL-адрес домашней страницы;
- Авторы
- Авторские права
- Теги
- Заметки о выпуске
- запрос на лицензию.
Эти сведения следует изменить только в коллекции, чтобы исправить отображаемые сведения для более старой версии модуля. Пользователи, скачивающие пакет, увидят, что метаданные не соответствуют коллекции PowerShell. При любом изменении сведений в коллекции следует опубликовать новую версию пакета с теми же изменениями.
Сведения о тегах
Теги — это простые строки, которые пользователи применяют для поиска пакетов. Теги особенно удобны, когда они используются согласованно со связанными пакетами. Использовать несколько вариантов одного и того же слова (например, database и databases или test и testing) не слишком целесообразно. Теги — это строки из одного слова без учета регистра. Они не должны содержать пробелы. Если есть фраза, по которой, по вашему мнению, пользователи будут выполнять поиск, добавьте ее к описанию пакета. После этого она будет отображаться в результатах поиска. Используйте регистр Pascal, дефисы, символы подчеркивания или точки для повышения удобочитаемости. Старайтесь не создавать длинные, сложные и необычные теги, так как их часто пишут с ошибками.
Командлеты коллекции PowerShell и PowerShellGet имеют специальное значение для тегов PSEdition_Desktop и PSEdition_Core. Дополнительные сведения см. в предыдущем обсуждении выпусков PowerShell.
Как было указано выше, теги наиболее полезны, если они являются конкретными и используются согласованно со множеством пакетов. Рекомендуем издателям, которые ищут удобные теги, самый простой подход — использовать галерею PowerShell. В идеальном случае возвращаемые пакеты соответствуют используемому вами ключевому слову.
В таблице ниже представлены некоторые из наиболее часто используемых тегов. Предпочтительный тег должен возвращать наилучшие результаты поиска.
| Предпочтительный тег | Альтернативные варианты и примечания |
|---|---|
| ActiveDirectory | Сейчас тег AD не используется самостоятельно |
| Appveyor | |
| Автоматизация | |
| AWS | |
| Azure | |
| AzureAD | |
| AzureAutomation | |
| AzureRm | Используется в основном для модулей AzureRM. |
| Резервное копирование | |
| Сборка | |
| ChatOps | |
| Cloud | |
| Color | |
| Конфигурация | |
| CrescendoBuilt | Этот тег автоматически добавляется Crescendo при экспорте модуля |
| База данных | Тег Databases (во множественном числе) менее предпочтителен. |
| Администратор баз данных | |
| Развертывание | Тег Deploy используется немного реже. |
| DevOps | |
| DNS | |
| Docker | |
| DSC | Тег DesiredStateConfiguration менее предпочтителен из-за большой длины. |
| DSCResource | |
| DSCResourceKit | |
| Excel | |
| Exchange | |
| Брандмауэр | |
| GIT | |
| GitHub | |
| Gitlab | |
| HTML | |
| Hyper-V | HyperV реже используется в качестве тега. |
| IaaS | |
| Службы IIS | |
| Json | |
| Linux | |
| Журнал | Если речь идет об объекте, предпочтительнее использовать Log. |
| Logging | Если речь идет о действии, предпочтительнее использовать Logging. |
| MacOS | |
| Наблюдение | |
| MSI | |
| Сеть | Тег Networking является аналогом, но используется реже. |
| Office365 | Предпочтительнее использовать полное слово Office. O365 используется реже, несмотря на то что этот тег короче. |
| PackageManagement | |
| Pester | |
| PoshBot | |
| Report | Тег Report используется, если речь идет об объекте. |
| Отчеты | Для действия используется Reporting, для объекта — Report. |
| ResourceManager | Сокращение ARM используется для описания группы процессоров. Его не следует путать с Azure Resource Manager. |
| REST | |
| безопасность | Тег Defense не такой точный. |
| SharePoint | |
| SQL | |
| SQLServer | |
| Память | |
| Тест | Тег Testing менее предпочтителен. |
| VersionControl | Тег Version менее точный, хотя используется чаще. |
| VSTS | |
| Windows | |
| WinRM | |
| WMI | |
| Почтовый индекс |
PowerShell Gallery