Update-PSModuleManifest

リファレンス

モジュール:: Microsoft.PowerShell.PSResourceGet

モジュールマニフェストファイルを更新します。

構文

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

モジュールの PSEditions と互換性のある を指定します。 PSEdition の詳細については、「互換性のある PowerShell Edition を使用したモジュール」を参照してください。

型:	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 ファイルのインターネットアドレスを指定します。 http: または https:で始まる URI (Uniform Resource Identifier) を入力します。

詳細については、「更新可能なヘルプをする」を参照してください。

型:	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 キー内のファイルは、リストされている順序で実行されます。

型:	Object[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Path

モジュールマニフェストのパスとファイル名を指定します。ファイル拡張子が .psd1 のファイル名を入力します。

型:	String
配置:	0
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	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 の最小バージョンを指定します。たとえば、5.1 や 7.2などのバージョンを指定できます。

型:	Version
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-Prerelease

モジュールのバージョンに追加されるプレリリース値を指定します。たとえば、プレリリースが preview され、ModuleVersion が 1.0.0されている場合、モジュールのバージョンは 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)、アセンブリ (.dll)、またはコマンドレット定義 XML ファイル (.cdxml) のファイル名を入力します。モジュールがインポートされると、ルートモジュールからエクスポートされたメンバーが呼び出し元のセッション状態にインポートされます。

モジュールにマニフェストファイルがあり、RootModule キーにファイルが指定されていない場合、マニフェストはモジュールのプライマリファイルになります。モジュールはマニフェストモジュール (ModuleType) と呼ばれます。

.psm1 ファイルまたは .dll ファイルからメンバーをエクスポートするには、これらのファイルの名前を、マニフェスト内の 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

出力

Object

メモ

モジュールマニフェストファイルの詳細については、about_Module_Manifestsを参照してください。

New-ModuleManifest