Update-PSModuleManifest
モジュール マニフェスト ファイルを更新します。
構文
Update-PSModuleManifest
[-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[]>]
[-Tags <String[]>]
[-ProjectUri <Uri>]
[-LicenseUri <Uri>]
[-IconUri <Uri>]
[-ReleaseNotes <String>]
[-Prerelease <String>]
[-HelpInfoUri <Uri>]
[-DefaultCommandPrefix <String>]
[-ExternalModuleDependencies <String[]>]
[-RequireLicenseAcceptance]
[-PrivateData <Hashtable>]
[<CommonParameters>]
説明
このコマンドレットは、モジュール マニフェスト ファイルに格納されているデータを更新します。 パラメーターを使用すると、更新するプロパティを指定できます。
Update-PSModuleManifest
は、モジュール マニフェスト内の既存の値を上書きします。
コマンドレットは オブジェクトを返しません。
例
例 1
次の使用例は、モジュール マニフェストの Author プロパティを に New Author
変更します。
Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Author 'New Author'
例 2
次の使用例は、 Prerelease プロパティを に beta2
変更します。
Update-PSModuleManifest -Path 'C:\MyModules\TestModule' -Prerelease 'beta2'
例 3
この例では、複数のプロパティを更新します。
$parameters = @{
Path = 'C:\MyModules\TestModule'
Tags = 'Windows', 'Linux'
Description = 'A module for managing packages.'
}
Update-PSModuleManifest
パラメーター
-AliasesToExport
モジュールがエクスポートするエイリアスを指定します。 ワイルドカードを使用できます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-Author
モジュールの作成者を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ClrVersion
モジュールに必要な Microsoft .NET Frameworkの共通言語ランタイム (CLR) の最小バージョンを指定します。
型: | Version |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-CmdletsToExport
モジュールがエクスポートするコマンドレットを指定します。 ワイルドカードを使用できます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-CompanyName
モジュールを作成した会社またはベンダーを指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-CompatiblePSEditions
モジュールの互換性のある PSEdition を 指定します。 PSEdition の詳細については、「互換性のある PowerShell エディションを使用するモジュール」を参照してください。
型: | String[] |
指定可能な値: | Desktop, Core |
配置: | Named |
規定値: | None |
必須: | 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の最小バージョンを指定します。
型: | Version |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DscResourcesToExport
モジュールがエクスポートするDesired State Configuration (DSC) リソースを指定します。 ワイルドカードを使用できます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-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
モジュールがエクスポートする関数を指定します。 ワイルドカードを使用できます。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
-Guid
モジュールの一意の識別子を指定します。 GUID は、同じ名前のモジュールを区別するために使用されます。
型: | Guid |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-HelpInfoUri
モジュールの HelpInfo XML ファイルのインターネット アドレスを指定します。 または https:
で始まる http:
Uniform Resource Identifier (URI) を入力します。
詳細については、「 更新可能なヘルプ」を参照してください。
型: | Uri |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-IconUri
モジュールのアイコンの URI を指定します。 指定したアイコンは、モジュールのギャラリー 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 |
-Path
モジュール マニフェストのパスとファイル名を指定します。 ファイル拡張子を持つ filename を .psd1
入力します。
型: | String |
配置: | 0 |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PowerShellHostName
モジュールに必要な PowerShell ホスト プログラムの名前を指定します。 PowerShell ISE ホストや ConsoleHost など、ホスト プログラムの名前を入力します。 ワイルドカードは使用できません。
ホスト プログラムの名前は に $Host.Name
格納されます。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PowerShellHostVersion
モジュールで動作する PowerShell ホスト プログラムの最小バージョンを指定します。 1.1 などのバージョン番号を入力します。
型: | Version |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PowerShellVersion
このモジュールで動作する PowerShell の最小バージョンを指定します。 たとえば、 や 7.2
などの5.1
バージョンを指定できます。
型: | Version |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Prerelease
モジュール バージョンに追加されるプレリリース値を指定します。 たとえば、Prerelease が で ModuleVersion が 1.0.0
preview
の場合、モジュールのバージョンは になります1.0.0-preview
。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-PrivateData
インポート時にモジュールに渡されるデータを指定します。 ハッシュテーブルに格納されている任意の値を指定できます。
型: | Hashtable |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ProcessorArchitecture
モジュールに必要なプロセッサ アーキテクチャを指定します。
このパラメーターの有効値は、次のとおりです。
Amd64
Arm
IA64
MSIL
-
None
(不明または未指定) X86
型: | ProcessorArchitecture |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ProjectUri
このプロジェクトに関する Web ページの URI を指定します。
型: | Uri |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ReleaseNotes
モジュールのリリース ノートまたはコメントを含む文字列を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RequiredAssemblies
モジュールに必要なアセンブリ (.dll
) ファイルを指定します。 PowerShell は、型または形式の更新、入れ子になったモジュールのインポート、 または RootModule キーで指定されたモジュール ファイルのインポートを行う前に、指定されたアセンブリを読み込みます。
これらのアセンブリが NestedModules キーにリストされている場合でも、FormatsToProcess キーまたは TypesToProcess キーに一覧表示されている書式ファイルまたは型ファイルを更新するには、読み込む必要があるアセンブリに RequiredAssemblies を使用します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RequiredModules
グローバル セッション状態にする必要があるモジュールを指定します。 必要なモジュールがグローバル セッション状態でない場合、PowerShell によってインポートされます。 必要なモジュールが使用できない場合、コマンドは Import-Module
失敗します。
値には、モジュール名またはモジュール指定を含む配列を指定できます。 モジュール仕様は、次のキーを持つハッシュテーブルです。
-
ModuleName
- 必須 モジュール名を指定します。 -
GUID
- オプション モジュールの GUID を指定します。 - また、以下の 3 つのキーのうち少なくとも 1 つを指定する 必要 もあります。
-
ModuleVersion
- モジュールの最小許容バージョンを指定します。 -
MaximumVersion
- モジュールの許容される最大バージョンを指定します。 -
RequiredVersion
- モジュールの正確で必要なバージョンを指定します。 これは、他のバージョン キーでは使用できません。
-
型: | Object[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RequireLicenseAcceptance
モジュールにライセンスの同意が必要であることを指定します。
型: | SwitchParameter |
配置: | Named |
規定値: | False |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-RootModule
モジュールのプライマリ ファイルまたはルート ファイルを指定します。 スクリプト ()、スクリプト モジュール (.ps1
)、モジュール マニフェスト (.psm1
)、アセンブリ (.psd1
)、またはコマンドレット定義 XML ファイル (.dll
.cdxml
) のファイル名を入力します。 モジュールがインポートされると、ルート モジュールからエクスポートされたメンバーが呼び出し元のセッション状態にインポートされます。
モジュールにマニフェスト ファイルがあり、 RootModule キーにファイルが指定されていない場合、マニフェストはモジュールのプライマリ ファイルになります。 モジュールはマニフェスト モジュール (ModuleType) と呼ばれます =
Manifest
。
または .dll
ファイルから.psm1
メンバーをエクスポートするには、マニフェストの RootModule キーまたは NestedModules キーの値にこれらのファイルの名前を指定する必要があります。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-ScriptsToProcess
モジュールのインポート時に呼び出し元のセッション状態で実行されるスクリプト (.ps1
) ファイルを指定します。
ログイン スクリプトを使用する場合と同様に、これらのスクリプトを使用して、環境を準備できます。
モジュールのセッション状態で実行するスクリプトを指定するには、NestedModules キーを使用します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Tags
タグの配列を指定します。
型: | String[] |
Aliases: | Tag |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-TypesToProcess
モジュールのインポート時に実行される型ファイル (.ps1xml
) を指定します。
モジュールをインポートすると、PowerShell は指定されたファイルを Update-TypeData
使用して コマンドレットを実行します。
型ファイルはスコープが設定されていないため、セッション内のすべてのセッション状態に影響します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-VariablesToExport
モジュールがエクスポートする変数を指定します。 ワイルドカードを使用できます。
モジュールによってエクスポートされる変数を制限するには、このパラメーターを使用します。
型: | String[] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | True |
入力
None
出力
メモ
モジュール マニフェスト ファイルの詳細については、「 about_Module_Manifests」を参照してください。
関連リンク
PSResourceGet