PowerShell 모듈 매니페스트를 작성하는 방법

PowerShell 모듈을 작성한 후 모듈에 대한 정보를 포함하는 선택적 모듈 매니페스트를 추가할 수 있습니다. 예를 들어 작성자를 설명하고, 모듈에서 파일(예: 중첩된 모듈)을 지정하고, 스크립트를 실행하여 사용자 환경을 사용자 지정하고, 파일 형식 및 서식을 로드하고, 시스템 요구 사항을 정의하고, 모듈에서 내보내는 멤버를 제한할 수 있습니다.

모듈 매니페스트 만들기

모듈 매니페스트 모듈의 내용을 설명하고 모듈 처리 방법을 결정하는 PowerShell 데이터 파일(.psd1)입니다. 매니페스트 파일은 키와 값의 해시 테이블을 포함하는 텍스트 파일입니다. 매니페스트의 이름을 모듈과 동일하게 지정하고 모듈의 루트 디렉터리에 매니페스트를 저장하여 매니페스트 파일을 모듈에 연결합니다.

단일 .psm1 또는 이진 어셈블리만 포함하는 간단한 모듈의 경우 모듈 매니페스트는 선택 사항입니다. 하지만 코드를 구성하고 버전 관리 정보를 유지 관리하는 데 유용하므로 가능한 경우 모듈 매니페스트를 사용하는 것이 좋습니다. 또한 전역 어셈블리 캐시설치된 어셈블리를 내보내려면 모듈 매니페스트가 필요합니다. 또한 업다이블 도움말 기능을 지원하는 모듈에도 모듈 매니페스트가 필요합니다. 업데이트할 수 있는 도움말은 모듈 매니페스트의 HelpInfoUri 키를 사용하여 모듈에 대한 업데이트된 도움말 파일의 위치를 포함하는 도움말 정보(HelpInfo XML) 파일을 찾습니다. Updatable 도움말에 대한 자세한 내용은 지원 도움말참조하세요.

모듈 매니페스트를 만들고 사용하려면

1. 모듈 매니페스트를 만드는 가장 좋은 방법은 New-ModuleManifest cmdlet을 사용하는 것입니다. 매개 변수를 사용하여 매니페스트의 기본 키와 값을 하나 이상 지정할 수 있습니다. 유일한 요구 사항은 파일 이름을 지정하는 것입니다. New-ModuleManifest 지정된 값을 사용하여 모듈 매니페스트를 만들고 나머지 키와 해당 기본값을 포함합니다. 여러 모듈을 만들어야 하는 경우 New-ModuleManifest 사용하여 다른 모듈에 대해 수정할 수 있는 모듈 매니페스트 템플릿을 만듭니다. 기본 모듈 매니페스트의 예제는 샘플 모듈 매니페스트참조하세요.

   New-ModuleManifest -Path C:\myModuleName.psd1 -ModuleVersion "2.0" -Author "YourNameHere"

   또는 필요한 최소 정보인 ModuleVersion을 사용하여 모듈 매니페스트의 해시 테이블을 수동으로 만드는. 모듈과 동일한 이름으로 파일을 저장하고 .psd1 파일 확장명을 사용합니다. 그런 다음 파일을 편집하고 적절한 키와 값을 추가할 수 있습니다.

2. 매니페스트 파일에 원하는 요소를 추가합니다.

   매니페스트 파일을 편집하려면 원하는 텍스트 편집기를 사용합니다. 그러나 매니페스트 파일은 코드를 포함하는 스크립트 파일이므로 Visual Studio Code와 같은 스크립팅 또는 개발 환경에서 편집할 수 있습니다. ModuleVersion 번호를 제외하고 매니페스트 파일의 모든 요소는 선택 사항입니다.

   모듈 매니페스트에 포함할 수 있는 키 및 값에 대한 설명은 모듈 매니페스트 요소 테이블을 참조하세요. 자세한 내용은 New-ModuleManifest cmdlet의 매개 변수 설명을 참조하세요.

3. 기본 모듈 매니페스트 요소에서 다루지 않을 수 있는 시나리오를 해결하려면 모듈 매니페스트에 코드를 추가하는 옵션이 있습니다.

   보안 문제를 위해 PowerShell은 모듈 매니페스트 파일에서 사용 가능한 작업의 작은 하위 집합만 실행합니다. 일반적으로 if 문, 산술 및 비교 연산자 및 기본 PowerShell 데이터 형식을 사용할 수 있습니다.

4. 모듈 매니페스트를 만든 후에는 모듈 매니페스트를 테스트하여 매니페스트에 설명된 경로가 올바른지 확인할 수 있습니다. 모듈 매니페스트를 테스트하려면 Test-ModuleManifest사용합니다.

   Test-ModuleManifest myModuleName.psd1

5. 모듈 매니페스트가 모듈을 포함하는 디렉터리의 최상위 수준에 있는지 확인합니다.

   모듈을 시스템에 복사하고 가져올 때 PowerShell은 모듈 매니페스트를 사용하여 모듈을 가져옵니다.

6. 필요에 따라 매니페스트 자체를 도트 소싱하여 import-Module 호출하여 모듈 매니페스트를 직접 테스트할 수 있습니다.

   Import-Module .\myModuleName.psd1

모듈 매니페스트 요소

다음 표에서는 모듈 매니페스트에 포함할 수 있는 요소에 대해 설명합니다.

샘플 모듈 매니페스트

다음 샘플 모듈 매니페스트는 PowerShell 7에서 New-ModuleManifest 사용하여 만들어졌으며 기본 키와 값을 포함합니다.

#
# Module manifest for module 'SampleModuleManifest'
#
# Generated by: User01
#
# Generated on: 10/15/2019
#

@{

# Script module or binary module file associated with this manifest.
# RootModule = ''

# Version number of this module.
ModuleVersion = '0.0.1'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = 'b632e90c-df3d-4340-9f6c-3b832646bf87'

# Author of this module
Author = 'User01'

# Company or vendor of this module
CompanyName = 'Unknown'

# Copyright statement for this module
Copyright = '(c) User01. All rights reserved.'

# Description of the functionality provided by this module
# Description = ''

# Minimum version of the PowerShell engine required by this module
# PowerShellVersion = ''

# Name of the PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# CLRVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = @()

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = @()

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = @()

# DSC resources to export from this module
# DscResourcesToExport = @()

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

    PSData = @{

        # Tags applied to this module. These help with module discovery in online galleries.
        # Tags = @()

        # A URL to the license for this module.
        # LicenseUri = ''

        # A URL to the main website for this project.
        # ProjectUri = ''

        # A URL to an icon representing this module.
        # IconUri = ''

        # ReleaseNotes of this module
        # ReleaseNotes = ''

        # Prerelease string of this module
        # Prerelease = ''

        # Flag to indicate whether the module requires explicit user acceptance for install/update/save
        # RequireLicenseAcceptance = $false

        # External dependent modules of this module
        # ExternalModuleDependencies = @()

    } # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

참고하십시오

• 비교 연산자에 대한 정보
• 조건에_대하여
• 전역 어셈블리 캐시
• 모듈 가져오기
• New-ModuleManifest
• Test-ModuleManifest
• Update-ModuleManifest
• Windows PowerShell 모듈 작성