Update-ModuleManifest

リファレンス

モジュール:: PowerShellGet

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

構文

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) ファイルを更新します。

例

例 1: モジュールマニフェストを更新する

次の使用例は、既存のモジュールマニフェストファイルを更新します。スプラッティングは、にパラメーター値 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 のパラメーター値を格納する splat です。 Update-ModuleManifest からパラメーター値 @Params を取得し、モジュールマニフェスト TestManifest.psd1 を更新します。

パラメーター

-AliasesToExport

モジュールがエクスポートするエイリアスを指定します。ワイルドカードを使用できます。

モジュールによってエクスポートされるエイリアスを制限するには、このパラメーターを使用します。 AliasesToExport では、エクスポートされたエイリアスの一覧からエイリアスを削除できますが、一覧にエイリアスを追加することはできません。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Author

モジュールの作成者を指定します。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClrVersion

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

注意

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

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CmdletsToExport

モジュールがエクスポートするコマンドレットを指定します。ワイルドカードを使用できます。

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-CompanyName

モジュールを作成した会社またはベンダーを指定します。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CompatiblePSEditions

モジュールの互換性のある PSEdition を 指定します。 PSEdition の詳細については、「互換性のある PowerShell エディションを備えたモジュール」を参照してください。

Type:	String[]
Accepted values:	Desktop, Core
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

を実行する前に確認を求めるメッセージが表示されます Update-ModuleManifest。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Copyright

モジュールの著作権表記を指定します。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultCommandPrefix

既定のコマンドプレフィックスを指定します。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

モジュールの説明を指定します。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DotNetFrameworkVersion

モジュールに必要な、Microsoft .NET Framework の最低限のバージョンを指定します。

注意

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DscResourcesToExport

モジュールがエクスポートするDesired State Configuration (DSC) リソースを指定します。ワイルドカードを使用できます。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExternalModuleDependencies

外部モジュールの依存関係の配列を指定します。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FileList

モジュールに含まれているすべての項目を指定します。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FormatsToProcess

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

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FunctionsToExport

モジュールがエクスポートする関数を指定します。ワイルドカードを使用できます。

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-Guid

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

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HelpInfoUri

モジュールの HelpInfo XML ファイルのインターネットアドレスを指定します。 http または https で始まる URI (Uniform Resource Identifier) を入力します。

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

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

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IconUri

モジュールのアイコンの URL を指定します。指定したアイコンが、モジュールのギャラリー Web ページに表示されます。

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LicenseUri

モジュールのライセンス条項の URL を指定します。

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ModuleList

モジュールに含まれるモジュールの配列を指定します。

各モジュールの名前を文字列として、または ModuleName　キーと ModuleVersion キーを含むハッシュテーブルとして入力します。ハッシュテーブルは、オプションの GUID キーも保持できます。パラメーター値として文字列とハッシュテーブルを組み合わせることができます。

このキーは、モジュールインベントリとしての動作を想定して設計されています。このキーの値に一覧表示されているモジュールは自動的に処理されません。

Type:	Object[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ModuleVersion

モジュールのバージョンを指定します。

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NestedModules

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

Type:	Object[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PackageManagementProviders

パッケージ管理プロバイダーの配列を指定します。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PassThru

作業中のアイテムを表すオブジェクトを返します。既定では、 Update-ModuleManifest では出力は生成されません。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

モジュールマニフェストのパスとファイル名を指定します。などのファイル名拡張子$PSHOME\Modules\MyModule\MyModule.psd1を.psd1持つパスとファイル名を入力します。

既存のファイルへのパスを指定した場合は、ファイルに読み取り専用属性がない限り、 Update-ModuleManifest 警告なしでファイルを置き換えます。

マニフェストはモジュールのディレクトリに配置する必要があり、マニフェストファイル名はモジュールディレクトリ名と同じにする必要がありますが、拡張子が付いています .psd1 。

Path パラメーター値のプロンプトに応じて、や $HOMEなどの$PSHOME変数を使用することはできません。変数を使用するには、コマンドに Path パラメーターを含めます。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PowerShellHostName

モジュールに必要な PowerShell ホストプログラムの名前を指定します。 PowerShell ISE ホストや ConsoleHost など、ホストプログラムの名前を入力します。ワイルドカードは使用できません。

ホストプログラムの名前を見つけるには、プログラムに「」と入力します $Host.Name。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PowerShellHostVersion

モジュールで動作する PowerShell ホストプログラムの最小バージョンを指定します。 1.1 などのバージョン番号を入力します。

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PowerShellVersion

このモジュールで動作する PowerShell の最小バージョンを指定します。たとえば、このパラメーターの値として 3.0、4.0、または 5.0 を指定できます。

Type:	Version
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Prerelease

モジュールがプレリリースであることを示します。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PrivateData

インポート時にモジュールに渡されるデータを指定します。

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProcessorArchitecture

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

このパラメーターの有効値は、次のとおりです。

Amd64
Arm
IA64
MSIL
なし (不明または未指定)
X86

Type:	ProcessorArchitecture
Accepted values:	None, MSIL, X86, IA64, Amd64, Arm
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProjectUri

このプロジェクトに関する Web ページの URL を指定します。

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ReleaseNotes

このバージョンのスクリプトで使用できるようにするリリースノートまたはコメントを含む文字列配列を指定します。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequiredAssemblies

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

これらのアセンブリが NestedModules キーのバイナリモジュールとしてもリストされている場合でも、FormatsToProcess キーまたは TypesToProcess キーに一覧表示されている書式または型ファイルを更新するために読み込む必要があるアセンブリを含め、モジュールで必要なすべてのアセンブリを指定するには、このパラメーターを使用します。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequiredModules

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

Type:	Object[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequireLicenseAcceptance

モジュールにライセンスの同意が必要であることを指定します。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RootModule

モジュールのプライマリファイルまたはルートファイルを指定します。スクリプト ()、スクリプトモジュール (.ps1)、モジュールマニフェスト (.psm1)、アセンブリ (.dll.psd1)、コマンドレット定義 XML ファイル ()、またはワークフロー (.cdxml.xaml) のファイル名を入力します。モジュールのインポート時に、ルートモジュールファイルからエクスポートされるメンバーは、呼び出し元のセッション状態にインポートされます。

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

マニフェストを持つモジュール内のまたは .dll モジュール内のファイルから.psm1メンバーをエクスポートするには、それらのファイルの名前をマニフェストの RootModule キーまたは NestedModules キーの値で指定する必要があります。それ以外の場合、メンバーはエクスポートされません。

PowerShell 2.0 では、このキーは ModuleToProcess と呼ばれます。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ScriptsToProcess

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

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tags

タグの配列を指定します。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TypesToProcess

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

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VariablesToExport

モジュールがエクスポートする変数を指定します。ワイルドカードを使用できます。

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

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	True

-WhatIf

が実行された場合 Update-ModuleManifest の動作を示します。コマンドレットは実行されません。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

入力

String

出力

Object

メモ

重要

2020 年 4 月時点で、PowerShell ギャラリーでは、トランスポート層セキュリティ (TLS) バージョン 1.0 および 1.1 がサポートされなくなります。 TLS 1.2 以降を使用していない場合、PowerShell ギャラリーにアクセスしようとするとエラーが発生します。次のコマンドを使用して、確実に TLS 1.2 を使用するようにします。

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

詳細については、PowerShell ブログのお知らせを参照してください。