about_Module_Manifests

[アーティクル]
11/06/2024

簡単な説明

モジュールマニフェストファイルを記述するための設定とプラクティスについて説明します。

詳細な説明

モジュールマニフェストは、ハッシュテーブルを含む PowerShell データファイル (.psd1) です。ハッシュテーブルのキーと値のペアは、モジュールの内容と属性を記述し、前提条件を定義し、コンポーネントの処理方法を制御します。

マニフェストはモジュールを読み込むには必要ありませんが、モジュールをPowerShell ギャラリーに発行する必要があります。マニフェストを使用すると、モジュールの実装を読み込み方法から分離することもできます。マニフェストを使用すると、要件、互換性、読み込み順序などを定義できます。

マニフェストの設定にパラメーターを指定せずに New-ModuleManifest を使用すると、最小限のマニフェストファイルが書き込まれます。次のスニペットは、この既定の出力を示しています。簡潔にするために解説と間隔が切り取られています。

@{
# RootModule = ''
ModuleVersion = '1.0'
# CompatiblePSEditions = @()
GUID = 'e7184b71-2527-469f-a50e-166b612dfb3b'
Author = 'username'
CompanyName = 'Unknown'
Copyright = '(c) 2022 username. All rights reserved.'
# Description = ''
# PowerShellVersion = ''
# PowerShellHostName = ''
# PowerShellHostVersion = ''
# DotNetFrameworkVersion = ''
# CLRVersion = ''
# ProcessorArchitecture = ''
# RequiredModules = @()
# RequiredAssemblies = @()
# ScriptsToProcess = @()
# TypesToProcess = @()
# FormatsToProcess = @()
# NestedModules = @()
FunctionsToExport = @()
CmdletsToExport = @()
VariablesToExport = '*'
AliasesToExport = @()
# DscResourcesToExport = @()
# ModuleList = @()
# FileList = @()
PrivateData = @{
    PSData = @{
        # Tags = @()
        # LicenseUri = ''
        # ProjectUri = ''
        # IconUri = ''
        # ReleaseNotes = ''
    } # End of PSData hashtable
} # End of PrivateData hashtable
# HelpInfoURI = ''
# DefaultCommandPrefix = ''
}

モジュールを発行する前に、 Test-ModuleManifest を使用してモジュールマニフェストを検証できます。 Test-ModuleManifest は、マニフェストが無効な場合、またはセッションがマニフェストに設定されている要件を満たしていないために、モジュールを現在のセッションにインポートできない場合にエラーを返します。

モジュールマニフェストでのスクリプトコードの使用

マニフェストファイル内の設定に割り当てられる値は、PowerShell によって評価される式にすることができます。これにより、パスを構築し、変数に基づいて値を条件付きで割り当てることができます。

Import-Moduleを使用してモジュールをインポートすると、マニフェストは言語モードRestricted評価されます。 Restricted モードでは、使用できるコマンドと変数が制限されます。

許可されるコマンド

Import-LocalizedData
ConvertFrom-StringData
Write-Host
Out-Host
Join-Path

使用できる変数

