ja-JP/about_Module_Manifests.help.txt
|
TOPIC about_Module_Manifests 簡単な説明 モジュールマニフェストファイルを記述する方法と、モジュールの内容を 記述する設定の一覧を説明します。 詳細な説明 モジュールマニフェストは、ハッシュテーブルを含む PowerShell データ ファイル (.psd1) です。ハッシュテーブル内のキーと値のペアは、モジュールの 内容と属性を記述し、前提条件を定義し、コンポーネントの処理方法を 制御します。 マニフェストはモジュールを読み込むために必須ではありませんが、モジュールを PowerShell ギャラリーに公開するには必要です。 マニフェストファイルは、New-ModuleManifest コマンドレットを使用して 作成できます。また、Test-ModuleManifest コマンドレットを使用して、公開 する前にマニフェストを検証できます。 すべての設定をマニフェストに明示的に記述することをお勧めします。特に、 エクスポートするコマンドの一覧では、パフォーマンスと探索性を高めるため、 ワイルドカードを使用せずに項目を明示的に列挙してください。 制限言語モードについて Import-Module を使用してモジュールをインポートすると、マニフェストは Restricted (制限) 言語モードで評価されます。Restricted モードでは、 使用できるコマンドと変数が制限されます。 マニフェストの評価で使用できるコマンドは、Import-LocalizedData、 ConvertFrom-StringData、Write-Host、Out-Host、Join-Path に制限されます。 また、$PSScriptRoot や $PSEdition などの変数にアクセスできます。 マニフェストの設定 RootModule この設定は、モジュールの主要ファイルまたはルートファイルを指定します。 モジュールがインポートされると、ルートモジュールファイルがエクスポート するメンバーが、呼び出し元のセッション状態にインポートされます。値には、 スクリプトモジュール (.psm1)、バイナリモジュール (.dll)、スクリプト ファイル (.ps1)、マニフェスト (.psd1)、cmdlet-over-objects ファイル (.cdxml)、XAML ファイル (.xaml) のファイル名を指定できます。 ModuleVersion この設定は、モジュールのバージョンを指定します。システム上に複数の バージョンのモジュールが存在する場合、Import-Module を実行すると既定で 最新バージョンが読み込まれます。値は、System.Version オブジェクトに 変換できる文字列です。 CompatiblePSEditions この設定は、モジュールの互換性のある PSEdition を指定します。有効な値は Desktop と Core です。 GUID この設定は、モジュールの一意の識別子を指定します。GUID は、同じ名前の モジュールを区別するために使用されます。 Author この設定は、モジュールの作成者を識別します。 CompanyName この設定は、モジュールを作成した会社またはベンダーを識別します。 Copyright この設定は、モジュールの著作権表示を指定します。 Description この設定は、モジュールの概要を記述します。 PowerShellVersion この設定は、このモジュールが必要とする PowerShell の最小バージョンを 指定します。 PowerShellHostName この設定は、モジュールが必要とする PowerShell ホストプログラムの名前を 指定します。たとえば、Windows PowerShell ISE Host や ConsoleHost などです。 PowerShellHostVersion この設定は、モジュールが必要とする PowerShell ホストプログラムの最小 バージョンを指定します。 DotNetFrameworkVersion この設定は、モジュールが必要とする Microsoft .NET Framework の最小 バージョンを指定します。この設定は Windows PowerShell でのみ有効です。 CLRVersion この設定は、モジュールが必要とする Microsoft .NET Framework の共通言語 ランタイム (CLR) の最小バージョンを指定します。この設定は Windows PowerShell でのみ有効です。 ProcessorArchitecture この設定は、モジュールが必要とするプロセッサアーキテクチャを指定します。 有効な値は None、MSIL、X86、IA64、Amd64、Arm です。 RequiredModules この設定は、グローバルセッション状態に存在している必要があるモジュールを 指定します。必要なモジュールがグローバルセッション状態に存在しない場合、 PowerShell はそれらをインポートします。必要なモジュールが利用できない 場合、Import-Module コマンドは失敗します。 RequiredAssemblies この設定は、モジュールが必要とするアセンブリ (.dll) ファイルを指定します。 PowerShell は、型や書式を更新したり、ネストされたモジュールをインポート したり、RootModule キーの値で指定されたモジュールファイルをインポート したりする前に、指定されたアセンブリを読み込みます。 ScriptsToProcess この設定は、モジュールがインポートされるときに呼び出し元のセッション状態 で実行されるスクリプト (.ps1) ファイルを指定します。これらのスクリプトは、 ログオンスクリプトを使用するのと同じように、環境を準備するために使用 できます。 TypesToProcess この設定は、モジュールがインポートされるときに実行される型ファイル (.ps1xml) を指定します。 FormatsToProcess この設定は、モジュールがインポートされるときに実行される書式設定ファイル (.ps1xml) を指定します。 NestedModules この設定は、モジュールのセッション状態にインポートされるスクリプト モジュール (.psm1) およびバイナリモジュール (.dll) を指定します。 スクリプトファイル (.ps1) を指定することもできます。この設定内の ファイルは、列挙された順序で実行されます。 FunctionsToExport この設定は、モジュールがエクスポートする関数を指定します。この設定を 使用して、モジュールがエクスポートする関数を制限できます。エクスポート される関数の一覧から関数を削除できますが、一覧に関数を追加することは できません。 CmdletsToExport この設定は、モジュールがエクスポートするコマンドレットを指定します。この 設定を使用して、モジュールがエクスポートするコマンドレットを制限できます。 エクスポートされるモジュールメンバーの一覧からコマンドレットを削除 できますが、一覧にコマンドレットを追加することはできません。 VariablesToExport この設定は、モジュールがエクスポートする変数を指定します。この設定を 使用して、モジュールがエクスポートする変数を制限できます。エクスポート されるモジュールメンバーの一覧から変数を削除できますが、一覧に変数を 追加することはできません。 AliasesToExport この設定は、モジュールがエクスポートするエイリアスを指定します。この設定を 使用して、モジュールがエクスポートするエイリアスを制限できます。エクス ポートされるモジュールメンバーの一覧からエイリアスを削除できますが、一覧に エイリアスを追加することはできません。 DscResourcesToExport この設定は、モジュールがエクスポートする DSC リソースを指定します。この 設定を使用して、モジュールがエクスポートするクラスベースの DSC リソースを 制限できます。エクスポートされるモジュールメンバーの一覧から DSC リソースを 削除できますが、一覧に DSC リソースを追加することはできません。 ModuleList この設定は、このモジュールに含まれるモジュールの情報用のインベントリ 一覧です。この一覧はモジュールの動作には影響しません。 FileList この設定は、このモジュールに含まれるファイルの情報用のインベントリ 一覧です。この一覧はモジュールの動作には影響しません。 PrivateData この設定は、ルートモジュールのスコープ内の任意のコマンドや関数が利用 できるデータのハッシュテーブルを定義します。これには、PowerShell ギャラリーが使用する PSData ハッシュテーブルを含めることができます。 HelpInfoURI この設定は、モジュールの HelpInfo XML ファイルのインターネットアドレスを 指定します。これは、更新可能なヘルプ機能で使用されます。 DefaultCommandPrefix この設定は、モジュールがセッションにインポートされるときに、モジュール内の すべてのコマンドの名詞部分に付加される接頭辞を指定します。接頭辞は、 ユーザーのセッションでのコマンド名の競合を防ぐのに役立ちます。 関連項目 about_Modules New-ModuleManifest Test-ModuleManifest Update-ModuleManifest Import-Module ---- 原文: PowerShell-Docs (CC BY 4.0) の翻訳 / PSHelpJaJP |