Publish-Module
指定したモジュールをローカル コンピューターからオンライン ギャラリーに発行します。
構文
Publish-Module
-Name <String>
[-RequiredVersion <Version>]
-NuGetApiKey <String>
[-Repository <String>]
[-FormatVersion <Version>]
[-ReleaseNotes <String[]>]
[-Tags <String[]>]
[-LicenseUri <Uri>]
[-IconUri <Uri>]
[-ProjectUri <Uri>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Publish-Module
-Path <String>
-NuGetApiKey <String>
[-Repository <String>]
[-FormatVersion <Version>]
[-ReleaseNotes <String[]>]
[-Tags <String[]>]
[-LicenseUri <Uri>]
[-IconUri <Uri>]
[-ProjectUri <Uri>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]説明
Publish-Module コマンドレットは、ギャラリー内のユーザーのプロファイルの一部として格納された API キーを使用して、モジュールをオンライン NuGet ベースのギャラリーに発行します。 発行するモジュールは、モジュールの名前またはモジュールを含むフォルダーへのパスで指定できます。
モジュールを名前で指定すると、 Publish-Module は、 Get-Module -ListAvailable <Name>を実行して見つかった最初のモジュールを発行します。 発行するモジュールの最小バージョンを指定した場合、 Publish-Module は、指定した最小バージョン以上のバージョンを持つ最初のモジュールを発行します。
例
例 1: モジュールを発行する
この例では、MyDscModule は、API キーを使用してモジュール所有者のオンライン ギャラリー アカウントを示すことによって、オンライン ギャラリーに発行されます。 MyDscModule が、名前、バージョン、説明、および作成者を指定する有効なマニフェスト モジュールでない場合は、エラーが発生します。
Publish-Module -Name "MyDscModule" -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73"例 2: ギャラリー メタデータを使用してモジュールを発行する
この例では、MyDscModule は、API キーを使用してモジュール所有者のギャラリー アカウントを示すことによって、オンライン ギャラリーに発行されます。 提供された追加のメタデータは、ギャラリー内のモジュールの Web ページに表示されます。 所有者は、モジュールの 2 つの検索タグを追加し、Active Directory に関連付けます。簡単なリリース ノートが追加されました。 MyDscModule が、名前、バージョン、説明、および作成者を指定する有効なマニフェスト モジュールでない場合は、エラーが発生します。
Publish-Module -Name "MyDscModule" -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73" -LicenseUri "https://contoso.com/license" -Tag "Active Directory","DSC" -ReleaseNote "Updated the ActiveDirectory DSC Resources to support adding users."パラメーター
-Confirm
Publish-Moduleを実行する前に確認を求めるメッセージが表示されます。
| 型: | SwitchParameter |
| Aliases: | cf |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-FormatVersion
ValidateSet 属性で指定された有効な値のみを受け入れます。
詳細については、「 ValidateSet 属性宣言 」および 「ValidateSetAttribute」を参照してください。
| 型: | Version |
| 指定可能な値: | 2.0 |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-IconUri
モジュールのアイコンの URL を指定します。 指定したアイコンが、モジュールのギャラリー Web ページに表示されます。
| 型: | Uri |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-LicenseUri
発行するモジュールのライセンス条項の URL を指定します。
| 型: | Uri |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Name
発行するモジュールの名前を指定します。
Publish-Module は、 $Env:PSModulePathで指定されたモジュール名を検索します。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-NuGetApiKey
モジュールをオンライン ギャラリーに発行するために使用する API キーを指定します。 API キーは、オンライン ギャラリーのプロファイルの一部であり、ギャラリーのユーザー アカウント ページにあります。 API キーは NuGet 固有の機能です。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Path
発行するモジュールへのパスを指定します。 このパラメーターは、モジュールを含むフォルダーへのパスを受け入れます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | True |
| パイプライン入力を受け取る: | True |
| ワイルドカード文字を受け取る: | False |
-ProjectUri
このプロジェクトに関する Web ページの URL を指定します。
| 型: | Uri |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-ReleaseNotes
このバージョンのモジュールのユーザーが使用できるようにするリリース ノートまたはコメントを含む文字列を指定します。
| 型: | String[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Repository
Register-PSRepositoryを実行して登録されたリポジトリのフレンドリ名を指定します。 リポジトリには、有効な NuGet URI である PublishLocation が必要です。
PublishLocation は、Set-PSRepositoryを実行して設定できます。
| 型: | String |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-RequiredVersion
発行する 1 つのモジュールの正確なバージョンを指定します。
| 型: | Version |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-Tags
発行するモジュールに 1 つ以上のタグを追加します。 タグの例としては、DesiredStateConfiguration、DSC、DSCResourceKit、PSModule などがあります。 複数のタグをコンマで区切ります。
| 型: | String[] |
| 配置: | Named |
| 規定値: | None |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
-WhatIf
Publish-Module が実行された場合の動作を示します。 コマンドレットは実行されません。
| 型: | SwitchParameter |
| Aliases: | wi |
| 配置: | Named |
| 規定値: | False |
| 必須: | False |
| パイプライン入力を受け取る: | False |
| ワイルドカード文字を受け取る: | False |
入力
PSModuleInfo
出力
None
Publish-Module モジュールが正常にパブリッシュされた場合、出力は表示されません。
メモ
Publish-Module は、PowerShell の PowerShell 3.0 以降のリリース、Windows 7 または Windows 2008 R2 以降の Windows リリースで実行されます。
モジュールを発行するには、モジュールのギャラリー ページに表示されるメタデータが必要です。 必要なメタデータには、モジュール名、バージョン、説明、作成者が含まれます。 ほとんどのメタデータはモジュール マニフェストから取得されますが、Publish-Module、ReleaseNote、IconUri、ProjectUri、LicenseUri などのパラメーターで指定できるメタデータもあります。 詳細については、「 PowerShell ギャラリー UI に影響するパッケージ マニフェスト値」を参照してください。