Delen via

Publish-Module

  • Referentie
Module:
PowerShellGet

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

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

Description

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

Dit is een proxy-cmdlet voor de Publish-PSResource cmdlet in Microsoft.PowerShell.PSResourceGet. Zie Publish-PSResource voor meer informatie.

Voorbeelden

Voorbeeld 1: Een module publiceren

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

Publish-Module -Path c:\projects\MyDscModule\1.0.0 -NuGetApiKey "11e4b435-6cb4-4bf7-8611-5162ed75eb73"

Voorbeeld 2: Een module publiceren met galeriemetagegevens

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

$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

Parameters

-AllowPrerelease

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

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

-Confirm

U wordt om bevestiging gevraagd voordat u de Publish-Moduleuitvoert.

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

-Credential

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

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

-Exclude

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

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

-Force

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

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

-FormatVersion

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

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

-IconUri

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

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

-LicenseUri

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

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

-Name

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters: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 een nuget-specifieke functionaliteit.

De proxy-cmdlet wijst deze parameter toe aan de ApiKey-parameter van Publish-PSResource.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-ProjectUri

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

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

-ReleaseNotes

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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 uit te voeren Set-PSRepository.

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

-RequiredVersion

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

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

-SkipAutomaticTags

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

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

-Tags

De proxy-cmdlet negeert deze parameter omdat deze niet wordt ondersteund door Publish-PSResource.

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

-WhatIf

Laat zien wat er zou gebeuren als de Publish-Module uitvoeringen worden uitgevoerd. De cmdlet wordt niet uitgevoerd.

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

Invoerwaarden

String

PSCredential

Uitvoerwaarden

Object

Notities

PowerShell bevat de volgende aliassen voor Publish-Module:

  • Alle platformen:
    • pumo

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

De PowerShell Gallery biedt geen ondersteuning meer voor TLS-versies (Transport Layer Security) 1.0 en 1.1. U moet TLS 1.2 of hoger gebruiken. Gebruik de volgende opdracht om ervoor te zorgen dat u TLS 1.2 gebruikt:

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

Voor het publiceren van een module zijn metagegevens vereist die worden weergegeven op de galeriepagina voor de module. Vereiste metagegevens omvatten de modulenaam, versie, beschrijving en auteur. De metagegevens moeten worden gedefinieerd in het modulemanifest. Zie Manifestwaarden voor pakketten die van invloed zijn op de gebruikersinterface van PowerShell Gallery voor meer informatie.