Freigeben über

Publish-Module

  • Referenz
Modul:
PowerShellGet

Veröffentlicht ein angegebenes Modul aus dem lokalen Computer in einem Onlinekatalog

Syntax

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

Beschreibung

Das Publish-Module Cmdlet veröffentlicht ein Modul in einem NuGet-basierten Onlinekatalog mithilfe eines API-Schlüssels, der als Teil des Profils eines Benutzers im Katalog gespeichert ist. Sie können entweder den Namen des Moduls angeben, das veröffentlicht werden soll, oder Sie geben den Pfad zum Ordner an, der das Modul enthält.

Dies ist ein Proxy-Cmdlet für das Publish-PSResource Cmdlet in Microsoft.PowerShell.PSResourceGet. Weitere Informationen finden Sie unter Publish-PSResource.

Beispiele

Beispiel 1: Veröffentlichen eines Moduls

In diesem Beispiel wird MyDscModule im Onlinekatalog veröffentlicht, indem der API-Schlüssel verwendet wird, 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 -Path c:\projects\MyDscModule\1.0.0 -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73"

Beispiel 2: Veröffentlichen eines Moduls mit Katalogmetadaten

In diesem Beispiel wird MyDscModule im Onlinekatalog veröffentlicht, indem der API-Schlüssel verwendet wird, um das Katalogkonto des Modulbesitzers anzugeben. Die 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 und bezieht es auf Active Directory. Eine kurze Versionshinweise 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.

$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

Parameter

-AllowPrerelease

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie ausführen.Publish-Module

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Credential

Gibt ein Benutzerkonto an, das über Berechtigungen zum Veröffentlichen eines Moduls für einen angegebenen Paketanbieter oder eine angegebene Quelle verfügt.

Type:PSCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Exclude

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FormatVersion

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:Version
Accepted values:2.0
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IconUri

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LicenseUri

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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 im Katalog auf ihrer Benutzerkontoseite. Der API-Schlüssel ist NuGet-spezifische Funktionalität.

Das Proxy-Cmdlet ordnet diesen Parameter dem ApiKey-Parameter von Publish-PSResourcezu.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Gibt den Pfad zu dem Modul an, das Sie veröffentlichen möchten. Dieser Parameter akzeptiert den Pfad zu dem Ordner, der das Modul enthält. Der Ordner muss den gleichen Namen wie das Modul haben.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ProjectUri

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:Uri
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReleaseNotes

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Repository

Gibt den Anzeigenamen eines Repositorys an, das durch Ausführen Register-PSRepositoryvon registriert wurde. Das Repository muss über einen PublishLocation-Standort verfügen, bei dem es sich um einen gültigen NuGet-URI handelt. Der PublishLocation-Standort kann durch Ausführen Set-PSRepositoryvon festgelegt werden.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredVersion

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkipAutomaticTags

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tags

Das Proxy-Cmdlet ignoriert diesen Parameter, da er von nicht unterstützt wird Publish-PSResource.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Zeigt an, was passieren würde, wenn die Publish-Module ausgeführt wird. Das Cmdlet wird nicht ausgeführt.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Eingaben

String

PSCredential

Ausgaben

Object

Hinweise

PowerShell enthält die folgenden Aliase für Publish-Module:

  • Alle Plattformen:
    • pumo

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

Die PowerShell-Katalog die TLS-Versionen 1.0 und 1.1 (Transport Layer Security) nicht mehr unterstützt. Sie müssen TLS 1.2 oder höher verwenden. Mit dem folgenden Befehl können Sie sicherstellen, dass Sie TLS 1.2 verwenden:

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

Die Veröffentlichung eines Moduls erfordert Metadaten, die auf der Seite „Katalog“ des Moduls angezeigt werden. Die erforderlichen Metadaten enthalten den Modulnamen, die Version, die Beschreibung und den Autor. Die Metadaten müssen im Modulmanifest definiert werden. Weitere Informationen finden Sie unter Paketmanifestwerte, die sich auf die benutzeroberfläche PowerShell-Katalog auswirken.