Publish-Module

Reference

Modul:: PowerShellGet

Publikuje zadaný modul z místního počítače do online galerie.

Syntaxe

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>]

Description

Rutina Publish-Module publikuje modul do online galerie založené na NuGetu pomocí klíče rozhraní API uloženého jako součást profilu uživatele v galerii. Modul, který se má publikovat, můžete zadat buď podle názvu modulu, nebo cestou ke složce obsahující modul.

Když zadáte modul podle názvu, publikuje první modul, Publish-Module který by byl nalezen spuštěním Get-Module -ListAvailable <Name>. Pokud zadáte minimální verzi modulu k publikování, publikuje první modul s verzí, Publish-Module která je větší nebo rovna minimální zadané verzi.

Publikování modulu vyžaduje metadata zobrazená na stránce galerie modulu. Požadovaná metadata zahrnují název modulu, verzi, popis a autora. Přestože většina metadat pochází z manifestu modulu, některá metadata musí být zadána v Publish-Module parametrech, jako je Tag, ReleaseNote, IconUri, ProjectUri a LicenseUri, protože tyto parametry odpovídají polím v galerii založeném na NuGetu.

Parametry, které přebírají čísla verzí modulu, očekávají řetězce formátované jako čísla verzí.

Standardní čísla verzí mají formát, kde x.y.z x, y a z jsou čísla.
Předběžné verze mají formát, ve x.y.z-<prerelease_label><prerelease_label> kterém je libovolný řetězec přiřazený k této verzi.

Příklady

Příklad 1: Publikování modulu

V tomto příkladu se MyDscModule publikuje do online galerie pomocí klíče rozhraní API k označení účtu online galerie vlastníka modulu. Pokud MyDscModule není platný modul manifestu, který určuje název, verzi, popis a autor, dojde k chybě.

Publish-Module -Name "MyDscModule" -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73"

Příklad 2: Publikování modulu s metadaty galerie

V tomto příkladu se MyDscModule publikuje do online galerie pomocí klíče rozhraní API k označení účtu galerie vlastníka modulu. Další poskytnutá metadata se zobrazí na webové stránce modulu v galerii. Vlastník přidá pro modul dvě vyhledávací značky, které s ním souvisí se službou Active Directory; Přidá se stručná zpráva k vydání verze. Pokud MyDscModule není platný modul manifestu, který určuje název, verzi, popis a autor, dojde k chybě.

$parameters = @{
    Name        = "MyDscModule"
    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

Parametry

-AllowPrerelease

Umožňuje publikování modulů označených jako předběžné verze.

Typ:	SwitchParameter
Position:	Named
Default value:	False
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Confirm

Před spuštěním příkazu Publish-Modulevás vyzve k potvrzení .

Typ:	SwitchParameter
Aliasy:	cf
Position:	Named
Default value:	False
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Credential

Určuje uživatelský účet, který má práva k publikování modulu pro zadaného poskytovatele balíčku nebo zdroje.

Typ:	PSCredential
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-Exclude

Definuje soubory, které se mají vyloučit z publikovaného modulu.

Typ:	String[]
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Force

Přinutí příkaz ke spuštění bez výzvy k potvrzení uživatele.

Typ:	SwitchParameter
Position:	Named
Default value:	False
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-FormatVersion

Přijímá pouze platné hodnoty určené atributem ValidateSet .

Další informace naleznete v tématu ValidateSet Attribute Deklarace a ValidateSetAttribute.

Typ:	Version
Přípustné hodnoty:	2.0
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-IconUri

Určuje adresu URL ikony modulu. Zadaná ikona se zobrazí na webové stránce galerie modulu.

Typ:	Uri
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-LicenseUri

Určuje adresu URL licenčních podmínek pro modul, který chcete publikovat.

Typ:	Uri
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Name

Určuje název modulu, který chcete publikovat. Publish-Module vyhledá zadaný název modulu v $Env:PSModulePathsouboru .

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-NuGetApiKey

Určuje klíč rozhraní API, který chcete použít k publikování modulu do online galerie. Klíč rozhraní API je součástí vašeho profilu v online galerii a najdete ho na stránce uživatelského účtu v galerii. Klíč rozhraní API je funkce specifická pro NuGet.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Path

Určuje cestu k modulu, který chcete publikovat. Tento parametr přijímá cestu ke složce, která obsahuje modul. Složka musí mít stejný název jako modul.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	True
Přijmout vstup kanálu:	True
Přijmout zástupné znaky:	False

-ProjectUri

Určuje adresu URL webové stránky o tomto projektu.

Typ:	Uri
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-ReleaseNotes

Určuje řetězec obsahující poznámky k verzi nebo komentáře, které chcete zpřístupnit uživatelům této verze modulu.

Typ:	String[]
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Repository

Určuje popisný název úložiště, které bylo zaregistrováno spuštěním Register-PSRepository. Úložiště musí mít publishLocation, což je platný identifikátor URI NuGetu. Funkci PublishLocation lze nastavit spuštěním Set-PSRepositorypříkazu .

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-RequiredVersion

Určuje přesnou verzi jednoho modulu, který se má publikovat.

Typ:	String
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-SkipAutomaticTags

Odebere příkazy a prostředky, které se zahrnou jako značky. Přeskočí automatické přidávání značek do modulu.

Typ:	SwitchParameter
Position:	Named
Default value:	False
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-Tags

Přidá jednu nebo více značek do modulu, který publikujete. Mezi příklady značek patří DesiredStateConfiguration, DSC, DSCResourceKit nebo PSModule. Oddělte více značek čárkami.

Typ:	String[]
Position:	Named
Default value:	None
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

-WhatIf

Ukazuje, co se stane, když se Publish-Module spustí. Příkazový modul nebyl spuštěn.

Typ:	SwitchParameter
Aliasy:	wi
Position:	Named
Default value:	False
Vyžadováno:	False
Přijmout vstup kanálu:	False
Přijmout zástupné znaky:	False

Vstupy

String

PSCredential

Výstupy

Object

Poznámky

PowerShell obsahuje následující aliasy pro Publish-Module:

Všechny platformy:
- pumo

Publish-Module běží v PowerShellu 3.0 nebo novějších verzích PowerShellu, ve Windows 7 nebo Windows 2008 R2 a novějších verzích Windows.

Důležité

Od dubna 2020 galerie Prostředí PowerShell už nepodporuje protokol TLS (Transport Layer Security) verze 1.0 a 1.1. Pokud nepoužíváte protokol TLS 1.2 nebo vyšší, při pokusu o přístup k galerii Prostředí PowerShell se zobrazí chyba. Pomocí následujícího příkazu se ujistěte, že používáte protokol TLS 1.2:

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

Další informace najdete v oznámení v blogu PowerShellu.

Publikování modulu vyžaduje metadata zobrazená na stránce galerie modulu. Požadovaná metadata zahrnují název modulu, verzi, popis a autora. Většina metadat pochází z manifestu modulu, ale některá metadata je možné zadat v Publish-Module parametrech, jako jsou Tag, ReleaseNote, IconUri, ProjectUri a LicenseUri. Další informace najdete v tématu Hodnoty manifestu balíčku, které mají vliv na uživatelské rozhraní galerie Prostředí PowerShell.

Sdílet prostřednictvím