New-ModuleManifest

構文

New-ModuleManifest
   [-Path] <string>
   [-NestedModules <Object[]>]
   [-Guid <guid>]
   [-Author <string>]
   [-CompanyName <string>]
   [-Copyright <string>]
   [-RootModule <string>]
   [-ModuleVersion <version>]
   [-Description <string>]
   [-ProcessorArchitecture <ProcessorArchitecture>]
   [-PowerShellVersion <version>]
   [-ClrVersion <version>]
   [-DotNetFrameworkVersion <version>]
   [-PowerShellHostName <string>]
   [-PowerShellHostVersion <version>]
   [-RequiredModules <Object[]>]
   [-TypesToProcess <string[]>]
   [-FormatsToProcess <string[]>]
   [-ScriptsToProcess <string[]>]
   [-RequiredAssemblies <string[]>]
   [-FileList <string[]>]
   [-ModuleList <Object[]>]
   [-FunctionsToExport <string[]>]
   [-AliasesToExport <string[]>]
   [-VariablesToExport <string[]>]
   [-CmdletsToExport <string[]>]
   [-DscResourcesToExport <string[]>]
   [-CompatiblePSEditions <string[]>]
   [-PrivateData <Object>]
   [-Tags <string[]>]
   [-ProjectUri <uri>]
   [-LicenseUri <uri>]
   [-IconUri <uri>]
   [-ReleaseNotes <string>]
   [-HelpInfoUri <string>]
   [-PassThru]
   [-DefaultCommandPrefix <string>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

New-ModuleManifest コマンドレットは、新しいモジュール マニフェスト (.psd1) ファイルを作成し、その値を設定し、マニフェスト ファイルを指定したパスに保存します。

モジュール作成者は、このコマンドレットを使用して、モジュールのマニフェストを作成できます。 モジュール マニフェストは、ハッシュ テーブルを含む .psd1 ファイルです。 ハッシュ テーブルのキーと値は、モジュールの内容と属性を記述し、前提条件を定義し、コンポーネントの処理方法を決定します。 マニフェストは、モジュールには必要ありません。

New-ModuleManifest は、一般的に使用されるすべてのマニフェスト キーを含むマニフェストを作成するため、既定の出力をマニフェスト テンプレートとして使用できます。 値を追加または変更したり、このコマンドレットで追加しないモジュール キーを追加したりするには、結果のファイルをテキスト エディターで開きます。

各パラメーターは、Path と passThru を除き、モジュール マニフェスト キーとその値を作成します。 モジュール マニフェストでは、ModuleVersion キーのみが必要です。 パラメーターの説明で指定しない限り、コマンドからパラメーターを省略した場合、New-ModuleManifest は、影響を与えない関連する値のコメント文字列を作成します。

PowerShell 2.0 では、New-ModuleManifest は、コマンドで指定されていない一般的に使用されるパラメーターの値と、必要なパラメーター値の入力を求められます。 PowerShell 3.0 以降では、必要なパラメーター値が指定されていない場合にのみ、New-ModuleManifest プロンプトが表示されます。

PowerShell ギャラリーでモジュールを発行する予定の場合、マニフェストには特定のプロパティの値が含まれている必要があります。 詳細については、ギャラリー ドキュメントの「PowerShell ギャラリー に発行されたアイテムに必要なメタデータ」を参照してください。

例

例 1 - 新しいモジュール マニフェストを作成する

この例では、Path パラメーターで指定された新しいモジュール マニフェストをファイルに作成します。 PassThru パラメーターは、パイプラインとファイルに出力を送信します。

出力には、マニフェスト内のすべてのキーの既定値が表示されます。

New-ModuleManifest -Path C:\ps-test\Test-Module\Test-Module.psd1 -PassThru

#
# Module manifest for module 'Test-Module'
#
# Generated by: ContosoAdmin
#
# Generated on: 1/22/2019
#

@{

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

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

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = '47179120-0bcb-4f14-8d80-f4560107f85c'

# Author of this module
Author = 'ContosoAdmin'

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

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

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

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

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

# Minimum version of the Windows 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 = ''

    } # 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 = ''

}

例 2 - 事前設定された設定を使用して新しいマニフェストを作成する

この例では、新しいモジュール マニフェストを作成します。 PowerShellVersion と AliasesToExport パラメーターを使用して、対応するマニフェスト キーに値を追加します。

$moduleSettings = @{
    PowerShellVersion = 1.0
    Path   = 'C:\ps-test\ManifestTest.psd1'
    AliasesToExport   = @(
      'JKBC'
      'DRC'
      'TAC'
    )
}
New-ModuleManifest @moduleSettings

例 3 - 他のモジュールを必要とするマニフェストを作成する

この例では、文字列形式を使用して、BitsTransfer モジュールの名前とハッシュ テーブル形式を指定して、名前、GUID、および PSScheduledJob モジュールのバージョンを指定します。

