Update-ModuleManifest
モジュール マニフェスト ファイルを更新します。
構文
Update-ModuleManifest
[-Path] <String>
[-NestedModules <Object[]>]
[-Guid <Guid>]
[-Author <String>]
[-CompanyName <String>]
[-Copyright <String>]
[-RootModule <String>]
[-ModuleVersion <Version>]
[-Description <String>]
[-ProcessorArchitecture <ProcessorArchitecture>]
[-CompatiblePSEditions <String[]>]
[-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[]>]
[-PrivateData <Hashtable>]
[-Tags <String[]>]
[-ProjectUri <Uri>]
[-LicenseUri <Uri>]
[-IconUri <Uri>]
[-ReleaseNotes <String[]>]
[-Prerelease <String>]
[-HelpInfoUri <Uri>]
[-PassThru]
[-DefaultCommandPrefix <String>]
[-ExternalModuleDependencies <String[]>]
[-PackageManagementProviders <String[]>]
[-RequireLicenseAcceptance]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
Update-ModuleManifest
コマンドレットは、モジュール マニフェスト (.psd1
) ファイルを更新します。
これは、Microsoft.PowerShell.PSResourceGet のUpdate-PSModuleManifest
コマンドレットのプロキシ コマンドレットです。 詳細については、「 Update-PSModuleManifest」を参照してください。
例
例 1: モジュール マニフェストを更新する
この例では、既存のモジュール マニフェスト ファイルを更新します。 Splatting は、パラメーター値を Update-ModuleManifest
に渡すために使用されます。 詳細については、about_Splattingを参照してください。
$Params = @{
Path = "C:\Test\TestManifest.psd1"
Author = "TestUser1"
CompanyName = "Contoso Corporation"
Copyright = "(c) 2019 Contoso Corporation. All rights reserved."
}
Update-ModuleManifest @Params
$Params
は、 Path、 Author、 CompanyName、Copyright のパラメーター値を格納するスプラト です。
Update-ModuleManifest
は、 @Params
からパラメーター値を取得し、モジュール マニフェスト TestManifest.psd1 を更新します。
パラメーター
-AliasesToExport
モジュールがエクスポートするエイリアスを指定します。 ワイルドカードを使用できます。
モジュールによってエクスポートされるエイリアスを制限するには、このパラメーターを使用します。 AliasesToExport では、エクスポートされたエイリアスの一覧からエイリアスを削除できますが、一覧にエイリアスを追加することはできません。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-Author
モジュールの作成者を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ClrVersion
モジュールに必要な Microsoft .NET Framework の共通言語ランタイム (CLR) の最小バージョンを指定します。
注
この設定は、Windows PowerShell 5.1 などの PowerShell Desktop エディションでのみ有効であり、4.5 未満の .NET Framework バージョンにのみ適用されます。 この要件は、新しいバージョンの PowerShell または .NET Framework には影響しません。
型: | Version |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-CmdletsToExport
モジュールがエクスポートするコマンドレットを指定します。 ワイルドカードを使用できます。
モジュールによってエクスポートされるコマンドレットを制限するには、このパラメーターを使用します。 CmdletsToExport では、エクスポートされたコマンドレットの一覧からコマンドレットを削除できますが、一覧にコマンドレットを追加することはできません。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-CompanyName
モジュールを作成した会社またはベンダーを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-CompatiblePSEditions
モジュールの PSEditions と互換性のある を指定します。 PSEdition の詳細については、「互換性のある PowerShell Edition を使用したモジュール」を参照してください。
型: | String[] |
指定可能な値: | Desktop, Core |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Confirm
Update-ModuleManifest
を実行する前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Copyright
モジュールの著作権に関する声明を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultCommandPrefix
既定のコマンド プレフィックスを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Description
モジュールの説明を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DotNetFrameworkVersion
モジュールに必要な Microsoft .NET Framework の最小バージョンを指定します。
注
この設定は、Windows PowerShell 5.1 などの PowerShell Desktop エディションでのみ有効であり、4.5 未満の .NET Framework バージョンにのみ適用されます。 この要件は、新しいバージョンの PowerShell または .NET Framework には影響しません。
型: | Version |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DscResourcesToExport
モジュールがエクスポートする Desired State Configuration (DSC) リソースを指定します。 ワイルドカードを使用できます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ExternalModuleDependencies
外部モジュールの依存関係の配列を指定します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-FileList
モジュールに含まれるすべての項目を指定します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-FormatsToProcess
モジュールのインポート時に実行される書式設定ファイル (.ps1xml
) を指定します。
モジュールをインポートすると、PowerShell は指定されたファイルを使用して Update-FormatData
コマンドレットを実行します。
フォーマット ファイルはスコープ設定されていないため、セッション内のすべてのセッション状態に影響します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-FunctionsToExport
モジュールがエクスポートする関数を指定します。 ワイルドカードを使用できます。
モジュールによってエクスポートされる関数を制限するには、このパラメーターを使用します。 FunctionsToExport では、エクスポートされたエイリアスの一覧から関数を削除できますが、関数をリストに追加することはできません。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-Guid
モジュールのユニークな識別子を指定します。 GUID を使用して、同じ名前のモジュールを区別できます。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-HelpInfoUri
モジュールの HelpInfo XML ファイルのインターネット アドレスを指定します。 http または https で始まる URI (Uniform Resource Identifier) 入力します。
HelpInfo XML ファイルは、PowerShell バージョン 3.0 で導入された更新可能なヘルプ機能をサポートしています。 モジュールのダウンロード可能なヘルプ ファイルの場所と、サポートされている各ロケールの最新のヘルプ ファイルのバージョン番号に関する情報が含まれています。
更新可能なヘルプについては、「about_Updatable_Help」を参照してください。 HelpInfo XML ファイルの詳細については、「更新可能なヘルプのサポート」を参照してください。
型: | Uri |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-IconUri
モジュールのアイコンの URL を指定します。 指定したアイコンが、モジュールのギャラリー Web ページに表示されます。
型: | Uri |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-LicenseUri
モジュールのライセンス条項の URL を指定します。
型: | Uri |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ModuleList
モジュールに含まれるモジュールの配列を指定します。
各モジュール名を文字列またはハッシュ テーブルとして、ModuleName キーおよび ModuleVersion キーとともに入力します。 ハッシュ テーブルには、オプションの GUID キーを含めることもできます。 パラメーター値に文字列とハッシュ テーブルを組み合わせることができます。
このキーは、モジュール インベントリとして機能するように設計されています。 このキーの値に一覧表示されているモジュールは自動的に処理されません。
型: | Object[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ModuleVersion
モジュールのバージョンを指定します。
型: | Version |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-NestedModules
モジュールのセッション状態にインポートされるスクリプト モジュール (.psm1
) とバイナリ モジュール (.dll
) を指定します。
NestedModules キー内のファイルは、値に一覧表示されている順序で実行されます。
各モジュール名を文字列またはハッシュ テーブルとして、ModuleName キーおよび ModuleVersion キーとともに入力します。 ハッシュ テーブルには、オプションの GUID キーを含めることもできます。 パラメーター値に文字列とハッシュ テーブルを組み合わせることができます。
型: | Object[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PackageManagementProviders
パッケージ管理プロバイダーの配列を指定します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PassThru
作業中のアイテムを表すオブジェクトを返します。 既定では、Update-ModuleManifest
は出力を生成しません。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Path
モジュール マニフェストのパスとファイル名を指定します。
.psd1
など、$PSHOME\Modules\MyModule\MyModule.psd1
ファイル名拡張子を持つパスとファイル名を入力します。
既存のファイルへのパスを指定した場合、Update-ModuleManifest
は、ファイルに読み取り専用属性がない限り、警告なしでファイルを置き換えます。
マニフェストはモジュールのディレクトリに配置し、マニフェスト ファイル名はモジュール ディレクトリ名と同じにする必要がありますが、拡張子は .psd1
にする必要があります。
Path パラメーター値のプロンプトに応答して、$PSHOME
や$HOME
などの変数を使用することはできません。 変数を使用するには、コマンドに Path パラメーターを含めます。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-PowerShellHostName
モジュールに必要な PowerShell ホスト プログラムの名前を指定します。 PowerShell ISE Host や ConsoleHost など、ホスト プログラムの名前を入力します。 ワイルドカードは使用できません。
ホスト・プログラムの名前を見つけるには、プログラムに「$Host.Name
」と入力します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PowerShellHostVersion
モジュールで動作する PowerShell ホスト プログラムの最小バージョンを指定します。 バージョン番号 (1.1 など) を入力します。
型: | Version |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PowerShellVersion
このモジュールで動作する PowerShell の最小バージョンを指定します。 たとえば、このパラメーターの値として 3.0、4.0、または 5.0 を指定できます。
型: | Version |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Prerelease
モジュールがプレリリースであることを示します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PrivateData
インポート時にモジュールに渡されるデータを指定します。
型: | Hashtable |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ProcessorArchitecture
モジュールに必要なプロセッサ アーキテクチャを指定します。
このパラメーターに使用できる値は次のとおりです。
- Amd64
- 腕
- IA64
- MSIL
- なし (不明または未指定)
- X86
型: | ProcessorArchitecture |
指定可能な値: | None, MSIL, X86, IA64, Amd64, Arm |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ProjectUri
このプロジェクトに関する Web ページの URL を指定します。
型: | Uri |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ReleaseNotes
このバージョンのスクリプトで使用できるリリース ノートまたはコメントを含む文字列配列を指定します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RequiredAssemblies
モジュールに必要なアセンブリ (.dll
) ファイルを指定します。 アセンブリ ファイル名を入力します。
PowerShell は、型または形式の更新、入れ子になったモジュールのインポート、または RootModule キーの値で指定されたモジュール ファイルのインポートを行う前に、指定されたアセンブリを読み込みます。
このパラメーターを使用して、これらのアセンブリが NestedModules キーのバイナリ モジュールとしてもリストされている場合でも、FormatsToProcess キーまたは TypesToProcess キーに一覧表示されている書式ファイルまたは型ファイルを更新するために読み込む必要があるアセンブリを含め、モジュールに必要なすべてのアセンブリを指定します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RequiredModules
グローバル セッション状態である必要があるモジュールを指定します。 必要なモジュールがグローバル セッション状態でない場合は、PowerShell によってインポートされます。 必要なモジュールが使用できない場合、Import-Module
コマンドは失敗します。
型: | Object[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RequireLicenseAcceptance
モジュールにライセンスへの同意が必要であることを指定します。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RootModule
モジュールのプライマリ ファイルまたはルート ファイルを指定します。 スクリプト (.ps1
)、スクリプト モジュール (.psm1
)、モジュール マニフェスト (.psd1
)、アセンブリ (.dll
)、コマンドレット定義 XML ファイル (.cdxml
)、またはワークフロー (.xaml
) のファイル名を入力します。 モジュールがインポートされると、ルート モジュール ファイルからエクスポートされたメンバーが呼び出し元のセッション状態にインポートされます。
モジュールにマニフェスト ファイルがあり、ルート ファイルが RootModule キーで指定されていない場合、マニフェストはモジュールのプライマリ ファイルになります。 また、モジュールはマニフェスト モジュールになります (ModuleType = Manifest)。
マニフェストを持つモジュール内の .psm1
ファイルまたは .dll
ファイルからメンバーをエクスポートするには、これらのファイルの名前を、マニフェストの RootModule または nestedModules キーの値に指定する必要があります。 それ以外の場合、メンバーはエクスポートされません。
PowerShell 2.0 では、このキーは ModuleToProcessと呼ばれていました。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ScriptsToProcess
モジュールのインポート時に呼び出し元のセッション状態で実行されるスクリプト (.ps1
) ファイルを指定します。
ログイン スクリプトを使用する場合と同様に、これらのスクリプトを使用して環境を準備できます。
モジュールのセッション状態で実行されるスクリプトを指定するには、NestedModules キーを使用します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Tags
タグの配列を指定します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-TypesToProcess
モジュールのインポート時に実行される型ファイル (.ps1xml
) を指定します。
モジュールをインポートすると、PowerShell は指定されたファイルを使用して Update-TypeData
コマンドレットを実行します。
型ファイルはスコープ設定されていないため、セッション内のすべてのセッション状態に影響します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-VariablesToExport
モジュールがエクスポートする変数を指定します。 ワイルドカードを使用できます。
モジュールによってエクスポートされる変数を制限するには、このパラメーターを使用します。 VariablesToExport では、エクスポートされた変数の一覧から変数を削除できますが、変数をリストに追加することはできません。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-WhatIf
Update-ModuleManifest
が実行された場合の動作を示します。 コマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |