Publish-Module

モジュール:

PowerShellGet v3 Module

指定したモジュールをローカル コンピューターからオンライン ギャラリーに発行します。

構文

ModuleNameParameterSet (既定)

Publish-Module
    -Name <String>
    [-RequiredVersion <String>]
    [-NuGetApiKey <String>]
    [-Repository <String>]
    [-Credential <PSCredential>]
    [-FormatVersion <Version>]
    [-ReleaseNotes <String[]>]
    [-Tags <String[]>]
    [-LicenseUri <Uri>]
    [-IconUri <Uri>]
    [-ProjectUri <Uri>]
    [-Exclude <String[]>]
    [-Force]
    [-AllowPrerelease]
    [-SkipAutomaticTags]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ModulePathParameterSet

Publish-Module
    -Path <String>
    [-NuGetApiKey <String>]
    [-Repository <String>]
    [-Credential <PSCredential>]
    [-FormatVersion <Version>]
    [-ReleaseNotes <String[]>]
    [-Tags <String[]>]
    [-LicenseUri <Uri>]
    [-IconUri <Uri>]
    [-ProjectUri <Uri>]
    [-Force]
    [-SkipAutomaticTags]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

Publish-Module コマンドレットは、ギャラリー内のユーザーのプロファイルの一部として格納された API キーを使用して、モジュールをオンライン NuGet ベースのギャラリーに発行します。 発行するモジュールは、モジュールの名前またはモジュールを含むフォルダーへのパスで指定できます。

これは、Publish-PSResource の コマンドレットのプロキシ コマンドレットです。 詳細については、「 Publish-PSResource」を参照してください。

例

例 1: モジュールを発行する

この例では、 MyDscModule は、API キーを使用してモジュール所有者のオンライン ギャラリー アカウントを示すことによって、オンライン ギャラリーに発行されます。 MyDscModule が、名前、バージョン、説明、および作成者を指定する有効なマニフェスト モジュールでない場合は、エラーが発生します。

Publish-Module -Path c:\projects\MyDscModule\1.0.0 -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73"

例 2: ギャラリー メタデータを使用してモジュールを発行する

この例では、 MyDscModule は、API キーを使用してモジュール所有者のギャラリー アカウントを示すことによって、オンライン ギャラリーに発行されます。 提供された追加のメタデータは、ギャラリー内のモジュールの Web ページに表示されます。 所有者は、モジュールの 2 つの検索タグを追加し、Active Directory に関連付けます。簡単なリリース ノートが追加されました。 MyDscModule が、名前、バージョン、説明、および作成者を指定する有効なマニフェスト モジュールでない場合は、エラーが発生します。

$parameters = @{
    Path        = 'c:\projects\MyDscModule\1.0.0'
    NuGetApiKey = '11e4b435-6cb4-4bf7-8611-5162ed75eb73'
    LicenseUri  = 'http://contoso.com/license'
    Tag         = 'Active Directory','DSC'
    ReleaseNote = 'Updated the ActiveDirectory DSC Resources to support adding users.'
}
Publish-Module @parameters

パラメーター

-AllowPrerelease

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	False
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

ModuleNameParameterSet

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Confirm

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

パラメーターのプロパティ

型:	SwitchParameter
規定値:	False
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	cf

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Credential

指定したパッケージ プロバイダーまたはソースのモジュールを発行する権限を持つユーザー アカウントを指定します。

パラメーターのプロパティ

型:	PSCredential
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Exclude

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

ModuleNameParameterSet

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Force

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	False
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-FormatVersion

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	Version
規定値:	None
指定可能な値:	2.0
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-IconUri

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	Uri
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-LicenseUri

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	Uri
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Name

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

ModuleNameParameterSet

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-NuGetApiKey

モジュールをオンライン ギャラリーに発行するために使用する API キーを指定します。 API キーは、オンライン ギャラリーのプロファイルの一部であり、ギャラリーのユーザー アカウント ページにあります。 API キーは NuGet 固有の機能です。

プロキシ コマンドレットは、このパラメーターを の Publish-PSResource パラメーターにマップします。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Path

発行するモジュールへのパスを指定します。 このパラメーターは、モジュールを含むフォルダーへのパスを受け入れます。 フォルダーの名前はモジュールと同じである必要があります。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

ModulePathParameterSet

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-ProjectUri

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	Uri
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-ReleaseNotes

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Repository

Register-PSRepositoryを実行して登録されたリポジトリのフレンドリ名を指定します。 リポジトリには、有効な NuGet URI である PublishLocation が必要です。 PublishLocation は、Set-PSRepositoryを実行して設定できます。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-RequiredVersion

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

ModuleNameParameterSet

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-SkipAutomaticTags

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	False
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Tags

プロキシ コマンドレットは、 Publish-PSResourceでサポートされていないため、このパラメーターを無視します。

パラメーターのプロパティ

型:	String[]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-WhatIf

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

パラメーターのプロパティ

型:	SwitchParameter
規定値:	False
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	ウィスコンシン

パラメーター セット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。

入力

String

PSCredential

出力

Object

メモ

PowerShell には、Publish-Moduleの次のエイリアスが含まれています。

• すべてのプラットフォーム:
  • pumo

Publish-Module は、PowerShell の PowerShell 3.0 以降のリリース、Windows 7 または Windows 2008 R2 以降の Windows リリースで実行されます。

PowerShell ギャラリーでは、トランスポート層セキュリティ (TLS) バージョン 1.0 と 1.1 はサポートされなくなりました。 TLS 1.2 以降を使用する必要があります。 TLS 1.2 を使用していることを確認するには、次のコマンドを使用します。

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

モジュールを発行するには、モジュールのギャラリー ページに表示されるメタデータが必要です。 必要なメタデータには、モジュール名、バージョン、説明、作成者が含まれます。 メタデータはモジュール マニフェストで定義する必要があります。 詳細については、「 PowerShell ギャラリー UI に影響するパッケージ マニフェスト値」を参照してください。

関連リンク

• Find-Module
• Install-Module
• Register-PSRepository
• Set-PSRepository
• Uninstall-Module
• Update-Module