PowerShell 갤러리 UI에 영향을 주는 패키지 메타데이터 값
이 문서에서는 패키지의 메타데이터가 PowerShell 갤러리에서 사용되는 방법을 설명합니다. 모듈의 경우 메타데이터는 모듈 매니페스트에 저장됩니다. 스크립트의 경우 메타데이터는 주석 기반 키워드를 사용하여 저장됩니다. 다음 cmdlet은 이 메타데이터를 만들거나 업데이트하는 데 사용합니다.
모듈 매니페스트로 관리되는 PowerShell 갤러리 기능 요소
다음 목록에서는 모듈 매니페스트가 관리하는 PowerShell 갤러리 패키지 페이지 UI의 요소를 보여 줍니다.
제목 - 갤러리에 게시된 패키지의 이름입니다.
버전 - 표시되는 버전은 메타데이터의 버전 문자열이며, 버전이 지정된 경우 시험판 레이블입니다. 지정한 시험판 문자열이 ModuleVersion에 추가됩니다. 모듈의 시험판 문자열에 대한 자세한 내용은 시험판 모듈 버전 을 참조하세요.
설명 - 모듈 매니페스트의 설명입니다.
라이선스 승인 필요 - 모듈은 사용자가
RequireLicenseAcceptance = $true
를 설정하고, LicenseURI를 제공하고, 모듈 폴더의 루트에license.txt
파일을 제공하여 사용자가 라이선스를 승인하도록 요구할 수 있습니다. 자세한 내용은 라이선스 승인 필요를 참조하세요.릴리스 정보 - 이 정보는
PSData\PrivateData
아래의 ReleaseNotes 섹션에서 제공됩니다.소유자 - 소유자는 패키지를 업데이트할 수 있는 PowerShell 갤러리의 사용자 목록입니다. 소유자 목록은 패키지 매니페스트에 포함되지 않습니다. 추가 문서에 항목 소유자 관리방법이 설명되어 있습니다.
작성자 - 모듈 매니페스트에 작성자로 포함됩니다. 작성자 필드는 패키지와 연결된 회사 또는 조직을 지정하는 데 자주 사용됩니다.
저작권 - 모듈 매니페스트의 저작권 필드입니다.
FileList - 파일 목록은 패키지가 PowerShell 갤러리에 게시될 때 만들어집니다. 매니페스트 정보로 제어할 수 없습니다. PowerShell 갤러리는 각 패키지의 파일 목록에 표시되는
.nuspec
파일을 만듭니다. 이 파일은 시스템의 패키지와 함께 설치되지 않습니다. 패키지에 대한 NuGet 패키지 매니페스트이며, 무시할 수 있습니다.태그 - 태그는 모듈 매니페스트의
PrivateData\PSData
아래에 포함됩니다. 태그에는 태그 세부 정보 섹션에 설명된 특정 요구 사항과 의미가 포함됩니다.Cmdlets - CmdletsToExport를 사용하여 모듈 매니페스트에 제공됩니다. 와일드카드
*
를 사용하는 대신 cmdlet 이름을 명시적으로 나열하는 것이 좋습니다. 목록이 있으면 로드 모듈 성능이 향상됩니다.함수 - FunctionsToExport를 사용하여 모듈 매니페스트에 제공됩니다. 와일드카드
*
를 사용하는 대신 cmdlet 이름을 명시적으로 나열하는 것이 좋습니다. 목록이 있으면 로드 모듈 성능이 향상됩니다.DSC 리소스 - DscResourcesToExport를 사용하여 매니페스트에 제공됩니다. 이 값은 PowerShell 5.0 이상의 모듈에서만 지원됩니다.
역할 기능 - 모듈에 하나 이상의 역할 기능(
.psrc
) 파일이 있는 경우 역할이 나열됩니다. 이러한 파일은 JEA에서 사용됩니다. 자세한 내용은 역할 기능을 참조하세요.PowerShell 버전 - PowerShell 5.0 이하용으로 설계된 모듈의 경우 태그를 사용하여 제어됩니다. Desktop의 경우 PSEdition_Desktop 태그를 사용하고, Core의 경우 PSEdition_Core를 사용합니다. PowerShell 5.1 이상용으로 설계된 모듈의 경우 매니페스트에 CompatiblePSEditions 키가 있습니다. 자세한 내용은 모듈에 대한 PSEdition 지원을 참조하세요.
종속성 - RequiredModules를 사용하여 매니페스트에 제공됩니다.
최소 PowerShell 버전 - PowerShellVersion을 사용하여 매니페스트에 제공됩니다.
버전 기록 - 갤러리에 게시된 모듈의 버전 목록을 표시합니다. 삭제 기능을 사용하여 숨겨진 패키지는 패키지 소유자가 아닌 한 버전 기록에 표시되지 않습니다.
프로젝트 사이트 - 프로젝트 사이트는 ProjectURI를 지정하여 모듈 매니페스트의
PrivateData\PSData
섹션의 모듈에 대해 제공됩니다.라이선스 - 라이선스 링크는 LicenseURI를 지정하여 모듈 매니페스트의
PrivateData\PSData
섹션의 모듈에 대해 제공됩니다.중요
라이선스가 LicenseURI 또는 패키지 내에서 제공되지 않으면 PowerShell 갤러리의 사용 약관이 패키지에 적용됩니다. 자세한 내용은 사용 약관을 참조하세요.
아이콘 - 링크는 IconURI를 지정하여 모듈 매니페스트의
PrivateData\PSData
섹션의 모듈에 대해 제공됩니다. URI는 배경이 투명한 85x85 이미지를 가리켜야 합니다. URI는 반드시 이미지 파일에 대한 직접 링크이어야 하며 PowerShell 갤러리 패키지의 웹 페이지 또는 파일로 이동하면 안 됩니다.
스크립트 메타데이터로 관리되는 PowerShell 갤러리 기능 요소
다음 목록에서는 스크립트 파일의 주석 기반 메타데이터가 관리하는 PowerShell 갤러리 패키지 페이지 UI의 요소를 보여 줍니다.
제목 - 갤러리에 게시되는 패키지의 이름입니다.
버전 - 표시되는 버전은 메타데이터의 버전 문자열이며, 버전이 지정된 경우 시험판 레이블입니다. 이 값은 메타데이터 주석 블록의
.VERSION
키워드에서 가져옵니다. 시험판 스크립트를 게시할 때 버전에 시험판 문자열을 추가합니다. 모듈에서 시험판 문자열을 지정하는 방법에 대한 자세한 내용은 시험판 버전의 스크립트를 참조하세요.설명 - 이 정보는 스크립트 파일의 주석 기반 도움말에 있는
.DESCRIPTION
키워드에서 제공됩니다.라이선스 승인 필요 - 스크립트에 대해 라이선스 승인이 지원되지 않습니다. 그러나 라이선스 동의가 필요한 모듈에서 스크립트가 사용되는 시나리오는 지원됩니다. 자세한 내용은 스크립트에 대한 라이선스 승인 필요를 참조하세요.
릴리스 정보 - 이 정보는 스크립트 파일의 주석 블록 메타데이터에 있는
.RELEASENOTES
키워드에서 제공됩니다.소유자 - 소유자는 패키지를 업데이트할 수 있는 PowerShell 갤러리의 사용자 목록입니다. 소유자 목록은 패키지 매니페스트에 포함되지 않습니다. 자세한 내용은 항목 소유자 관리를 참조하세요.
작성자 - 이 정보는 스크립트 파일의 주석 블록 메타데이터에 있는
.AUTHOR
키워드에서 제공됩니다. 작성자 필드는 패키지와 연결된 회사 또는 조직을 지정하는 데 자주 사용됩니다.저작권 - 이 정보는 스크립트 파일의 주석 블록 메타데이터에 있는
.COPYRIGHT
키워드에서 제공됩니다.FileList - 파일 목록은 패키지가 PowerShell 갤러리에 게시될 때 만들어집니다. 매니페스트 정보로 제어할 수 없습니다. PowerShell 갤러리는 각 패키지의 파일 목록에 표시되는
.nuspec
파일을 만듭니다. 이 파일은 시스템의 패키지와 함께 설치되지 않습니다. 패키지에 대한 NuGet 패키지 매니페스트이며, 무시할 수 있습니다.태그 - 이 정보는 스크립트 파일의 주석 블록 메타데이터에 있는
.TAGS
키워드에서 제공됩니다. 태그에는 태그 세부 정보 섹션에 설명된 특정 요구 사항과 의미가 포함됩니다.PowerShell 버전 - PowerShell 5.0 이하용으로 설계된 모듈의 경우 태그를 사용하여 제어됩니다. Desktop의 경우 PSEdition_Desktop 태그를 사용하고, Core의 경우 PSEdition_Core를 사용합니다. PowerShell 5.1 이상용으로 설계된 모듈의 경우 매니페스트에 CompatiblePSEditions 키가 있습니다. 자세한 내용은 모듈에 대한 PSEdition 지원을 참조하세요.
버전 기록 - 갤러리에 게시된 모듈의 버전 목록을 표시합니다. 삭제 기능을 사용하여 숨겨진 패키지는 패키지 소유자가 아닌 한 버전 기록에 표시되지 않습니다.
프로젝트 사이트 - 이 정보는 스크립트 파일의 주석 블록 메타데이터에 있는
.PROJECTURI
키워드에서 제공됩니다.라이선스 - 이 정보는 스크립트 파일의 주석 블록 메타데이터에 있는
.LICENSEURI
키워드에서 제공됩니다.중요
라이선스가
.LICENSEURI
또는 패키지 내에서 제공되지 않으면 PowerShell 갤러리의 사용 약관이 패키지에 적용됩니다. 자세한 내용은 사용 약관을 참조하세요.아이콘 - 이 정보는 스크립트 파일의 주석 블록 메타데이터에 있는
.ICONURI
키워드에서 제공됩니다. URI는 배경이 투명한 85x85 이미지를 가리켜야 합니다. URI는 반드시 이미지 파일에 대한 직접 링크이어야 하며 PowerShell 갤러리 패키지의 웹 페이지 또는 파일로 이동하면 안 됩니다.
패키지 세부 정보 편집
PowerShell 갤러리 편집 패키지 페이지에서는 게시자가 패키지에 대해 표시되는 여러 필드를 변경할 수 있습니다.
- 제목
- Description
- 요약
- 아이콘 URL
- 프로젝트 홈페이지 URL
- Authors
- 저작권
- 태그들
- 릴리스 정보
- 라이선스 필요
이전 버전의 모듈에 관해 표시되는 내용을 수정하려면 갤러리에서만 이 정보를 편집해야 합니다. 패키지를 다운로드하는 사용자는 메타데이터가 PowerShell 갤러리와 일치하지 않는 것을 볼 수 있습니다. 갤러리에서 정보를 변경할 때마다 동일한 변경 내용으로 새 버전의 패키지를 게시해야 합니다.
태그 세부 정보
태그는 소비자가 패키지를 찾기 위해 사용하는 간단한 문자열입니다. 태그는 관련된 패키지에서 일관되게 사용되는 경우 가장 효과적입니다. 동일한 단어의 변형을 사용하면(예를 들어 database와 databases, 또는 test와 testing) 효과적이지 않습니다. 태그는 대/소문자를 구분하지 않는 단일 단어 문자열이며 공백을 포함할 수 없습니다. 사용자가 검색할 것 같은 구문을 패키지 설명에 추가하면 검색 결과에 표시됩니다. 가독성을 높이기 위해 파스칼 대/소문자, 하이픈, 밑줄 또는 마침표를 사용합니다. 길고 복잡하고 특이한 태그는 철자가 틀리기 쉬우므로 주의하세요.
PowerShell 갤러리 및 PowerShellGet cmdlet에는 PSEdition_Desktop
태그와 PSEdition_Core
태그의 특별한 의미가 포함됩니다. PowerShell 버전에 대한 앞의 설명을 참조하세요.
앞에서 설명한 것처럼 태그는 구체적이고 여러 패키지에서 일관되게 사용되는 경우 가장 효과적입니다. 사용할 최상의 태그를 찾으려는 게시자로서 가장 쉬운 방법은 PowerShell 갤러리에서 태그를 검색하는 것입니다. 반환된 패키지는 해당 키워드를 사용하는 데 적합합니다.
다음 표에서는 가장 일반적으로 사용되는 일부 태그를 보여 줍니다. 기본 설정 태그는 최상의 검색 결과를 반환해야 합니다.
기본 태그 | 대체 및 메모 |
---|---|
ActiveDirectory | AD는 현재 단독으로 사용되지 않습니다. |
Appveyor | |
Automation | |
AWS | |
Azure | |
AzureAD | |
AzureAutomation | |
AzureRm | 주로 AzureRM 모듈에 대해 사용됩니다. |
Backup | |
빌드 | |
ChatOps | |
클라우드 | |
색 | |
구성 | |
CrescendoBuilt | 이 태그는 모듈을 내보낼 때 Crescendo에서 자동으로 추가됩니다. |
데이터베이스 | Databases(복수)는 그다지 적합하지 않습니다. |
DBA | |
배포 | Deploy는 자주 사용되지 않습니다. |
DevOps | |
DNS | |
Docker | |
DSC | DesiredStateConfiguration은 그다지 적합하지 않습니다. 너무 깁니다. |
DSCResource | |
DSCResourceKit | |
Excel | |
Exchange | |
방화벽 | |
GIT | |
GitHub | |
Gitlab | |
HTML | |
Hyper-V | HyperV는 일반적으로 태그로 사용되지 않습니다. |
IaaS | |
IIS | |
Json | |
Linux | |
로그 | 사물인 경우 Log를 사용하는 것이 좋습니다. |
로깅 | 동작인 경우 Logging을 사용하는 것이 좋습니다. |
MacOS | |
모니터링 | |
MSI | |
네트워크 | Networking은 비슷하지만 자주 사용되지 않습니다. |
Office365 | Office의 철자를 모두 쓰는 것이 좋습니다. O365는 짧지만 일반적으로 사용되지 않습니다. |
PackageManagement | |
Pester | |
PoshBot | |
보고서 | Report는 사물입니다. |
보고 | Reporting은 동작이고 Report는 사물입니다. |
ResourceManager | “Arm”은 프로세서 그룹을 설명하는 데 사용되며, Azure Resource Manager의 뜻으로 사용해서는 안 됩니다. |
REST (영문) | |
보안 | Defense는 덜 정확합니다. |
SharePoint | |
SQL | |
SQLServer | |
스토리지 | |
테스트 | Testing은 그다지 적합하지 않습니다. |
VersionControl | Version은 더 자주 사용되지만 덜 정확합니다. |
VSTS | |
Windows | |
WinRM | |
WMI | |
Zip |
PowerShell Gallery