Publish-Module

Module:

PowerShellGet Module

Hiermee publiceert u een opgegeven module van de lokale computer naar een onlinegalerie.

Syntax

ModuleNameParameterSet (Standaard)

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

Description

De Publish-Module-cmdlet publiceert een module naar een online NuGet-galerie met behulp van een API-sleutel die is opgeslagen als onderdeel van het profiel van een gebruiker in de galerie. U kunt de module opgeven die moet worden gepubliceerd op basis van de naam van de module of door het pad naar de map met de module.

Wanneer u een module op naam opgeeft, publiceert Publish-Module de eerste module die wordt gevonden door Get-Module -ListAvailable <Name>uit te voeren. Als u een minimale versie van een module opgeeft die moet worden gepubliceerd, Publish-Module de eerste module publiceert met een versie die groter is dan of gelijk is aan de minimale versie die u hebt opgegeven.

Voor het publiceren van een module zijn metagegevens vereist die worden weergegeven op de galeriepagina voor de module. Vereiste metagegevens bevatten de modulenaam, versie, beschrijving en auteur. Hoewel de meeste metagegevens worden opgehaald uit het modulemanifest, moeten sommige metagegevens worden opgegeven in Publish-Module parameters, zoals Tag, ReleaseNote, IconUri, ProjectUri en LicenseUri, omdat deze parameters overeenkomen met velden in een NuGet-galerie.

De parameters die moduleversienummers gebruiken, verwachten tekenreeksen die zijn opgemaakt als versienummers.

• Standaardversienummers hebben een notatie waarbij x.y.z x, y en z getallen zijn
• Prerelease-versies hebben een indeling waarin x.y.z-<prerelease_label> de <prerelease_label> willekeurige tekenreeks is toegewezen aan die release.

Voorbeelden

Voorbeeld 1: Een module publiceren

In dit voorbeeld wordt MyDscModule gepubliceerd naar de onlinegalerie met behulp van de API-sleutel om het onlinegalerieaccount van de module-eigenaar aan te geven. Als MyDscModule geen geldige manifestmodule is waarmee een naam, versie, beschrijving en auteur wordt opgegeven, treedt er een fout op.

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

Voorbeeld 2: Een module publiceren met metagegevens van de galerie

In dit voorbeeld wordt MyDscModule gepubliceerd naar de onlinegalerie met behulp van de API-sleutel om het galerieaccount van de moduleeigenaar aan te geven. De opgegeven aanvullende metagegevens worden weergegeven op de webpagina voor de module in de galerie. De eigenaar voegt twee zoektags toe voor de module, gerelateerd aan Active Directory; er wordt een korte releasenotitie toegevoegd. Als MyDscModule geen geldige manifestmodule is waarmee een naam, versie, beschrijving en auteur wordt opgegeven, treedt er een fout op.

$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

Parameters

-AllowPrerelease

Hiermee kunnen modules die als voorlopige versie zijn gemarkeerd, worden gepubliceerd.

Parametereigenschappen

Type:	SwitchParameter
Default value:	False
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

ModuleNameParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Confirm

Vraagt u om bevestiging voordat u de Publish-Moduleuitvoert.

Parametereigenschappen

Type:	SwitchParameter
Default value:	False
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	Cf

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Credential

Hiermee geeft u een gebruikersaccount op met rechten voor het publiceren van een module voor een opgegeven pakketprovider of bron.

Parametereigenschappen

Type:	PSCredential
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-Exclude

Hiermee definieert u bestanden die moeten worden uitgesloten van de gepubliceerde module.

Parametereigenschappen

Type:	String[]
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

ModuleNameParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Force

Hiermee dwingt u de opdracht uit te voeren zonder dat u om bevestiging van de gebruiker wordt gevraagd.

Parametereigenschappen

Type:	SwitchParameter
Default value:	False
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-FormatVersion

Accepteert alleen geldige waarden die zijn opgegeven door het kenmerk ValidateSet.

Zie ValidateSet Attribute Declaration en ValidateSetAttributevoor meer informatie.

Parametereigenschappen

Type:	Version
Default value:	None
Geaccepteerde waarden:	2.0
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-IconUri

