Publish-Module
指定したモジュールをローカル コンピューターからオンライン ギャラリーに発行します。
構文
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>]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 ベースのギャラリーにモジュールを発行します。 モジュールの名前、またはモジュールを含むフォルダーへのパスのいずれかでモジュールを発行するように指定できます。
これは、Microsoft.PowerShell.PSResourceGet の コマンドレットのプロキシ コマンドレットPublish-PSResourceです。 詳細については、「 Publish-PSResource」を参照してください。
例
例 1: モジュールを発行する
この例では、 MYDscModule は、API キーを使用してモジュール所有者のオンライン ギャラリー アカウントを示すことによって、オンライン ギャラリーに発行されます。 MyDscModule が、名前、バージョン、説明、作成者を指定する有効なマニフェスト モジュールでない場合は、エラーが発生します。
Publish-Module -Path c:\projects\MyDscModule\1.0.0 -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73"例 2: ギャラリー メタデータを使用してモジュールを発行する
この例では、API キーを使用してモジュール所有者のギャラリー アカウントを示すことによって、 MyDscModule をオンライン ギャラリーに発行します。 提供された追加のメタデータは、ギャラリー内のモジュールの 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。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
を実行する前に確認を求めるメッセージが表示されます Publish-Module。
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
指定したパッケージ プロバイダーまたはソースのモジュールを発行する権限を持つユーザー アカウントを指定します。
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Exclude
プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Publish-PSResource。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Publish-PSResource。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FormatVersion
プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Publish-PSResource。
| Type: | Version |
| Accepted values: | 2.0 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IconUri
プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Publish-PSResource。
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LicenseUri
プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Publish-PSResource。
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Publish-PSResource。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NuGetApiKey
オンライン ギャラリーにモジュールを発行するために使用する API キーを指定します。 API キーはオンライン ギャラリーのプロファイルの一部であり、ギャラリーのユーザー アカウント ページにあります。 API キーは、NuGet 固有の機能です。
プロキシ コマンドレットは、このパラメーターを の ApiKey パラメーターにマップします Publish-PSResource。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Path
発行するモジュールへのパスを指定します。 このパラメーターは、モジュールを含むフォルダーへのパスを受け入れます。 フォルダーの名前はモジュールと同じである必要があります。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ProjectUri
プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Publish-PSResource。
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReleaseNotes
プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Publish-PSResource。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Repository
を実行 Register-PSRepositoryして登録されたリポジトリのフレンドリ名を指定します。 リポジトリには、有効な NuGet URI である PublishLocation が必要です。
PublishLocation は、 を実行Set-PSRepositoryして設定できます。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiredVersion
プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Publish-PSResource。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipAutomaticTags
プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Publish-PSResource。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Tags
プロキシ コマンドレットではサポートされていないため、このパラメーターは無視されます Publish-PSResource。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
が実行された場合の動作を Publish-Module 示します。 このコマンドレットは実行されません。
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
入力
出力
メモ
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 に影響するパッケージ マニフェスト値」を参照してください。
関連リンク
PSResourceGet
フィードバック
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「https://aka.ms/ContentUserFeedback」を参照してください。
フィードバックの送信と表示