Freigeben über

Publish-Module

Modul:
PowerShellGet Module

Veröffentlicht ein angegebenes Modul vom lokalen Computer in einem Onlinekatalog.

Syntax

ModuleNameParameterSet (Standard) 

Publish-Module
    -Name <String>
    -NuGetApiKey <String>
    [-RequiredVersion <Version>]
    [-Repository <String>]
    [-FormatVersion <Version>]
    [-ReleaseNotes <String[]>]
    [-Tags <String[]>]
    [-LicenseUri <Uri>]
    [-IconUri <Uri>]
    [-ProjectUri <Uri>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ModulePathParameterSet 

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

Beschreibung

Das Publish-Module Cmdlet veröffentlicht ein Modul in einem Online-NuGet-basierten Katalog mithilfe eines API-Schlüssels, der als Teil des Profils eines Benutzers im Katalog gespeichert ist. Sie können das zu veröffentlichende Modul entweder nach dem Namen des Moduls oder durch den Pfad zu dem Ordner angeben, der das Modul enthält.

Wenn Sie ein Modul anhand des Namens angeben, Publish-Module veröffentlicht das erste Modul, das durch Ausführen Get-Module -ListAvailable <Name>gefunden wird. Wenn Sie eine Mindestversion eines zu veröffentlichenden Moduls angeben, Publish-Module veröffentlicht das erste Modul mit einer Version, die größer oder gleich der von Ihnen angegebenen Mindestversion ist.

Beispiele

Beispiel 1: Veröffentlichen eines Moduls

In diesem Beispiel wird MyDscModule mithilfe des API-Schlüssels im Onlinekatalog veröffentlicht, um das Onlinekatalogkonto des Modulbesitzers anzugeben. Wenn MyDscModule kein gültiges Manifestmodul ist, das einen Namen, eine Version, eine Beschreibung und einen Autor angibt, tritt ein Fehler auf.

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

Beispiel 2: Veröffentlichen eines Moduls mit Katalogmetadaten

In diesem Beispiel wird MyDscModule mithilfe des API-Schlüssels im Onlinekatalog veröffentlicht, um das Katalogkonto des Modulbesitzers anzugeben. Die bereitgestellten zusätzlichen Metadaten werden auf der Webseite für das Modul im Katalog angezeigt. Der Besitzer fügt zwei Suchtags für das Modul hinzu, die es mit Active Directory in Zusammenhang stehen; Eine kurze Veröffentlichungsnotiz wird hinzugefügt. Wenn MyDscModule kein gültiges Manifestmodul ist, das einen Namen, eine Version, eine Beschreibung und einen Autor angibt, tritt ein Fehler auf.

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."

Parameter

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie die Publish-Moduleausführen.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:vgl

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-FormatVersion

Akzeptiert nur gültige Werte, die vom ValidateSet-Attribut angegeben werden.

Weitere Informationen finden Sie unter ValidateSet-Attributdeklaration und ValidateSetAttribute.

Parametereigenschaften

Typ:Version
Standardwert:None
Zulässige Werte:2.0
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-IconUri

Gibt die URL eines Symbols für das Modul an. Das angegebene Symbol wird auf der Katalogwebseite für das Modul angezeigt.

Parametereigenschaften

Typ:Uri
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-LicenseUri

Gibt die URL der Lizenzierungsbedingungen für das Modul an, das Sie veröffentlichen möchten.

Parametereigenschaften

Typ:Uri
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Name

Gibt den Namen des Moduls an, das Sie veröffentlichen möchten. Publish-Module sucht nach dem angegebenen Modulnamen in $Env:PSModulePath.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

ModuleNameParameterSet
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-NuGetApiKey

Gibt den API-Schlüssel an, den Sie zum Veröffentlichen eines Moduls im Onlinekatalog verwenden möchten. Der API-Schlüssel ist Teil Ihres Profils im Onlinekatalog und finden Sie auf Ihrer Benutzerkontoseite im Katalog. Der API-Schlüssel ist NuGet-spezifische Funktionalität.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Path

Gibt den Pfad zu dem Modul an, das Sie veröffentlichen möchten. Dieser Parameter akzeptiert den Pfad zum Ordner, der das Modul enthält.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

ModulePathParameterSet
Position:Named
Obligatorisch:True
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:True
Wert aus verbleibenden Argumenten:False

-ProjectUri

Gibt die URL einer Webseite zu diesem Projekt an.

Parametereigenschaften

Typ:Uri
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ReleaseNotes

Gibt eine Zeichenfolge mit Versionshinweisen oder Kommentaren an, die Benutzern dieser Version des Moduls zur Verfügung stehen sollen.

Parametereigenschaften

Typ:

String[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Repository

Gibt den Anzeigenamen eines Repositorys an, das durch Ausführen Register-PSRepositoryregistriert wurde. Das Repository muss über eine PublishLocation verfügen, bei der es sich um einen gültigen NuGet-URI handelt. Die PublishLocation kann durch Ausführen Set-PSRepositoryfestgelegt werden.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-RequiredVersion

Gibt die genaue Version eines zu veröffentlichenden Moduls an.

Parametereigenschaften

Typ:Version
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

ModuleNameParameterSet
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Tags

Fügt dem Modul, das Sie veröffentlichen, mindestens ein Tags hinzu. Beispieltags sind DesiredStateConfiguration, DSC, DSCResourceKit oder PSModule. Trennen Sie mehrere Tags durch Kommas.

Parametereigenschaften

Typ:

String[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-WhatIf

Zeigt, was passieren würde, wenn Publish-Module läuft. Das Cmdlet wird nicht ausgeführt.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Wi

Parametersätze

(All)
Position:Named
Obligatorisch:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

PSModuleInfo

Ausgaben

None

Publish-Module Zeigt keine Ausgabe an, wenn ein Modul erfolgreich veröffentlicht wurde.

Hinweise

Publish-Module wird auf PowerShell 3.0- oder höher-Versionen von PowerShell, unter Windows 7 oder Windows 2008 R2 und höheren Versionen von Windows ausgeführt.

Zum Veröffentlichen eines Moduls sind Metadaten erforderlich, die auf der Katalogseite für das Modul angezeigt werden. Erforderliche Metadaten umfassen den Modulnamen, die Version, die Beschreibung und den Autor. Die meisten Metadaten stammen aus dem Modulmanifest, aber einige Metadaten können in Publish-Module Parametern angegeben werden, z. B. Tag, ReleaseNote, IconUri, ProjectUri und LicenseUri. Weitere Informationen finden Sie unter Paketmanifestwerte, die sich auf die Benutzeroberfläche des PowerShell-Katalogs auswirken.