Hiermee geeft u de URL van een pictogram voor de module. Het opgegeven pictogram wordt weergegeven op de webpagina van de galerie voor de module.

Parametereigenschappen

Type:	Uri
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-LicenseUri

Hiermee geeft u de URL van licentievoorwaarden voor de module die u wilt publiceren.

Parametereigenschappen

Type:	Uri
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Name

Hiermee geeft u de naam op van de module die u wilt publiceren. Publish-Module zoekt naar de opgegeven modulenaam in $Env:PSModulePath.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

ModuleNameParameterSet

Position:	Named
Verplicht:	True
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-NuGetApiKey

Hiermee geeft u de API-sleutel op die u wilt gebruiken om een module te publiceren naar de onlinegalerie. De API-sleutel maakt deel uit van uw profiel in de onlinegalerie en vindt u op de pagina van uw gebruikersaccount in de galerie. De API-sleutel is nuGet-specifieke functionaliteit.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Path

Hiermee geeft u het pad naar de module die u wilt publiceren. Deze parameter accepteert het pad naar de map die de module bevat. De map moet dezelfde naam hebben als de module.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

ModulePathParameterSet

Position:	Named
Verplicht:	True
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-ProjectUri

Hiermee geeft u de URL van een webpagina over dit project op.

Parametereigenschappen

Type:	Uri
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-ReleaseNotes

Hiermee geeft u een tekenreeks met releaseopmerkingen of opmerkingen op die beschikbaar moeten zijn voor gebruikers van deze versie van de module.

Parametereigenschappen

Type:	String[]
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Repository

Hiermee geeft u de beschrijvende naam van een opslagplaats die is geregistreerd door uit te voeren Register-PSRepository. De opslagplaats moet een PublishLocation-hebben. Dit is een geldige NuGet-URI. De PublishLocation- kan worden ingesteld door Set-PSRepositoryuit te voeren.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-RequiredVersion

Hiermee geeft u de exacte versie van één module die moet worden gepubliceerd.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

ModuleNameParameterSet

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-SkipAutomaticTags

Hiermee verwijdert u opdrachten en resources die als tags worden opgenomen. Hiermee wordt het automatisch toevoegen van tags aan een module overgeslagen.

Parametereigenschappen

Type:	SwitchParameter
Default value:	False
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Tags

Voegt een of meer tags toe aan de module die u publiceert. Voorbeelden van tags zijn DesiredStateConfiguration, DSC, DSCResourceKit of PSModule. Scheid meerdere tags met komma's.

Parametereigenschappen

Type:	String[]
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-WhatIf

Laat zien wat er gebeurt als de Publish-Module wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Parametereigenschappen

Type:	SwitchParameter
Default value:	False
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	Wi

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

String

PSCredential

Uitvoerwaarden

Object

Notities

PowerShell bevat de volgende aliassen voor Publish-Module:

• Alle platforms:
  • pumo

Publish-Module wordt uitgevoerd op PowerShell 3.0 of hoger van PowerShell, in Windows 7 of Windows 2008 R2 en latere versies van Windows.

Belangrijk

Vanaf april 2020 biedt de PowerShell Gallery geen ondersteuning meer voor TLS-versies (Transport Layer Security) 1.0 en 1.1. Als u TLS 1.2 of hoger niet gebruikt, krijgt u een foutmelding wanneer u toegang probeert te krijgen tot de PowerShell Gallery. Gebruik de volgende opdracht om ervoor te zorgen dat u TLS 1.2 gebruikt:

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

Zie de aankondiging in de PowerShell-blog voor meer informatie.

Voor het publiceren van een module zijn metagegevens vereist die worden weergegeven op de galeriepagina voor de module. Vereiste metagegevens bevatten de modulenaam, versie, beschrijving en auteur. De meeste metagegevens zijn afkomstig uit het modulemanifest, maar sommige metagegevens kunnen worden opgegeven in Publish-Module parameters, zoals Tag, ReleaseNote, IconUri, ProjectUrien LicenseUri. Zie Pakketmanifestwaarden die van invloed zijn op de gebruikersinterface van de PowerShell Gallery-voor meer informatie.

Verwante koppelingen

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