$moduleSettings = @{
  RequiredModules = ("BitsTransfer", @{
    ModuleName="PSScheduledJob"
    ModuleVersion="1.0.0.0";
    GUID="50cdb55f-5ab7-489f-9e94-4ec21ff51e59"
  })
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

この例では、ModuleList、RequiredModules、および NestedModules パラメーターの文字列形式とハッシュ テーブル形式 使用する方法を示します。 文字列とハッシュ テーブルを同じパラメーター値に結合できます。

例 4 - 更新可能なヘルプをサポートするマニフェストを作成する

この例では、HelpInfoUri パラメーターを使用して、モジュール マニフェストに HelpInfoUri キーを作成します。 パラメーターとキーの値は、http で始まるか、https する必要があります。 この値は、モジュールの HelpInfo XML 更新可能ヘルプ情報ファイルを検索する場所を更新可能なヘルプ システムに指示します。

$moduleSettings = @{
  HelpInfoUri = 'http://https://go.microsoft.com/fwlink/?LinkID=603'
  Path = 'C:\ps-test\ManifestTest.psd1'
}
New-ModuleManifest @moduleSettings

更新可能なヘルプについては、「about_Updatable_Help」を参照してください。 HelpInfo XML ファイルの詳細については、更新可能なヘルプ のサポートを参照してください。

例 5 - モジュール情報の取得

この例では、モジュールの構成値を取得する方法を示します。 モジュール マニフェストの値は、モジュール オブジェクトのプロパティの値に反映されます。

Get-Module コマンドレットは、List パラメーターを使用して microsoft.PowerShell.Diagnostics モジュール を取得するために使用されます。 このコマンドはモジュールを Format-List コマンドレットに送信して、モジュール オブジェクトのすべてのプロパティと値を表示します。

Get-Module Microsoft.PowerShell.Diagnostics -List | Format-List -Property *

LogPipelineExecutionDetails : False
Name                        : Microsoft.PowerShell.Diagnostics
Path                        : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics\Micro
                              soft.PowerShell.Diagnostics.psd1
Definition                  :
Description                 :
Guid                        : ca046f10-ca64-4740-8ff9-2565dba61a4f
HelpInfoUri                 : https://go.microsoft.com/fwlink/?LinkID=210596
ModuleBase                  : C:\Windows\system32\WindowsPowerShell\v1.0\Modules\Microsoft.PowerShell.Diagnostics
PrivateData                 :
Version                     : 3.0.0.0
ModuleType                  : Manifest
Author                      : Microsoft Corporation
AccessMode                  : ReadWrite
ClrVersion                  : 4.0
CompanyName                 : Microsoft Corporation
Copyright                   : Microsoft Corporation. All rights reserved.
DotNetFrameworkVersion      :
ExportedFunctions           : {}
ExportedCmdlets             : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
ExportedCommands            : {[Get-WinEvent, Get-WinEvent], [Get-Counter, Get-Counter], [Import-Counter,
                              Import-Counter], [Export-Counter, Export-Counter]...}
FileList                    : {}
ModuleList                  : {}
NestedModules               : {}
PowerShellHostName          :
PowerShellHostVersion       :
PowerShellVersion           : 3.0
ProcessorArchitecture       : None
Scripts                     : {}
RequiredAssemblies          : {}
RequiredModules             : {}
RootModule                  :
ExportedVariables           : {}
ExportedAliases             : {}
ExportedWorkflows           : {}
SessionState                :
OnRemove                    :
ExportedFormatFiles         : {C:\Windows\system32\WindowsPowerShell\v1.0\Event.format.ps1xml,
                              C:\Windows\system32\WindowsPowerShell\v1.0\Diagnostics.format.ps1xml}
ExportedTypeFiles           : {C:\Windows\system32\WindowsPowerShell\v1.0\GetEvent.types.ps1xml}

パラメーター

-AliasesToExport

-Author

-ClrVersion

-CmdletsToExport

-CompanyName

-CompatiblePSEditions

-Confirm

-Copyright

-DefaultCommandPrefix

-Description

-DotNetFrameworkVersion

-DscResourcesToExport

-FileList

-FormatsToProcess

-FunctionsToExport

-Guid

-HelpInfoUri

-IconUri

-LicenseUri

-ModuleList

-ModuleVersion

-NestedModules

-PassThru

-Path

-PowerShellHostName

-PowerShellHostVersion

-PowerShellVersion

-PrivateData

-ProcessorArchitecture

-ProjectUri

-ReleaseNotes

-RequiredAssemblies

-RequiredModules

-RootModule

-ScriptsToProcess

-Tags

-TypesToProcess

-VariablesToExport

-WhatIf

入力

None

このコマンドレットにオブジェクトをパイプすることはできません。

出力

None

既定では、このコマンドレットは出力を返しません。

String

PassThru パラメーターを使用すると、このコマンドレットはモジュール マニフェストを表す文字列を返します。

メモ

New-ModuleManifest、UTF16 としてエンコードされたモジュール マニフェスト (.psd1) ファイル作成します。

通常、モジュール マニフェストは省略可能です。 ただし、グローバル アセンブリ キャッシュにインストールされているアセンブリをエクスポートするには、モジュール マニフェストが必要です。

$pshome\Modules ディレクトリにファイルを追加または変更するには、[管理者として実行] オプションを使用して PowerShell を起動します。

PowerShell 2.0 では、モジュール マニフェストでは必須でなくても、New-ModuleManifest の多くのパラメーターが必須でした。 PowerShell 3.0 以降では、Path パラメーターのみが必須です。

セッションは、PowerShell 実行環境のインスタンスです。 セッションには、1 つ以上のセッション状態を含めることができます。 既定では、セッションはグローバル セッション状態のみですが、インポートされた各モジュールには独自のセッション状態があります。 セッション状態を使用すると、モジュール内のコマンドをグローバル セッション状態に影響を与えずに実行できます。

呼び出し元のセッション状態は、モジュールがインポートされるセッション状態です。 通常はグローバル セッション状態を参照しますが、モジュールが入れ子になったモジュールをインポートする場合、呼び出し元はモジュールであり、呼び出し元のセッション状態はモジュールのセッション状態です。

関連リンク

• Export-ModuleMember
• Get-Module
• Import-Module
• New-Module
• Remove-Module
• Test-ModuleManifest
• about_Modules