$PSScriptRoot
$PSEdition
$EnabledExperimentalFeatures
環境変数 (例: $ENV:TEMP

詳細については、「 about_Language_Modes」を参照してください。

マニフェストの設定

次のセクションでは、モジュールマニフェストで使用可能なすべての設定とその使用方法について詳しく説明します。これらは、設定の概要から始まり、その後に次の一覧を示すマトリックスが続きます。

入力の種類: マニフェストでこの設定に指定できるオブジェクトの種類。
必須: この値がYesの場合、モジュールのインポートとPowerShell ギャラリーへの発行の両方に設定が必要です。 Noの場合は、どちらも必要ありません。 PowerShell Gallery場合は、PowerShell ギャラリーへの発行にのみ必要です。
[未設定の場合の値: この設定がインポート時に持つ値であり、明示的に設定されていません。
ワイルドカードを受け入れます: この設定でワイルドカード値を使用できるかどうかを指定します。

RootModule

この設定では、モジュールのプライマリファイルまたはルートファイルを指定します。モジュールがインポートされると、ルートモジュールファイルによってエクスポートされたメンバーが呼び出し元のセッション状態にインポートされます。

	Value
[Input Type](入力の種類)	`System.String`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

値は、次のいずれかのパスである必要があります。

スクリプト (.ps1)
スクリプトモジュール (.psm1)
モジュールマニフェスト (.psd1)
アセンブリ (.dll)
コマンドレット定義 XML ファイル (.cdxml)
Windows PowerShell 5.1 ワークフロー (.xaml)

パスは、モジュールマニフェストに対する相対パスである必要があります。

RootModule キーにルートファイルが指定されていないモジュールマニフェストがある場合、マニフェストはモジュールのプライマリファイルになり、モジュールはマニフェストモジュール (ModuleType = Manifest) になります。 RootModuleが定義されている場合、モジュールの型は、使用されるファイル拡張子から決定されます。

.ps1または.psm1 ファイルは、モジュールの種類を Script にします
.psd1 ファイルを使用すると、モジュールの種類が Manifest になります
.dll ファイルを使用すると、モジュールの種類が Binary になります
.cdxml ファイルでは、モジュールの種類が CIM になります
.xaml ファイルを使用すると、モジュールの種類が Workflow になります

既定では、 RootModule 内のすべてのモジュールメンバーがエクスポートされます。

ヒント

モジュールの読み込み速度は、 Binary、 Script、 CIM モジュールの種類によって異なります。詳細については、「 PowerShell モジュールの作成に関する考慮事項」を参照してください。

たとえば、このモジュールの ModuleType は Manifest です。このモジュールがエクスポートできるモジュールメンバーは、 NestedModules 設定で指定されたモジュールで定義されているメンバーだけです。

@{
    RootModule = ''
}

Note

この設定は、モジュールマニフェストで ModuleToProcess として指定することもできます。この設定の名前は有効ですが、代わりに RootModule を使用することをお勧めします。

ModuleVersion

この設定では、モジュールのバージョンを指定します。 1 つのシステムに複数のバージョンのモジュールが存在する場合、 Import-Moduleを実行すると、既定で最新バージョンが読み込まれます。

	Value
[Input Type](入力の種類)	`System.String`
必須	はい
未設定の場合の値	なし
ワイルドカードを受け入れます	いいえ

この設定の値は、System.Versionの実行時にImport-Moduleに変換できる必要があります。

たとえば、このマニフェストはモジュールのバージョンを '1.2.3'として宣言します。

@{
    ModuleVersion = '1.2.3'
}

モジュールをインポートし、 Version プロパティを調べると、 System.Version オブジェクトであり、文字列ではないことに注意してください。

$ExampleModule = Import-Module example.psd1
$ExampleModule.Version
$ExampleModule.Version.GetType().Name

Major  Minor  Build  Revision
-----  -----  -----  --------
1      2      3      -1

Version

CompatiblePSEditions

この設定では、モジュールの互換性のある PSEdition を指定します。

	Value
[Input Type](入力の種類)	`System.String[]`
受け入れ可能な値	`Desktop`, `Core`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

この設定の値が $null場合、セッションの PSEdition に関係なく、モジュールをインポートできます。この値は、1 つ以上の受け入れ可能な値に設定できます。

PSEdition の詳細については、以下を参照してください。

この設定が定義されている場合、モジュールは、 $PSEdition 自動変数の値が設定に含まれるセッションにのみインポートできます。

Note

$PSEdition自動変数はバージョン 5.1 で導入されたため、以前のバージョンの Windows PowerShell では、CompatiblePSEditions 設定を使用するモジュールを読み込めませんでした。

たとえば、任意のセッションでこのモジュールマニフェストをインポートできます。

@{
    # CompatiblePSEditions = @()
}

この設定を指定すると、このモジュールは、 $PSEdition 自動変数の値が Coreされているセッションでのみインポートできます。

@{
    CompatiblePSEditions = @('Core')
}

GUID

この設定では、モジュールの一意識別子を指定します。 GUID は、同じ名前のモジュールを区別するために使用されます。

	Value
[Input Type](入力の種類)	`System.String`
必須	いいえ
未設定の場合の値	`00000000-0000-0000-0000-000000000000`
ワイルドカードを受け入れます	いいえ

この設定の値は、System.Guidの実行時にImport-Moduleに変換できる必要があります。

注意事項

必須の設定ではありませんが、マニフェストで GUID を指定しない場合、利点はなく、モジュールの名前の競合につながる可能性があります。

マニフェストで使用する新しい guid を作成できます。

New-Guid | Select-Object -ExpandProperty Guid

8456b025-2fa5-4034-ae47-e6305f3917ca

@{
    GUID = '8456b025-2fa5-4034-ae47-e6305f3917ca'
}

マシン上に同じ名前の別のモジュールがある場合でも、モジュールの完全修飾名を指定して必要なモジュールをインポートできます。

Import-Module -FullyQualifiedName @{
    ModuleName    = 'Example'
    GUID          = '8456b025-2fa5-4034-ae47-e6305f3917ca'
    ModuleVersion = '1.0.0'
}

作成者

この設定は、モジュールの作成者を識別します。

	Value
[Input Type](入力の種類)	`System.String`
必須	PowerShell ギャラリー
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

このマニフェストは、モジュールの作成者が Contoso 開発者エクスペリエンスチームであることを宣言します。

@{
    Author = 'Contoso Developer Experience Team'
}

CompanyName

この設定は、モジュールを作成した会社またはベンダーを識別します。

	Value
[Input Type](入力の種類)	`System.String`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

このマニフェストは、モジュールが Contoso, Ltd によって作成されたことを宣言します。

@{
    CompanyName = 'Contoso, Ltd.'
}

著作権

この設定では、モジュールの著作権に関する声明を指定します。

	Value
[Input Type](入力の種類)	`System.String`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

このマニフェストは、2022 年の時点で Contoso, Ltd. に対するすべての権利を予約する著作権に関する声明を宣言します。

@{
    Copyright = '(c) 2022 Contoso, Ltd. All rights reserved.'
}

説明

この設定では、モジュールについて大まかに説明します。

	Value
[Input Type](入力の種類)	`System.String`
必須	PowerShell ギャラリー
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

このマニフェストには、簡単な説明が含まれています。 here 文字列を使用して、より長い説明または複数行の説明を記述することもできます。

@{
    Description = 'Example commands to show a valid module manifest'
}

PowerShellVersion

この設定では、このモジュールで必要な PowerShell の最小バージョンを指定します。

	Value
[Input Type](入力の種類)	`System.String`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

この設定の値は、System.Versionの実行時にImport-Moduleに変換できる必要があります。

この設定が設定されていない場合、PowerShell は現在のバージョンに基づいてモジュールのインポートを制限しません。

たとえば、このマニフェストは、モジュールが PowerShell および Windows PowerShell のすべてのバージョンと互換性があることを宣言します。

@{
    # PowerShellVersion = ''
}

PowerShellVersionを7.2に設定すると、PowerShell 7.2 以降でのみモジュールをインポートできます。

@{
    PowerShellVersion = '7.2'
}

PowerShellHostName

この設定では、モジュールに必要な PowerShell ホストプログラムの名前 ( Windows PowerShell ISE Host または ConsoleHost など) を指定します。

	Value
[Input Type](入力の種類)	`System.String`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

$Host.Name ステートメントを使用して、セッションのホストの名前を確認できます。たとえば、リモートセッションのホストが ConsoleHost ではなくserverRemoteHostされていることがわかります

$Host.Name
Enter-PSSession -ComputerName localhost
$Host.Name

ConsoleHost
[localhost]: PS C:\Users\username\Documents> $Host.Name
ServerRemoteHost

このモジュールは、任意のホストにインポートできます。

@{
    # PowerShellHostName = ''
}

PowerShellHostNameを ServerRemoteHost に設定すると、リモート PowerShell セッションにのみモジュールをインポートできます。

@{
    PowerShellHostName = 'ServerRemoteHost'
}

PowerShellHostVersion

この設定では、モジュールに必要な PowerShell ホストプログラムの最小バージョンを指定します。

	Value
[Input Type](入力の種類)	`System.String`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

この設定の値は、System.Versionの実行時にImport-Moduleに変換できる必要があります。

注意事項

この設定は PowerShellHostName 設定なしで使用できますが、予期しない動作の可能性が高くなります。この設定は、 PowerShellHostName 設定も使用している場合にのみ使用します。

たとえば、このマニフェストのモジュールは、ホストのバージョンに関係なく、 ConsoleHost で実行されている任意の PowerShell セッションからインポートできます。

@{
    PowerShellHostName = 'ConsoleHost'
    # PowerShellHostVersion = ''
}

PowerShellHostVersionを5.1に設定すると、ホストのバージョンが 5.1 以上の ConsoleHost で実行されている PowerShell セッションからのみモジュールをインポートできます。

@{
    PowerShellHostName    = 'ConsoleHost'
    PowerShellHostVersion = '5.1'
}

DotNetFrameworkVersion

この設定では、モジュールに必要な Microsoft .NET Framework の最小バージョンを指定します。

	Value
[Input Type](入力の種類)	`System.String`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

Note

この設定は、Windows PowerShell 5.1 などの PowerShell Desktop エディションでのみ有効であり、4.5 未満の .NET Framework バージョンにのみ適用されます。この要件は、新しいバージョンの PowerShell または .NET Framework には影響しません。

この設定の値は、System.Versionの実行時にImport-Moduleに変換できる必要があります。

たとえば、このマニフェストでは、Microsoft .NET Framework のバージョンに関係なく、そのモジュールを任意の PowerShell または Windows PowerShell セッションにインポートできることを宣言します。

@{
    # DotNetFrameworkVersion = ''
}

DotNetFrameworkVersionを 4.0 に設定すると、Microsoft .NET Framework の最新バージョンが 4.0 以上である Windows PowerShell の任意のセッションでこのモジュールをインポートできます。任意の PowerShell セッションでインポートすることもできます。

@{
    DotNetFrameworkVersion = '4.0'
}

CLRVersion

この設定では、モジュールに必要な Microsoft .NET Framework の共通言語ランタイム (CLR) の最小バージョンを指定します。

	Value
[Input Type](入力の種類)	`System.String`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

Note

この設定の値は、System.Versionの実行時にImport-Moduleに変換できる必要があります。

たとえば、このマニフェストでは、Microsoft .NET Framework の CLR バージョンのバージョンに関係なく、そのモジュールを任意の PowerShell または Windows PowerShell セッションにインポートできることを宣言します。

@{
    # CLRVersion = ''
}

CLRVersionを 4.0 に設定すると、使用可能な CLR の最新バージョンが少なくとも 4.0 である Windows PowerShell の任意のセッションでこのモジュールをインポートできます。任意の PowerShell セッションでインポートすることもできます。

@{
    CLRVersion = '4.0'
}

ProcessorArchitecture

この設定では、モジュールに必要なプロセッサアーキテクチャを指定します。

	Value
[Input Type](入力の種類)	`System.String`
受け入れ可能な値	`None`、 `MSIL`、 `X86`、 `IA64`、 `Amd64`、 `Arm`
必須	いいえ
未設定の場合の値	`None`
ワイルドカードを受け入れます	いいえ

この設定の値は、System.Reflection.ProcessorArchitectureの実行時にImport-Moduleに変換できる必要があります。

たとえば、このマニフェストは、システムのプロセッサアーキテクチャに関係なく、任意のセッションでモジュールをインポートできることを宣言します。

@{
    # ProcessorArchitecture = ''
}

ProcessorArchitectureを Amd64 に設定すると、このモジュールは、一致するアーキテクチャを持つマシンで実行されているセッションにのみインポートできます。

@{
    ProcessorArchitecture = 'Amd64'
}

RequiredModules

この設定では、グローバルセッション状態である必要があるモジュールを指定します。必要なモジュールがグローバルセッション状態でない場合は、PowerShell によってインポートされます。必要なモジュールが使用できない場合、 Import-Module コマンドは失敗します。

	Value
[Input Type](入力の種類)	`System.String[]`, `System.Collections.Hashtable[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

この設定のエントリには、モジュール名、完全なモジュール仕様、またはモジュールファイルへのパスを指定できます。

値がパスの場合、パスは完全修飾または相対パスにすることができます。

値が名前またはモジュールの指定である場合、PowerShell は指定されたモジュールの PSModulePath を検索します。

モジュール仕様は、次のキーを持つハッシュテーブルです。

ModuleName - 必須。モジュール名を指定します。
GUID - 省略可。 モジュールの GUID を指定します。
また、以下の 3 つのキーのうち少なくとも 1 つを指定Required です。 RequiredVersion キーは、ModuleVersionキーまたはMaximumVersion キーでは使用できません。 ModuleVersionキーとMaximumVersionキーを一緒に指定することで、モジュールの許容可能なバージョン範囲を定義できます。
- ModuleVersion - モジュールの最小許容バージョンを指定します。
- RequiredVersion - モジュールの正確で必要なバージョンを指定します。
- MaximumVersion - モジュールの許容される最大バージョンを指定します。

Note

RequiredVersion は Windows PowerShell 5.0 で追加されました。 MaximumVersion は Windows PowerShell 5.1 で追加されました。

たとえば、このマニフェストは、そのモジュールがその機能に他のモジュールを必要としないことを宣言します。

@{
    # RequiredModules = @()
}

このマニフェストでは、PSReadLine モジュールが必要であることを宣言します。このマニフェストで Import-Module を実行すると、PowerShell はセッションで使用できる最新バージョンの PSReadLine をインポートします。使用可能なバージョンがない場合、インポートはエラーを返します。

@{
    RequiredModules = @(
        'PSReadLine'
    )
}

ヒント

PowerShell 2.0 では、 Import-Module は必要なモジュールを自動的にインポートしません。必要なモジュールがグローバルセッション状態であることを確認するだけです。

このマニフェストでは、独自のモジュールフォルダーにベンダー化された PSReadLine モジュールのバージョンが必要であることを宣言します。このマニフェストで Import-Module を実行すると、PowerShell は指定されたパスからベンダー化された PSReadLine をインポートします。

@{
    RequiredModules = @(
        'Vendored\PSReadLine\PSReadLine.psd1'
    )
}

このマニフェストは、PSReadLine モジュールのバージョン 2.0.0 が特に必要であることを宣言します。このマニフェストで Import-Module を実行すると、使用可能な場合、PowerShell は PSReadLine のバージョン 2.0.0 をインポートします。使用できない場合、 Import-Module はエラーを返します。

@{
    RequiredModules = @(
        @{
            ModuleName      = 'PSReadLine'
            RequiredVersion = '2.0.0'
        }
    )
}

このマニフェストでは、PSReadLine モジュールをバージョン 2.0.0 以降でインポートする必要があることを宣言します。

@{
    RequiredModules = @(
        @{
            ModuleName    = 'PSReadLine'
            ModuleVersion = '2.0.0'
        }
    )
}

このマニフェストでは、PSReadLine モジュールをバージョン 2.0.0 以下でインポートする必要があることを宣言します。

@{
    RequiredModules = @(
        @{
            ModuleName     = 'PSReadLine'
            MaximumVersion = '2.0.0'
        }
    )
}

このマニフェストでは、PSDesiredStateConfiguration モジュールを 2.0.0 以上で 2.99.99 以下のバージョンでインポートする必要があることを宣言します。

@{
    RequiredModules = @(
        @{
            ModuleName     = 'PSDesiredStateConfiguration'
            ModuleVersion  = '2.0.0'
            MaximumVersion = '2.99.99'
        }
    )
}

RequiredAssemblies

この設定では、モジュールに必要なアセンブリ (.dll) ファイルを指定します。 PowerShell は、型または形式の更新、入れ子になったモジュールのインポート、または RootModule キーの値で指定されたモジュールファイルのインポートを行う前に、指定したアセンブリを読み込みます。

	Value
[Input Type](入力の種類)	`System.String[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

この設定のエントリには、アセンブリのファイル名またはパスを指定できます。 NestedModules設定でバイナリモジュールとしても一覧表示されている場合でも、必要なすべてのアセンブリを一覧表示します。

このマニフェストには、 example.dll アセンブリが必要です。このマニフェストで指定された書式ファイルまたは型ファイルを読み込む前に、PowerShell はモジュールマニフェストと同じディレクトリにある example.dll フォルダーからAssembliesを読み込みます。

@{
    RequiredAssemblies = @(
        'Assemblies\Example.dll'
    )
}

ScriptsToProcess

この設定では、モジュールのインポート時に呼び出し元のセッション状態で実行されるスクリプト (.ps1) ファイルを指定します。ログインスクリプトを使用する場合と同様に、これらのスクリプトを使用して、環境を準備できます。

	Value
[Input Type](入力の種類)	`System.String[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

モジュールのセッション状態で実行されるスクリプトを指定するには、 NestedModules キーを使用します。

このマニフェストをインポートすると、PowerShell は現在のセッションで Initialize.ps1 を実行します。

@{
    ScriptsToProcess = @(
        'Scripts\Initialize.ps1'
    )
}

たとえば、 Initialize.ps1 が情報メッセージを書き込み、 $ExampleState 変数を設定する場合は、次のようになります。

if ([string]::IsNullOrEmpty($ExampleState)) {
    Write-Information "Example not initialized."
    Write-Information "Initializing now..."
    $ExampleState = 'Initialized'
} else {
    Write-Information "Example already initialized."
}

モジュールをインポートすると、スクリプトが実行され、それらのメッセージが書き込まれると、セッションに $ExampleState 設定されます。

$InformationPreference = 'Continue'
"Example State is: $ExampleState"
Import-Module .\example7x.psd1
"Example State is: $ExampleState"
Import-Module .\example7x.psd1 -Force

Example State is:

Example not initialized.
Initializing now...

Example State is: Initialized

Example already initialized.

TypesToProcess

この設定では、モジュールのインポート時に実行される型ファイル (.ps1xml) を指定します。

	Value
[Input Type](入力の種類)	`System.String[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

モジュールをインポートすると、PowerShell は指定されたファイルを使用して Update-TypeData コマンドレットを実行します。型ファイルはスコープ設定されていないため、セッション内のすべてのセッション状態に影響します。

タイプファイルの詳細については、「 about_Types.ps1xml」を参照してください。

たとえば、このマニフェストをインポートすると、PowerShell はモジュールマニフェストと同じディレクトリにある Example.ps1xml フォルダーから、Types ファイルで指定された型を読み込みます。

@{
    TypesToProcess = @(
        'Types\Example.ps1xml'
    )
}

FormatsToProcess

この設定では、モジュールのインポート時に実行される書式設定ファイル (.ps1xml) を指定します。

	Value
[Input Type](入力の種類)	`System.String[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

モジュールをインポートすると、PowerShell は指定されたファイルを使用して Update-FormatData コマンドレットを実行します。フォーマットファイルはスコープ設定されていないため、セッション内のすべてのセッション状態に影響します。

タイプファイルの詳細については、「 about_Format.ps1xml」を参照してください。

たとえば、このモジュールをインポートすると、PowerShell はモジュールマニフェストと同じディレクトリにある Example.ps1xml フォルダーから、Formats ファイルで指定された形式を読み込みます。

@{
    FormatsToProcess = @(
        'Formats\Example.ps1xml'
    )
}

NestedModules

この設定では、モジュールのセッション状態にインポートされるスクリプトモジュール (.psm1) とバイナリモジュール (.dll) を指定します。スクリプトファイル (.ps1) を指定することもできます。この設定のファイルは、一覧表示されている順序で実行されます。

	Value
[Input Type](入力の種類)	`System.String[]`, `System.Collections.Hashtable[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

この設定のエントリには、モジュール名、完全なモジュール仕様、またはモジュールまたはスクリプトファイルへのパスを指定できます。

値がパスの場合、パスは完全修飾または相対パスにすることができます。

値がモジュール名または仕様の場合、PowerShell は指定されたモジュールの PSModulePath を検索します。

モジュール仕様は、次のキーを持つハッシュテーブルです。

ModuleName - 必須。モジュール名を指定します。
GUID - 省略可。 モジュールの GUID を指定します。
また、以下の 3 つのキーのうち少なくとも 1 つを指定Required です。 RequiredVersion キーは、ModuleVersionキーまたはMaximumVersion キーでは使用できません。 ModuleVersionキーとMaximumVersionキーを一緒に指定することで、モジュールの許容可能なバージョン範囲を定義できます。
- ModuleVersion - モジュールの最小許容バージョンを指定します。
- RequiredVersion - モジュールの正確で必要なバージョンを指定します。
- MaximumVersion - モジュールの許容される最大バージョンを指定します。

Note

RequiredVersion は Windows PowerShell 5.0 で追加されました。 MaximumVersion は Windows PowerShell 5.1 で追加されました。

入れ子になったモジュールからエクスポートする必要がある項目は、 Export-ModuleMember コマンドレットを使用して入れ子になったモジュールによってエクスポートするか、エクスポートプロパティのいずれかに一覧表示する必要があります。

FunctionsToExport
CmdletsToExport
VariablesToExport
AliasesToExport

モジュールセッション状態の入れ子になったモジュールはルートモジュールで使用できますが、呼び出し元のセッション状態の Get-Module コマンドからは返されません。

この設定に一覧表示されているスクリプト (.ps1) は、呼び出し元のセッション状態ではなく、モジュールのセッション状態で実行されます。呼び出し元のセッション状態でスクリプトを実行するには、 ScriptsToProcess 設定でスクリプトファイル名を一覧表示します。

たとえば、このマニフェストをインポートすると、 Helpers.psm1 モジュールがルートモジュールのセッション状態に読み込まれます。入れ子になったモジュールで宣言されたコマンドレットは、特に制限がない限りエクスポートされます。

@{
    NestedModules = @(
        'Helpers\Helpers.psm1'
    )
}

FunctionsToExport

この設定では、モジュールがエクスポートする関数を指定します。この設定を使用して、モジュールによってエクスポートされる関数を制限できます。エクスポートされた関数の一覧から関数を削除することはできますが、関数をリストに追加することはできません。

	Value
[Input Type](入力の種類)	`System.String[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	はい

この設定では、ワイルドカードを使用してエントリを指定できます。エクスポートされた関数の一覧で一致するすべての関数がエクスポートされます。

ヒント

パフォーマンスと検出可能性を高めるには、ワイルドカードを使用せずに、モジュールでこの設定でエクスポートする関数を常に明示的に一覧表示する必要があります。

たとえば、設定がコメントアウトされたモジュールをインポートすると、ルートモジュール内のすべての関数と入れ子になったモジュールがエクスポートされます。

@{
    # FunctionsToExport = @()
}

このマニフェストは、設定をまったく指定しないのと機能的に同じです。

@{
    FunctionsToExport = '*'
}

FunctionsToExportを空の配列として設定すると、このモジュールをインポートするときに、ルートモジュールまたは入れ子になったモジュールのエクスポートを使用できる関数はありません。

@{
    FunctionsToExport = @()
}

Note

New-ModuleManifest コマンドを使用してモジュールマニフェストを作成し、FunctionsToExport パラメーターを指定しない場合、作成されたマニフェストでは、この設定が空の配列として指定されます。マニフェストを編集しない限り、モジュールの関数はエクスポートされません。

FunctionsToExport ではGet-Example関数のみを含むように設定されます。このモジュールをインポートすると、ルートモジュールまたは入れ子になったモジュールによって他の関数がエクスポートされた場合でも、Get-Example関数のみが使用できるようになります。

@{
    FunctionsToExport = @(
        'Get-Example'
    )
}

FunctionsToExport ではワイルドカード文字列を使用して設定します。このモジュールをインポートすると、ルートモジュールまたは入れ子になったモジュールによって他の関数がモジュールメンバーとしてエクスポートされた場合でも、名前が Example で終わる関数が使用可能になります。

@{
    FunctionsToExport = @(
        '*Example'
    )
}

CmdletsToExport

この設定では、モジュールがエクスポートするコマンドレットを指定します。この設定を使用して、モジュールによってエクスポートされるコマンドレットを制限できます。エクスポートされたモジュールメンバーの一覧からコマンドレットを削除できますが、一覧にコマンドレットを追加することはできません。

	Value
[Input Type](入力の種類)	`System.String[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	はい

この設定では、ワイルドカードを使用してエントリを指定できます。エクスポートされたコマンドレットの一覧で一致するすべてのコマンドレットがエクスポートされます。

ヒント

パフォーマンスと検出可能性を高めるには、ワイルドカードを使用せずに、モジュールでこの設定でエクスポートするコマンドレットを常に明示的に一覧表示する必要があります。

たとえば、この設定がコメントアウトされたモジュールをインポートすると、ルートモジュール内のすべてのコマンドレットと入れ子になったモジュールがエクスポートされます。

@{
    # CmdletsToExport = @()
}

このマニフェストは、設定をまったく指定しないのと機能的に同じです。

@{
    CmdletsToExport = '*'
}

CmdletsToExportを空の配列として設定すると、このモジュールをインポートするときに、ルートモジュールまたは入れ子になったモジュールのエクスポートを使用できるコマンドレットはありません。

@{
    CmdletsToExport = @()
}

Note

New-ModuleManifest コマンドを使用してモジュールマニフェストを作成し、CmdletsToExport パラメーターを指定しない場合、作成されたマニフェストでは、この設定が空の配列として指定されます。マニフェストを編集しない限り、モジュールのコマンドレットはエクスポートされません。

CmdletsToExport ではGet-Exampleコマンドレットのみを含むように設定されます。このモジュールをインポートすると、ルートモジュールまたは入れ子になったモジュールによって他のコマンドレットがエクスポートされた場合でも、Get-Example コマンドレットのみが使用可能になります。

@{
    CmdletsToExport = @(
        'Get-Example'
    )
}

CmdletsToExport ではワイルドカード文字列を使用して設定します。このモジュールをインポートすると、ルートモジュールまたは入れ子になったモジュールによって他のコマンドレットがモジュールメンバーとしてエクスポートされた場合でも、名前が Example で終わるコマンドレットが使用可能になります。

@{
    CmdletsToExport = @(
        '*Example'
    )
}

VariablesToExport

この設定では、モジュールがエクスポートする変数を指定します。この設定を使用して、モジュールによってエクスポートされる変数を制限できます。エクスポートされたモジュールメンバーの一覧から変数を削除できますが、リストに変数を追加することはできません。

	Value
[Input Type](入力の種類)	`System.String[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	はい

この設定では、ワイルドカードを使用してエントリを指定できます。エクスポートされたモジュールメンバーのリスト内の一致するすべての変数がエクスポートされます。

ヒント

パフォーマンスと検出可能性を高めるには、ワイルドカードを使用せずに、モジュールでこの設定でエクスポートする変数を常に明示的に一覧表示する必要があります。

たとえば、この設定がコメントアウトされたモジュールをインポートすると、ルートモジュール内のすべての変数と入れ子になったモジュールがエクスポートされます。

@{
    # VariablesToExport = @()
}

このマニフェストは、設定をまったく指定しないのと機能的に同じです。

@{
    VariablesToExport = '*'
}

Note

New-ModuleManifest コマンドを使用してモジュールマニフェストを作成し、VariablesToExport パラメーターを指定しない場合、作成されたマニフェストにはこの設定が'*'として指定されます。マニフェストを編集しない限り、モジュールのすべての変数がエクスポートされます。

VariablesToExportを空の配列として設定すると、このモジュールをインポートするときに、ルートモジュールまたは入れ子になったモジュールのエクスポートを使用できる変数はありません。

@{
    VariablesToExport = @()
}

VariablesToExport ではSomeExample変数のみを含むように設定されます。このモジュールをインポートすると、ルートモジュールまたは入れ子になったモジュールによって他の変数がエクスポートされた場合でも、$SomeExample変数のみが使用可能になります。

@{
    VariablesToExport = @(
        'SomeExample'
    )
}

VariablesToExport ではワイルドカード文字列を使用して設定します。このモジュールをインポートすると、ルートモジュールまたは入れ子になったモジュールによって他の変数がモジュールメンバーとしてエクスポートされた場合でも、名前が Example で終わる変数が使用可能になります。

@{
    VariablesToExport = @(
        '*Example'
    )
}

DscResourcesToExport

この設定では、モジュールがエクスポートする DSC リソースを指定します。この設定を使用して、モジュールによってエクスポートされるクラスベースの DSC リソースを制限できます。エクスポートされたモジュールメンバーの一覧から DSC リソースを削除できますが、DSC リソースを一覧に追加することはできません。

	Value
[Input Type](入力の種類)	`System.String[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	はい

この設定では、ワイルドカードを使用してエントリを指定できます。モジュール内の一致するすべてのクラスベースの DSC リソースがエクスポートされます。

ヒント

検出可能な場合は、モジュールがエクスポートするすべての DSC リソースを常に明示的に一覧表示する必要があります。

DSC リソースの作成と使用の詳細については、DSC のドキュメントを参照してください。

このマニフェストは、ルートモジュールおよび入れ子になったモジュールで定義されているすべてのクラスベースおよび MOF ベースの DSC リソースをエクスポートします。

@{
    # DscResourcesToExport = @()
}

このマニフェストは、ルートモジュールと入れ子になったモジュールで定義されているすべての MOF ベースの DSC リソースをエクスポートしますが、 ExampleClassResourceクラスベースの DSC リソースは 1 つだけです。

@{
    DscResourcesToExport = @(
        'ExampleClassResource'
    )
}

このマニフェストは、それに含まれるすべての DSC リソースをエクスポートします。 MOF ベースのリソースが一覧に含まれていない場合でも、モジュールはそれをエクスポートします。

@{
    DscResourcesToExport = @(
        'ExampleClassResource'
        'ExampleMofResourceFirst'
    )
}

ModuleList

この設定は、このモジュールに含まれるモジュールの情報インベントリリストです。この一覧は、モジュールの動作には影響しません。

	Value
[Input Type](入力の種類)	`System.String[]`, `System.Collections.Hashtable[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

この設定のエントリには、モジュール名、完全なモジュール仕様、またはモジュールまたはスクリプトファイルへのパスを指定できます。

値がパスの場合、パスは完全修飾または相対パスにすることができます。

値がモジュール名または仕様の場合、PowerShell は指定されたモジュールの PSModulePath を検索します。

モジュール仕様は、次のキーを持つハッシュテーブルです。

ModuleName - 必須。モジュール名を指定します。
GUID - 省略可。 モジュールの GUID を指定します。
また、以下の 3 つのキーのうち少なくとも 1 つを指定Required です。 RequiredVersion キーは、ModuleVersionキーまたはMaximumVersion キーでは使用できません。 ModuleVersionキーとMaximumVersionキーを一緒に指定することで、モジュールの許容可能なバージョン範囲を定義できます。
- ModuleVersion - モジュールの最小許容バージョンを指定します。
- RequiredVersion - モジュールの正確で必要なバージョンを指定します。
- MaximumVersion - モジュールの許容される最大バージョンを指定します。

Note

RequiredVersion は Windows PowerShell 5.0 で追加されました。 MaximumVersion は Windows PowerShell 5.1 で追加されました。

このマニフェストでは、含まれるモジュールの情報リストは提供されません。モジュールが含まれる場合とない場合があります。この設定が指定されていない場合でも、 RootModule、 ScriptsToProcess、または NestedModules 設定に一覧表示されているモジュールは正常に動作します。

@{
    # ModuleList = @()
}

このマニフェストは、含まれるモジュールがExample.psm1だけであり、サブモジュールが First.psm1 フォルダーにSecond.psm1およびSubmodulesされていることを宣言します。

@{
    ModuleList = @(
        'Example.psm1'
        'Submodules\First.psm1'
        'Submodules\Second.psm1'
    )
}

FileList

この設定は、このモジュールに含まれるファイルの情報インベントリリストです。この一覧は、モジュールの動作には影響しません。

	Value
[Input Type](入力の種類)	`System.String[]`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	はい

この設定のエントリは、モジュールマニフェストを含むフォルダーのファイルへの相対パスである必要があります。

ユーザーがこの設定を定義したマニフェストに対して Get-Module を呼び出すと、 FileList プロパティには、これらのファイルへの完全なパスが含まれます。モジュールのパスと各エントリの相対パスが結合されます。

このマニフェストには、そのファイルの一覧は含まれません。

@{
    # FileList = @()
}

このマニフェストは、この設定に含まれるファイルのみが一覧表示されることを宣言します。

@{
    FileList = @(
        'Example.psd1'
        'Example.psm1'
        'Assemblies\Example.dll'
        'Scripts\Initialize.ps1'
        'Submodules\First.psm1'
        'Submodules\Second.psm1'
    )
}

PrivateData

この設定では、ルートモジュールのスコープ内のコマンドまたは関数で使用できるデータのハッシュテーブルを定義します。

	Value
[Input Type](入力の種類)	`System.Collections.Hashtable`
必須	PowerShell ギャラリー、クレッシェンド
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

Crescendo マニフェストをエクスポートして新しいモジュールを作成すると、 Export-CrescendoModule は 2 つのキーを PrivateData に追加します

CrescendoGenerated - モジュールがエクスポートされたときのタイムスタンプ
CrescendoVersion - モジュールのエクスポートに使用される Crescendo のバージョン

追跡するメタデータを保持する独自のキーを追加できます。この設定に追加されたキーは、 $MyInvocation.MyCommand.Module.PrivateDataを使用してルートモジュールの関数とコマンドレットで使用できます。ハッシュテーブルはモジュールスコープ自体では使用できません。モジュールで定義したコマンドレットでのみ使用できます。

たとえば、このマニフェストは、PrivateData の PublishedDate キーを定義します。

@{
    PrivateData = @{
        PublishedDate = '2022-06-01'
    }
}

モジュール内のコマンドレットは、 $MyInvocation 変数を使用してこの値にアクセスできます。

Function Get-Stale {
    [CmdletBinding()]
    param()

    $PublishedDate = $MyInvocation.MyCommand.Module.PrivateData.PublishedDate
    $CurrentDate = Get-Date

    try {
        $PublishedDate = Get-Date -Date $PublishedDate -ErrorAction Stop
    } catch {
        # The date was set in the manifest, set to an invalid value, or
        # the script module was directly imported without the manifest.
        Throw "Unable to determine published date. Check the module manifest."
    }

    if ($CurrentDate -gt $PublishedDate.AddDays(30)) {
        Write-Warning "This module version was published more than 30 days ago."
    } else {
        $TimeUntilStale = $PublishedDate.AddDays(30) - $CurrentDate
        "This module will be stale in $($TimeUntilStale.Days) days"
    }
}

モジュールがインポートされると、関数は PrivateData の値を使用して、モジュールがいつ発行されたかを判断します。

Get-Stale -TestDate '2022-06-15'
Get-Stale -TestDate '2022-08-01'

This module will be stale in 16 days

WARNING: This module version was published more than 30 days ago.

PrivateData.PSData

PSData 子プロパティは、特定の拡張シナリオをサポートする値のハッシュテーブルを定義します。

	Value
[Input Type](入力の種類)	`System.Collections.Hashtable`
必須	PowerShell ギャラリー、試験的機能、Crescendo モジュール
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

PSData 子プロパティは、次のシナリオで使用されます。

PowerShell ギャラリー - New-ModuleManifestを使用してモジュールマニフェストを作成すると、コマンドレットはモジュールをPowerShell ギャラリーに発行するときに必要なプレースホルダーキーを持つ PSData ハッシュテーブルを事前に設定します。モジュールマニフェストとPowerShell ギャラリーへの発行の詳細については、「PowerShell ギャラリー UI に影響を与えるパッケージマニフェスト値を参照してください。
試験的特徴 - 試験的特徴に関するメタデータは、PSData の ExperimentalFeatures プロパティに保持されます。 ExperimentalFeatures プロパティは、機能の名前と説明を含むハッシュテーブルの配列です。詳細については、「モジュールでの実験機能の宣言を参照してください。
Crescendo モジュール - 新しいモジュールを作成するために Crescendo マニフェストをエクスポートすると、Export-CrescendoModuleCrescendoBuilt プロパティに値が追加されます。このタグを使用すると、Crescendo を使用して作成されたPowerShell ギャラリー内のモジュールを検索できます。詳細については、「 Export-CrescendoModuleを参照してください。

HelpInfoURI

この設定では、モジュールの HelpInfo XML ファイルのインターネットアドレスを指定します。

	Value
[Input Type](入力の種類)	`System.String`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

この設定の値は、 http または https で始まる URI (Uniform Resource Identifier) である必要があります。

HelpInfo XML ファイルは、PowerShell 3.0 で導入された更新可能なヘルプ機能をサポートしています。これには、モジュールのダウンロード可能なヘルプファイルの場所、およびサポートされている各ロケールの最新のヘルプファイルのバージョン番号に関する情報が含まれます。

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

たとえば、このモジュールでは更新可能なヘルプがサポートされています。

@{
    HelpInfoUri = 'http://https://go.microsoft.com/fwlink/?LinkID=603'
}

DefaultCommandPrefix

この設定では、セッションにインポートされるときにモジュール内のすべてのコマンドの名詞の前にプレフィックスを指定します。プレフィックスは、ユーザーのセッションでのコマンド名の競合を防ぐのに役立ちます。

	Value
[Input Type](入力の種類)	`System.String`
必須	いいえ
未設定の場合の値	`$null`
ワイルドカードを受け入れます	いいえ

モジュールユーザーは、コマンドレットの Import-Module パラメーターを指定することで、このプレフィックスをオーバーライドできます。

この設定は、PowerShell 3.0 で導入されました。

このマニフェストをインポートすると、このモジュールからインポートされたすべてのコマンドレット Example 名前の名詞の前に付加されます。たとえば、 Get-Item は Get-ExampleItemとしてインポートされます。

@{
    DefaultCommandPrefix = 'Example'
}

次の方法で共有

about_Module_Manifests

簡単な説明

詳細な説明

モジュールマニフェストでのスクリプトコードの使用

マニフェストの設定

RootModule

ModuleVersion

CompatiblePSEditions

GUID

作成者

CompanyName

著作権

説明

PowerShellVersion

PowerShellHostName

PowerShellHostVersion

DotNetFrameworkVersion

CLRVersion

ProcessorArchitecture

RequiredModules

RequiredAssemblies

ScriptsToProcess

TypesToProcess

FormatsToProcess

NestedModules

FunctionsToExport

CmdletsToExport

VariablesToExport

DscResourcesToExport

ModuleList

FileList

PrivateData

PrivateData.PSData

HelpInfoURI

DefaultCommandPrefix

関連項目

その他のリソース

次の方法で共有

about_Module_Manifests

簡単な説明

詳細な説明

モジュール マニフェストでのスクリプト コードの使用

マニフェストの設定

RootModule

ModuleVersion

CompatiblePSEditions

GUID

作成者

CompanyName

著作権

説明

PowerShellVersion

PowerShellHostName

PowerShellHostVersion

DotNetFrameworkVersion

CLRVersion

ProcessorArchitecture

RequiredModules

RequiredAssemblies

ScriptsToProcess

TypesToProcess

FormatsToProcess

NestedModules

FunctionsToExport

CmdletsToExport

VariablesToExport

DscResourcesToExport

ModuleList

FileList

PrivateData

PrivateData.PSData

HelpInfoURI

DefaultCommandPrefix

関連項目

その他のリソース

モジュールマニフェストでのスクリプトコードの使用